Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
220 lines (171 sloc) 5.97 KB

ai.text.transliterate

Converts a text from one script to another script (e.g. katakana to latin)

Basic usage

To transliterate a text, send a POST request to Intento API at https://api.inten.to/ai/text/transliterate. Specify the source text, source languages 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/transliterate' -d '{
    "context": {
        "text": "こんにちは",
        "language": "ja",
        "fromscript": "jpan",
        "toscript": "latn"
    },
    "service": {
        "provider": "ai.text.transliterate.microsoft.translator_text_api.3-0"
    }
}'

The response contains the transliterate results grouped by part of speech and a service information. Parts of speech are formatted in snake_case style:

{
    "results": "konnnichiha",
    "meta": {},
    "service": {
        "provider": {
            "id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
            "name": "Microsoft Translator API v3.0"
        }
    }
}

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.transliterate.microsoft.translator_text_api.3-0 constraint(s) violated: fromscript (Specifies the script used by the input text.), language (Specifies the language of the text to convert from one script to another.), toscript (Specifies the output script.)"
  },
  "request_id": "..."
}

Getting available providers

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

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

The response contains a list of the providers available for given constraints with an information on pricing etc:

[
    {
        "id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
        "name": "Microsoft Translator API v3.0",
        "vendor": "Microsoft",
        "score": 0,
        "price": 0
    }
]

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/transliterate?fromscript=arab'

Response:

[
    {
        "id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
        "name": "Microsoft Translator API v3.0",
        "vendor": "Microsoft",
        "score": 0,
        "price": 0
    }
]

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/transliterate/PROVIDER_ID.

curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate/ai.text.transliterate.microsoft.translator_text_api.3-0'

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

{
    "id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
    "vendor": "Microsoft",
    "logo": "https://inten.to/static/img/api/mcs_translate.png",
    "bulk": true,
    "description": "Translator API v3.0",
    "integrated": true,
    "billable": true,
    "languages": {
        "language": [ ... ],
        "fromscript": [ ... ],
        "toscript": [ ... ]
    }
}

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/transliterate/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/transliterate/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"
}