# Scorer

Component that stores results from the Opener Web Services chain into a MySQL
Database and shows them into your browser.

It can be used instead of Opener Outlet, to calculate overall sentiment score
and sentiment score per topic.

## Confused by some terminology?

This software is part of a larger collection of natural language processing
tools known as "the OpeNER project". You can find more information about the
project at [the OpeNER portal](http://opener-project.github.io). There you can
also find references to terms like KAF (an XML standard to represent linguistic
annotations in texts), component, cores, scenario's and pipelines.

## Quick Use Example

Installing the scorer can be done by executing:

    gem install opener-scorer

Please keep in mind that all components in OpeNER take KAF as an input and
output KAF by default.

### Command line interface

You should now be able to call the scorer as a regular shell command: by its
name. Once installed the gem normally sits in your path so you can call it
directly from anywhere.

This aplication reads a text from standard input in order to rate the given
text:

    cat some_kind_of_kaf_file.kaf | scorer

This will output (JSON Format):

    {"overall":-0.06666666666666667,"Restaurant":0.3333333333333333,"Staff":-1.0,"Rooms":1.0,"Facilities":-1.0}

### Webservices

You can launch a webservice by executing:

    scorer-server

This will launch a mini webserver with the webservice. It defaults to port 9292,
so you can access it at <http://localhost:9292>.

To launch it on a different port provide the `-p [port-number]` option like
this:

    scorer-server -p 1234

It then launches at <http://localhost:1234>

Documentation on the Webservice is provided by surfing to the urls provided
above. For more information on how to launch a webservice run the command with
the `--help` option.

### Daemon

Last but not least the scorer comes shipped with a daemon that can read jobs
(and write) jobs to and from Amazon SQS queues. For more information type:

    scorer-daemon -h

## Description of dependencies

This component runs best if you run it in an environment suited for OpeNER
components. You can find an installation guide and helper tools in the
[OpeNER installer](https://github.com/opener-project/opener-installer) and an
[installation guide on the Opener Website](http://opener-project.github.io/getting-started/how-to/local-installation.html)

At least you need the following system setup:

### Depenencies for normal use:

* JRuby 1.7.9 or newer

## Where to go from here

* [Check the project website](http://opener-project.github.io)
* [Checkout the webservice](http://opener.olery.com/scorer)

## Report problem/Get help

If you encounter problems, please email support@opener-project.eu or leave an issue in the
[issue tracker](https://github.com/opener-project/scorer/issues).

## Contributing

1. Fork it <http://github.com/opener-project/scorer/fork>
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request