Language Pairs

List language pairs

Example Request:

curl "https://controller-host:8001/api/v2/language-pairs?chains=also&domain=Generic&platform=SRV&sourceLanguageId=eng&targetLanguageId=fra&technology=TNMV" \
	-X GET \
	-u u_jsmith@example.com_u0VmztKJrwqf:

Example Response:

{
    "languagePairs": [
        {
            "languagePairId": "EngFra_Generic_SRV_TNMV_8_4_x_1",
            "sourceLanguage": "English",
            "sourceLanguageId": "eng",
            "targetLanguage": "French",
            "targetLanguageId": "fra",
            "domain": "Generic",
            "model": "Generic",
            "platform": "SRV",
            "technology": "TNMV",
            "version": "8.4.1",
            "linguisticOptions": [
                {
                    "id": "Formality",
                    "values": [
                        "Informal",
                        "Formal",
                        "Polite"
                    ],
                    "systemDefault": "Informal"
                }
            ]
        },
        {
            "languagePairId": "SpaEng_Generic_SRV_TNMV_8_4_x_2",
            "sourceLanguage": "Spanish",
            "sourceLanguageId": "spa",
            "targetLanguage": "English",
            "targetLanguageId": "eng",
            "domain": "Generic",
            "model": "Generic",
            "platform": "SRV",
            "technology": "TNMV",
            "version": "8.4.2"
        },
        {
            "languagePairId": "SpaEng_Generic_SRV_TNMV_8_4_x_2\u003e\u003eEngFra_Generic_SRV_TNMV_8_4_x_1",
            "sourceLanguage": "Spanish",
            "sourceLanguageId": "spa",
            "targetLanguage": "French",
            "targetLanguageId": "fra",
            "domain": "Generic",
            "model": "Generic",
            "platform": "SRV",
            "technology": "TNMV",
            "version": "",
            "memberPairs": [
                {
                    "languagePairId": "SpaEng_Generic_SRV_TNMV_8_4_x_2",
                    "sourceLanguage": "Spanish",
                    "sourceLanguageId": "spa",
                    "targetLanguage": "English",
                    "targetLanguageId": "eng",
                    "domain": "Generic",
                    "model": "Generic",
                    "platform": "SRV",
                    "technology": "TNMV",
                    "version": "8.4.2"
                },
                {
                    "languagePairId": "EngFra_Generic_SRV_TNMV_8_4_x_1",
                    "sourceLanguage": "English",
                    "sourceLanguageId": "eng",
                    "targetLanguage": "French",
                    "targetLanguageId": "fra",
                    "domain": "Generic",
                    "model": "Generic",
                    "platform": "SRV",
                    "technology": "TNMV",
                    "version": "8.4.1"
                }
            ],
            "isChain": true
        }
    ]
}

Return the list of language pairs that are currently installed, licensed, or available for translation.

HTTP Request

GET /api/v2/language-pairs

Request Parameters

These parameters should be added to the URL as a query string.

Name	Type	Description	Default Value
mode (optional)	string	Query mode, which subset of language pairs to list. Possible choices: translation - language pairs available for translation, installed - installed language pairs, licensed - licensed language pairs, installedAndLicensed - installed and licensed language pairs, adaptable - adaptable language pairs	translation
chains (optional)	string	Include chains, non-chains or all. Valid values: only for just chains, also for single language pairs and chains, or excluded for just single language pairs	also
sourceLanguageId (optional)	string	Filter results to only show those with this source language ID
targetLanguageId (optional)	string	Filter results to only show those with this target language ID
domain (optional)	string	Filter results to only show those with this domain
platform (optional)	string	Filter results to only show those with this platform
technology (optional)	string	Filter results to only show those with this technology

Returns

Returns all language pairs as a LanguagePairList object with the following attributes:

Name	Type	Description
languagePairs	array of objects	List of language pairs as an array of LanguagePair objects (expanded below)
→ languagePairId	string	Identifier of language pair
→ sourceLanguage	string	Full name of source language
→ sourceLanguageId	string	3-letter code of source language
→ targetLanguage	string	Full name of target language
→ targetLanguageId	string	3-letter code of target language
→ domain	string	Domain of language pair
→ model	model	Model of language pair
→ platform	string	Platform on which language pair runs
→ technology	string	Technology type of language pair
→ version	string	Version of the language pair
→ isEdgeCloud	boolean	Whether the language pair is on Edge Cloud. Non-edge-cloud LPs do not have this.
→ adaptable	boolean	Whether the language pair is adaptable. Non-adaptable LPs do not have this.
→ memberPairs	array of objects	List of single language pairs, represented as LanguagePair objects that comprise the language pair chain. Non-chain LPs do not have this.
→ isChain	boolean	Whether the language pair is a chain. Always true if present. Non-chain LPs do not have this.
→ autoAdaptationEnabled	boolean	Whether the language pair is enabled to auto adapt periodically using supplied data.
→ linguisticOptions	array of objects	List of available linguistic options as an array.

Automatically managed chains only exist as long as all of their member language pairs are running in active translation engines, so setting the mode has no effect on which automanaged chains are listed. Effectively it is as if mode were always translation for automanaged chains. However, manually added chains behave like single language pairs with respect to mode.

Language pair chains are never adaptable, however it is possible to use adapted single language pairs as members of a language pair chain.