Skip to content

Latest commit

 

History

History
134 lines (107 loc) · 4.34 KB

reference.md

File metadata and controls

134 lines (107 loc) · 4.34 KB

Reference

Command Line Interface

The CLI takes the following options:

-v, --version      Shows the current version
    --no-kaf       Disables KAF output
-h, --help         Display this help message.

Examples:

Basic Usage
cat example_text.txt | language-identifier    # Basic detection
KAF is the default output
echo "This is english text." | language-identifier    # Defaults to KAF output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<KAF xml:lang="en" version="2.1">
    <raw>This is english text.</raw>
</KAF>

Webservice

You can launch a webservice by executing:

language-identifier-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

This component comes with a daemon that can be started using the command language-identifier-daemon. By default this will start the daemon in the foreground, by using language-identifier-daemon start it can be started in the background instead.

For more information, run language-identifier-daemon --help.

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]

Daemon Options

-h, --help                Shows this help message
-i, --input               The name of the input queue (default: opener-language-identifier)
-b, --bucket              The S3 bucket to store output in (default: opener-language-identifier)
-P, --pidfile             Path to the PID file (default: /var/run/opener/opener-language-identifier-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)

Languages

Code Language
ar Arabic
bg Bulgarian
bn Bengali
cs Czech
da Danish
de German
el Greek
en English
es Spanish
et Estonian
fa Persian
fi Finnish
fr French
gu Gujarati
he Hebrew
hi Hindi
hr Croatian
hu Hungarian
id Indonesian
it Italian
ja Japanese
kn Kannada
ko Korean
lt Lithuanian
lv Latvian
mk Macedonian
ml Malayalam
mr Marathi
ne Nepali
nl Dutch
no Norwegian
pa Punjabi
pl Polish
pt Portuguese
ro Romanian
ru Russian
sk Slovak
sl Slovene
so Somali
sq Albanian
sv Swedish
sw Swahili
ta Tamil
te Telugu
th Thai
tl Tagalog
tr Turkish
uk Ukrainian
ur Urdu
vi Vietnamese
zh-cn Simplified Chinese
zh-tw Traditional Chinese