Skip to content

reference.md

Latest commit

 

History

History
89 lines (65 loc) · 2.78 KB

reference.md

File metadata and controls

89 lines (65 loc) · 2.78 KB

Reference

Command Line Interface

To tag an input KAF file example.kaf with opinions you can run:

cat example.with.polarities.kaf | core/opinion_detector_basic_multi.py > output.with.opinions.kaf

The output will the input KAF file extended with the opinion layer.

Excerpt of example output.

<opinions>
  <opinion oid="o1">
    <opinion_target>
      <!--hotel-->
      <span>
        <target id="t_6"/>
      </span>
    </opinion_target>
    <opinion_expression polarity="positive" strength="2">
      <!--heel mooi-->
      <span>
        <target id="t_4"/>
        <target id="t_5"/>
      </span>
    </opinion_expression>
  </opinion>
</opinions>

Webservice

You can launch a webservice by executing:

opinion-detector-basic-server

After launching the server, you can reach the webservice at http://localhost:9292.

The webservice takes several options that get passed along to Puma, the webserver used by the component. The options are:

-h, --help                Shows this help message
    --puma-help           Shows the options of Puma
-b, --bucket              The S3 bucket to store output in
    --authentication      An authentication endpoint to use
    --secret              Parameter name for the authentication secret
    --token               Parameter name for the authentication token
    --disable-syslog      Disables Syslog logging (enabled by default)

Daemon

The daemon has the default OpeNER daemon options. Being:

-h, --help                Shows this help message
-i, --input               The name of the input queue (default: opener-opinion-detector-basic)
-b, --bucket              The S3 bucket to store output in (default: opener-opinion-detector-basic)
-P, --pidfile             Path to the PID file (default: /var/run/opener/opener-opinion-detector-basic-daemon.pid)
-t, --threads             The amount of threads to use (default: 10)
-w, --wait                The amount of seconds to wait for the daemon to start (default: 3)
    --disable-syslog      Disables Syslog logging (enabled by default)

When calling ner without "start", "stop" or "restart" the daemon will start as a foreground process.

Environment Variables

These daemons make use of Amazon SQS queues and other Amazon services. For these services to work correctly you'll need to have various environment variables set. These are as following:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_REGION

For example:

AWS_REGION='eu-west-1' language-identifier start [other options]

Languages

This opinion detector component supports the following languages:

  • Dutch (nl)
  • English (en)
  • French (fr)
  • German (de)
  • Italian (it)
  • Spanish (es)