Translator 3.0: Languages

Article
07/22/2024

Gets the set of languages currently supported by other operations of the Translator.

Request URL

Send a GET request to:

https://api.translator.azure.cn/languages?api-version=3.0

For virtual networks, use your custom domain endpoint:

https://<your-custom-domain>.cognitiveservices.azure.cn/languages?api-version=3.0

For more information, see Virtual Network Support for Translator service selected network and private endpoint configuration and support.

Request parameters

Request parameters passed on the query string are:

Query parameters	Description
api-version	Required parameter The version of the API requested by the client. Value must be `3.0`.
scope	Optional parameter. A comma-separated list of names defining the group of languages to return. Allowed group names are: `translation`, `transliteration`, and `dictionary`. If no scope is given, then all groups are returned, which is equivalent to passing `scope=translation,transliteration,dictionary`.

See response body.

Request headers are:

Headers Description

Accept-Language Optional request header.

The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this parameter to define the language in which these names are returned. The language is specified by providing a well-formed BCP 47 language tag. For instance, use the value fr to request names in French or use the value zh-Hant to request names in Chinese Traditional.
Names are provided in the English language when a target language isn't specified or when localization isn't available.

X-ClientTraceId Optional request header.
A client-generated GUID to uniquely identify the request.

Headers	Description
Accept-Language	Optional request header. The language to use for user interface strings. Some of the fields in the response are names of languages or names of regions. Use this parameter to define the language in which these names are returned. The language is specified by providing a well-formed `BCP` 47 language tag. For instance, use the value `fr` to request names in French or use the value `zh-Hant` to request names in Chinese Traditional. Names are provided in the English language when a target language isn't specified or when localization isn't available.
X-ClientTraceId	Optional request header. A client-generated GUID to uniquely identify the request.

Authentication isn't required to get language resources.

Response body

A client uses the scope query parameter to define which groups of languages to list.

scope=translation provides languages supported to translate text from one language to another language;
scope=transliteration provides capabilities for converting text in one language from one script to another script;
scope=dictionary provides language pairs for which Dictionary operations return data.

A client may retrieve several groups simultaneously by specifying a comma-separated list of names. For example, scope=translation,transliteration,dictionary would return supported languages for all groups.

A successful response is a JSON object with one property for each requested group:

{
    "translation": {
        //... set of languages supported to translate text (scope=translation)
    },
    "transliteration": {
        //... set of languages supported to convert between scripts (scope=transliteration)
    },
    "dictionary": {
        //... set of languages supported for alternative translations and examples (scope=dictionary)
    }
}

The value for each property is as follows.

translation property

The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be translated to or translated from. The value associated with the key is a JSON object with properties that describe the language:
- name: Display name of the language in the locale requested via Accept-Language header.
- nativeName: Display name of the language in the locale native for this language.
- dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages.
An example is:
```
{
  "translation": {
    ...
    "fr": {
      "name": "French",
      "nativeName": "Français",
      "dir": "ltr"
    },
    ...
  }
}
```
transliteration property

The value of the transliteration property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script to another script. The value associated with the key is a JSON object with properties that describe the language and its supported scripts:
- name: Display name of the language in the locale requested via Accept-Language header.
- nativeName: Display name of the language in the locale native for this language.
- scripts: List of scripts to convert from. Each element of the scripts list has properties:
  - code: Code identifying the script.
  - name: Display name of the script in the locale requested via Accept-Language header.
  - nativeName: Display name of the language in the locale native for the language.
  - dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages.
  - toScripts: List of scripts available to convert text to. Each element of the toScripts list has properties code, name, nativeName, and dir as described earlier.
An example is:
```
{
  "transliteration": {
    ...
    "ja": {
      "name": "Japanese",
      "nativeName": "日本語",
      "scripts": [
        {
          "code": "Jpan",
          "name": "Japanese",
          "nativeName": "日本語",
          "dir": "ltr",
          "toScripts": [
            {
              "code": "Latn",
              "name": "Latin",
              "nativeName": "ラテン語",
              "dir": "ltr"
            }
          ]
        },
        {
          "code": "Latn",
          "name": "Latin",
          "nativeName": "ラテン語",
          "dir": "ltr",
          "toScripts": [
            {
              "code": "Jpan",
              "name": "Japanese",
              "nativeName": "日本語",
              "dir": "ltr"
            }
          ]
        }
      ]
    },
    ...
  }
}
```
dictionary property

The value of the dictionary property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. The key identifies a language for which alternative translations and back-translations are available. The value is a JSON object that describes the source language and the target languages with available translations:
- name: Display name of the source language in the locale requested via Accept-Language header.
- nativeName: Display name of the language in the locale native for this language.
- dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages.
- translations: List of languages with alterative translations and examples for the query expressed in the source language. Each element of the translations list has properties:
  - name: Display name of the target language in the locale requested via Accept-Language header.
  - nativeName: Display name of the target language in the locale native for the target language.
  - dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages.
  - code: Language code identifying the target language.
An example is:
```
"es": {
  "name": "Spanish",
  "nativeName": "Español",
  "dir": "ltr",
  "translations": [
    {
      "name": "English",
      "nativeName": "English",
      "dir": "ltr",
      "code": "en"
    }
  ]
},
```

The structure of the response object doesn't change without a change in the version of the API. For the same version of the API, the list of available languages may change over time because Microsoft Translator continually extends the list of languages supported by its services.

The list of supported languages doesn't change frequently. To save network bandwidth and improve responsiveness, a client application should consider caching language resources and the corresponding entity tag (ETag). Then, the client application can periodically (for example, once every 24 hours) query the service to fetch the latest set of supported languages. Passing the current ETag value in an If-None-Match header field allows the service to optimize the response. If the resource isn't modified, the service returns status code 304 and an empty response body.

Response headers

Headers	Description
ETag	Current value of the entity tag for the requested groups of supported languages. To make subsequent requests more efficient, the client may send the `ETag` value in an `If-None-Match` header field.
X-RequestId	Value generated by the service to identify the request. It's used for troubleshooting purposes.

Response status codes

The following are the possible HTTP status codes that a request returns.

Status Code	Description
200	Success.
304	The resource isn't modified and aligns with the version specified by request headers `If-None-Match`.
400	One of the query parameters is missing or not valid. Correct request parameters before retrying.
429	The server rejected the request because the client exceeded request limits.
500	An unexpected error occurred. If the error persists, report it with: date and time of the failure, request identifier from response header `X-RequestId`, and client identifier from request header `X-ClientTraceId`.
503	Server temporarily unavailable. Retry the request. If the error persists, report it with: date and time of the failure, request identifier from response header `X-RequestId`, and client identifier from request header `X-ClientTraceId`.

If an error occurs, the request also returns a JSON error response. The error code is a 6-digit number combining the 3-digit HTTP status code followed by a 3-digit number to further categorize the error. Common error codes can be found on the v3 Translator reference page.

Examples

The following example shows how to retrieve languages supported for text translation.

curl "https://api.translator.azure.cn/languages?api-version=3.0&scope=translation"