Text Analysis Authoring - Get Supported Languages
Lists the supported languages.
GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?projectKind={projectKind}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-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. |
|
project
|
query |
The project kind, default value is CustomSingleLabelClassification. |
||
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. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The list of supported languages. |
|
Other Status Codes |
Error response. |
Security
AADToken
These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.
To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.
Notes
- This security definition requires the use of the
x-ms-client-id
header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
The Authorization URL
is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
*
The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
*
Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
- Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
A subscription key for a Language service resource.
Type:
apiKey
In:
header
Examples
Successful Supported Languages
Sample request
GET {Endpoint}/language/authoring/analyze-text/projects/global/languages?api-version=2023-04-01
Sample response
{
"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. |
Error |
Human-readable error code. |
Error |
Error response. |
Inner |
Human-readable error code. |
Inner |
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. |
Project |
The project kind. |
Text |
Represents a supported language. |
Text |
Represents a list of retrieved languages. |
Error
The error object.
Name | Type | Description |
---|---|---|
code |
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 |
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
Human-readable error code.
Name | Type | Description |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
Error response.
Name | Type | Description |
---|---|---|
error |
The error object. |
InnerErrorCode
Human-readable error code.
Name | Type | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
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.
Name | Type | Description |
---|---|---|
code |
One of a server-defined set of error codes. |
|
details |
object |
Error details. |
innererror |
An object containing more specific information than the current object about the error. |
|
message |
string |
Error message. |
target |
string |
Error target. |
ProjectKind
The project kind.
Name | Type | Description |
---|---|---|
CustomEntityRecognition |
string |
For building an extraction model to identify your domain categories using your own data. |
CustomMultiLabelClassification |
string |
For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. |
CustomSingleLabelClassification |
string |
For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. |
TextAnalysisAuthoringSupportedLanguage
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
Represents a list of retrieved languages.
Name | Type | Description |
---|---|---|
nextLink |
string |
The next page link. |
value |
The list of the languages. |