Text Analysis Authoring - Get Supported Languages

Reference

Service:: Azure AI Services

API Version:: 2022-05-01

Lists the supported languages.

GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?api-version=2022-05-01

With optional parameters:

GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2022-05-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client API version.
maxpagesize	query		integer (int32)	The maximum number of resources to include in a single response.
skip	query		integer (int32)	An offset into the collection of the first resource to be returned.
top	query		integer (int32)	The maximum number of resources to return from the collection.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

Name	Type	Description
200 OK	TextAnalysisAuthoringSupportedLanguages	The list of supported languages.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Supported Languages

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?api-version=2022-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "languageName": "English",
      "languageCode": "en"
    },
    {
      "languageName": "English",
      "languageCode": "en-us"
    },
    {
      "languageName": "French",
      "languageCode": "fr"
    },
    {
      "languageName": "Italian",
      "languageCode": "it"
    },
    {
      "languageName": "Spanish",
      "languageCode": "es"
    },
    {
      "languageName": "German",
      "languageCode": "de"
    },
    {
      "languageName": "Portuguese (Brazil)",
      "languageCode": "pt-br"
    },
    {
      "languageName": "Portuguese (Portugal)",
      "languageCode": "pt-pt"
    },
    {
      "languageName": "Afrikaans",
      "languageCode": "af"
    },
    {
      "languageName": "Amharic",
      "languageCode": "am"
    },
    {
      "languageName": "Arabic",
      "languageCode": "ar"
    },
    {
      "languageName": "Assamese",
      "languageCode": "as"
    },
    {
      "languageName": "Azerbaijani",
      "languageCode": "az"
    },
    {
      "languageName": "Belarusian",
      "languageCode": "be"
    },
    {
      "languageName": "Bulgarian",
      "languageCode": "bg"
    },
    {
      "languageName": "Breton",
      "languageCode": "br"
    },
    {
      "languageName": "Bosnian",
      "languageCode": "bs"
    },
    {
      "languageName": "Catalan",
      "languageCode": "ca"
    },
    {
      "languageName": "Czech",
      "languageCode": "cs"
    },
    {
      "languageName": "Welsh",
      "languageCode": "cy"
    },
    {
      "languageName": "Danish",
      "languageCode": "da"
    },
    {
      "languageName": "Greek",
      "languageCode": "el"
    },
    {
      "languageName": "Esperanto",
      "languageCode": "eo"
    },
    {
      "languageName": "Estonian",
      "languageCode": "et"
    },
    {
      "languageName": "Basque",
      "languageCode": "eu"
    },
    {
      "languageName": "Persian",
      "languageCode": "fa"
    },
    {
      "languageName": "Finnish",
      "languageCode": "fi"
    },
    {
      "languageName": "Western Frisian",
      "languageCode": "fy"
    },
    {
      "languageName": "Irish",
      "languageCode": "ga"
    },
    {
      "languageName": "Scottish Gaelic",
      "languageCode": "gd"
    },
    {
      "languageName": "Galician",
      "languageCode": "gl"
    },
    {
      "languageName": "Gujarati",
      "languageCode": "gu"
    },
    {
      "languageName": "Hausa",
      "languageCode": "ha"
    },
    {
      "languageName": "Hebrew",
      "languageCode": "he"
    },
    {
      "languageName": "Hindi",
      "languageCode": "hi"
    },
    {
      "languageName": "Croatian",
      "languageCode": "hr"
    },
    {
      "languageName": "Hungarian",
      "languageCode": "hu"
    },
    {
      "languageName": "Armenian",
      "languageCode": "hy"
    },
    {
      "languageName": "Indonesian",
      "languageCode": "id"
    },
    {
      "languageName": "Japanese",
      "languageCode": "ja"
    },
    {
      "languageName": "Javanese",
      "languageCode": "jv"
    },
    {
      "languageName": "Georgian",
      "languageCode": "ka"
    },
    {
      "languageName": "Kazakh",
      "languageCode": "kk"
    },
    {
      "languageName": "Khmer",
      "languageCode": "km"
    },
    {
      "languageName": "Kannada",
      "languageCode": "kn"
    },
    {
      "languageName": "Korean",
      "languageCode": "ko"
    },
    {
      "languageName": "Kurdish (Kurmanji)",
      "languageCode": "ku"
    },
    {
      "languageName": "Kyrgyz",
      "languageCode": "ky"
    },
    {
      "languageName": "Latin",
      "languageCode": "la"
    },
    {
      "languageName": "Lao",
      "languageCode": "lo"
    },
    {
      "languageName": "Lithuanian",
      "languageCode": "lt"
    },
    {
      "languageName": "Latvian",
      "languageCode": "lv"
    },
    {
      "languageName": "Malagasy",
      "languageCode": "mg"
    },
    {
      "languageName": "Macedonian",
      "languageCode": "mk"
    },
    {
      "languageName": "Malayalam",
      "languageCode": "ml"
    },
    {
      "languageName": "Mongolian",
      "languageCode": "mn"
    },
    {
      "languageName": "Marathi",
      "languageCode": "mr"
    },
    {
      "languageName": "Malay",
      "languageCode": "ms"
    },
    {
      "languageName": "Burmese",
      "languageCode": "my"
    },
    {
      "languageName": "Nepali",
      "languageCode": "ne"
    },
    {
      "languageName": "Dutch",
      "languageCode": "nl"
    },
    {
      "languageName": "Norwegian (Bokmal)",
      "languageCode": "nb"
    },
    {
      "languageName": "Odia",
      "languageCode": "or"
    },
    {
      "languageName": "Punjabi",
      "languageCode": "pa"
    },
    {
      "languageName": "Polish",
      "languageCode": "pl"
    },
    {
      "languageName": "Pashto",
      "languageCode": "ps"
    },
    {
      "languageName": "Romanian",
      "languageCode": "ro"
    },
    {
      "languageName": "Russian",
      "languageCode": "ru"
    },
    {
      "languageName": "Sanskrit",
      "languageCode": "sa"
    },
    {
      "languageName": "Sindhi",
      "languageCode": "sd"
    },
    {
      "languageName": "Sinhala",
      "languageCode": "si"
    },
    {
      "languageName": "Slovak",
      "languageCode": "sk"
    },
    {
      "languageName": "Slovenian",
      "languageCode": "sl"
    },
    {
      "languageName": "Somali",
      "languageCode": "so"
    },
    {
      "languageName": "Albanian",
      "languageCode": "sq"
    },
    {
      "languageName": "Serbian",
      "languageCode": "sr"
    },
    {
      "languageName": "Sundanese",
      "languageCode": "su"
    },
    {
      "languageName": "Swedish",
      "languageCode": "sv"
    },
    {
      "languageName": "Swahili",
      "languageCode": "sw"
    },
    {
      "languageName": "Tamil",
      "languageCode": "ta"
    },
    {
      "languageName": "Telugu",
      "languageCode": "te"
    },
    {
      "languageName": "Thai",
      "languageCode": "th"
    },
    {
      "languageName": "Filipino",
      "languageCode": "tl"
    },
    {
      "languageName": "Turkish",
      "languageCode": "tr"
    },
    {
      "languageName": "Uyghur",
      "languageCode": "ug"
    },
    {
      "languageName": "Ukrainian",
      "languageCode": "uk"
    },
    {
      "languageName": "Urdu",
      "languageCode": "ur"
    },
    {
      "languageName": "Uzbek",
      "languageCode": "uz"
    },
    {
      "languageName": "Vietnamese",
      "languageCode": "vi"
    },
    {
      "languageName": "Xhosa",
      "languageCode": "xh"
    },
    {
      "languageName": "Yiddish",
      "languageCode": "yi"
    },
    {
      "languageName": "Chinese (Simplified)",
      "languageCode": "zh-hans"
    },
    {
      "languageName": "Chinese (Traditional)",
      "languageCode": "zh-hant"
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringSupportedLanguage	Represents a supported language.
TextAnalysisAuthoringSupportedLanguages	Represents a list of retrieved languages.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

TextAnalysisAuthoringSupportedLanguage

Object

Represents a supported language.

Name	Type	Description
languageCode	string	The language code. This is BCP-47 representation of a language. For example, "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
languageName	string	The language name.

TextAnalysisAuthoringSupportedLanguages

Object

Represents a list of retrieved languages.

Name	Type	Description
nextLink	string	The next page link.
value	TextAnalysisAuthoringSupportedLanguage[]	The list of the languages.

Share via

Text Analysis Authoring - Get Supported Languages

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Successful Supported Languages

Sample request

Sample response

Definitions

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

TextAnalysisAuthoringSupportedLanguage

TextAnalysisAuthoringSupportedLanguages

Additional resources