https://github.com/abhay/calais

A Ruby interface to the Open Calais API (http://opencalais.com)
https://github.com/abhay/calais

Last synced: 4 days ago
JSON representation

A Ruby interface to the Open Calais API (http://opencalais.com)

• Host: GitHub
• URL: https://github.com/abhay/calais
• Owner: abhay
• License: mit
• Created: 2008-01-29T04:10:12.000Z (almost 17 years ago)
• Default Branch: master
• Last Pushed: 2020-06-30T16:44:55.000Z (over 4 years ago)
• Last Synced: 2024-05-12T06:02:55.438Z (6 months ago)
• Language: Ruby
• Homepage: http://calais.rubyforge.org/
• Size: 341 KB
• Stars: 137
• Watchers: 7
• Forks: 54
• Open Issues: 6
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG.markdown
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# Calais #

A Ruby interface to the [Open Calais Web Service](http://opencalais.com)

## Features ##

* Accepts documents in text/plain, text/xml and text/html format.

* Basic access to the Open Calais API's Enlighten action.

    * Output is RDF representation of input document.

* Single function ability to extract names, entities and geographies from given text.

  

## Synopsis ##

This is a very basic wrapper to the Open Calais API. It uses the POST endpoint and currently supports the Enlighten action. Here's a simple call:

    Calais.enlighten(

        :content => "The government of the United Kingdom has given corporations like fast food chain McDonald's the right to award high school qualifications to employees who complete a company training program.",

        :content_type => :raw,

        :license_id => 'your license id'

    )

This is the easiest way to get the RDF-formated response from the OpenCalais service.

If you want to do something more fun like getting all sorts of fun information about a document, you can try this:

    Calais.process_document(

        :content => "The government of the United Kingdom has given corporations like fast food chain McDonald's the right to award high school qualifications to employees who complete a company training program.",

        :content_type => :raw,

        :license_id => 'your license id'

    )

This will return an object containing information extracted from the RDF response.

## Requirements ##

* [Ruby 1.8.5 or better](http://ruby-lang.org)

* [nokogiri](http://nokogiri.rubyforge.org/nokogiri/), [libxml2](http://xmlsoft.org/), [libxslt](http://xmlsoft.org/xslt/)

* [curb](http://curb.rubyforge.org/), [libcurl](http://curl.haxx.se/)

* [json](http://json.rubyforge.org/)

## Install ##

You can install the Calais gem via Rubygems (`gem install calais`) or by building from source.

## Authors ##

* [Abhay Kumar](http://opensynapse.net) 

## Acknowledgements ##

* [Paul Legato](http://www.economaton.com/): Help all around with the new response processor and implementation of the 3.1 API.

* [Ryan Ong](http://www.ryanong.net/)

* [Juan Antonio Chavez](https://github.com/TheNaoX): Geographies relevance