Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
223 lines (174 sloc) 5.68 KB

ai.text.classify

Text content classification.

Basic usage

To classify a text, send a POST request to Intento API at https://api.inten.to/ai/text/classify. Specify the source text, the source language and the desired provider in JSON body of the request as in the following example:

curl -XPOST -H 'apikey: YOUR_API_KEY' 'https://api.inten.to/ai/text/classify' -d '{
    "context": {
        "text": "...",
        "lang": "en"
    },
    "service": {
        "provider": "ai.text.classify.ibm.natural_language_understanding"
    }
}'

The response contains the classify results:

{
    "results": "...",
    "meta": {},
    "service": {
        "provider": {
            "id": "ai.text.classify.ibm.natural_language_understanding"
        }
    }
}

If the provider doesn't have capabilities (e.g. language) to process request, 413 error will be returned:

{
  "error": {
    "code": 413,
    "message": "Provider ai.text.classify.ibm.natural_language_understanding constraint(s) violated."
  },
  "request_id": "..."
}

Getting available providers

To get a list of available providers, send a GET request to https://api.inten.to/ai/text/classify.

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/classify'

The response contains a list of the providers available for given constraints:

[
    {
        "id": "ai.text.classify.twinword.text_classification",
        "name": "Twinword Text Classification",
        "vendor": "Twinword",
        "description": "Text Classification",
        "own_auth": true,
        "stock_model": true,
        "custom_model": false
    }
]

Filtering providers by capabilities

The list of providers may be further constrained by adding desired parameter values to the GET request:

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/classify?lang=ko'

Response:

[
    {
        "id": "ai.text.classify.ibm.natural_language_understanding",
        "name": "IBM Watson Natural Language Understanding categories",
        "description": "Natural Language Understanding categories",
        "integrated": false,
        "own_auth": true,
        "stock_model": false,
        "custom_model": false,
        "lang": ["en", "ar", "fr", "de", "it", "ko", "pt", "es", "ja"]
    },
    ...
]

Getting information about a provider

To get information about a provider with a given ID, send a GET request to https://api.inten.to/ai/text/classify/PROVIDER_ID.

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/classify/ai.text.classify.tencent.text_classification_api'

The response contains a list of the metadata fields and values available for the provider:

{
    "id": "ai.text.classify.tencent.text_classification_api",
    "vendor": "Tencent",
    "logo": "https://inten.to/static/img/api/tmt_translate.png",
    "billing": true,
    "description": "Text Classification API",
    "production": false,
    "integrated": false,
    "billable": true,
    "own_auth": true,
    "stock_model": true,
    "custom_model": false,
    "languages": { ... }
}

Supported languages

Getting list of supported languages

Will return an array of supported languages, for each language:

  • iso name
  • localized name (if locale parameter is provided); if there is no localized name, null is returned
  • intento code
  • client code (if the client calling the method has its own codes)
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/classify/languages?locale=ru'

Response:

[
    {
        "iso_name": "Hebrew (modern)",
        "name": "иврит",
        "intento_code": "he"
    }
]

Getting full information on the supported language

For a given language code (intento internal or client’s) will show full metadata:

  • iso name
  • localized name (if locale parameter is provided); if there is no localized name, null is returned
  • intento code
  • iso codes (ones which are applicable)
  • providers’ codes (which map to this internal code)
  • client code (if the client calling the method has its own codes)
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/classify/languages/he?locale=ru'

Response:

{
    "iso_name": "Hebrew (modern)",
    "name": "иврит",
    "intento_code": "he",
    "iso_639_1_code": "he",
    "iso_639_2t_code": "heb",
    "iso_639_2b_code": "heb",
    "iso_639_3_code": "heb",
    "provider_codes": {}
}

Setting your own language codes

To define your aliases to language codes, send a POST request to Intento API at https://api.inten.to/settings/languages. After 60 seconds, you can start using them.

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/settings/languages' --data '{"aliasforen":"en"}'

Response:

{
    "aliasforen": "en"
}

Settings can be retrieved using the GET request

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/settings/languages'

Response:

{
    "aliasforen": "en"
}