AlchemyAPI

This is a Ruby Client Library that provides access to the Alchemy text mining API. The current version targets the following API's:

Not yet implemented API's:

Installation

Add this line to your application's Gemfile:

gem 'alchemy-api-rb', :require => 'alchemy_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install alchemy-api-rb

Set your API Key in an initializer or something similar:

AlchemyAPI.key = "xxxxxxxxxxxxxxxxxx"

You may set the key along with other config settings:

AlchemyAPI.configure do |config|
  config.key = "xxxxxxxxxxxxxxxxxx"
  config.output_mode = :xml # not yet supported
end

Request keyword extraction for a string of text:

results = AlchemyAPI.search(:keyword_extraction, :text => "hello world")

results = AlchemyAPI::KeywordExtraction.new.search(:url => "http://www.alchemyapi.com/")

results = AlchemyAPI::KeywordExtraction.new.search(:html => "<html><body>lorem ipsum</body></html>")

Results for keyword extraction are returned as a array of keywords:

[
  {
         "text" => "lorem ipsum",
    "relevance" => "0.993164"
  }
]

The spec_helper is looking for your API Key in the project root in a file named .keys. Put just your key in there and then you can run:

rake test