Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.13 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.13 KB

The Meaning Cloud Ruby API Wrapper

A Ruby API wrapper for Meaning Cloud API's

Gem VersionDependency Status Build Status Code Climate Test Coverage

gem "meaning-cloud", "~> 1.0.0"

Missing

Current version only wraps the Topics extraction API's and is focused on specific usage. Feel free to send a pull request with more API's wrapped!

Usage

You need a valid key to use the Gem, you can get it by signing up here

Raises Exception on missing key

Configuration

You can use an initializer for example if you're on Rails.

# initializers/meaning_cloud.rb
MeaningCloud.configure do |config|
  config.key = ENV['MEANING_CLOUD_KEY']
  # optional - these are the defaults
  config.language = :en
  config.topic_types = 'ec'
end

Extract by text

result = MeaningCloud::Topics.extract_topics(txt: 'The most amazing text in the world') # Returns a hash of the parsed JSON result.

Source source

Disclaimer

This is completely unofficial and is not related to Meaning Cloud in any way.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About Tailor Brands

Check us out!