https://github.com/telus-agcg-archive/alchemy-api-rb

Provides access to the Alchemy text mining API - http://www.alchemyapi.com/
https://github.com/telus-agcg-archive/alchemy-api-rb

Last synced: about 2 months ago
JSON representation

Provides access to the Alchemy text mining API - http://www.alchemyapi.com/

• Host: GitHub
• URL: https://github.com/telus-agcg-archive/alchemy-api-rb
• Owner: telus-agcg-archive
• License: mit
• Archived: true
• Created: 2012-06-03T17:38:44.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-05-18T10:21:49.000Z (over 4 years ago)
• Last Synced: 2024-04-13T23:02:52.713Z (5 months ago)
• Language: Ruby
• Size: 125 KB
• Stars: 56
• Watchers: 35
• Forks: 35
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AlchemyAPI

[![Build Status](https://secure.travis-ci.org/technekes/alchemy-api-rb.png?branch=master)](http://travis-ci.org/technekes/alchemy-api-rb)

[![Code Climate](https://codeclimate.com/github/technekes/alchemy-api-rb.png)](https://codeclimate.com/github/technekes/alchemy-api-rb)

[![Coverage Status](https://img.shields.io/coveralls/technekes/alchemy-api-rb.svg)](https://coveralls.io/r/technekes/alchemy-api-rb)

[![Dependency Status](https://gemnasium.com/badges/github.com/technekes/alchemy-api-rb.svg)](https://gemnasium.com/github.com/technekes/alchemy-api-rb)

[![Gem Version](https://badge.fury.io/rb/alchemy-api-rb.png)](http://badge.fury.io/rb/alchemy-api-rb)

This is a Ruby Client Library that provides access to the [Alchemy text mining API](http://www.alchemyapi.com/). The current version targets the following API's:

* Author Extraction

* Combined Call

* Concept Tagging

* Emotion Analysis

* Entity Extraction

* Face Detection/Recognition

* Image Scene Text Extraction

* Image Tagging

* Keyword Extraction

* Language Detection

* Relation Extraction

* Sentiment Analysis

* Targeted Sentiment Analysis

* Taxonomy

* Text Categorization

* Text Extraction

* Title Extraction

Not yet implemented API's:

* Content Scraping

* Microformats

* RSS / ATOM

## Installation

Add this line to your application's Gemfile:

```ruby

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

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install alchemy-api-rb

## Usage

You'll need to [request an API Key](http://www.alchemyapi.com/api/register.html).

Set your API Key in an initializer or something similar:

```ruby

AlchemyAPI.key = "xxxxxxxxxxxxxxxxxx"

```

You may set the key along with other config settings:

```ruby

AlchemyAPI.configure do |config|

  config.apikey = "xxxxxxxxxxxxxxxxxx"

  config.output_mode = :xml # not yet supported

end

```

Request keyword extraction for a string of text:

```ruby

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

```

or

```ruby

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

```

or

```ruby

results = AlchemyAPI::KeywordExtraction.new.search(html: "lorem ipsum")

```

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

```ruby

[

  {

         "text" => 'lorem ipsum',

    "relevance" => "0.993164"

  }

]

```

## Testing

The specs are expecting your API Key as an environment variable named `ALCHEMY_API_KEY`. You can export it locally or prepend the test command like so:

    ALCHEMY_API_KEY="this-is-my-40-character-key" bundle exec rake test

If you would like to expirement with the API you can run the `console` rake task and use the commands above to set the API Key issue search commands:

    bundle exec rake console

## TODO

1. Add missing Alchmey API search modes

1. Add support for raw output (JSON, XML and RDF)?

## Contributing

alchemy-api-rb is work of several contributors. You're encouraged to submit pull requests, propose features and discuss issues.

See [CONTRIBUTING](CONTRIBUTING.md).

## License

MIT License. See LICENSE for details.