Text Translation (stable:3.0)

2025/09/05 • 6 new methods

FindSentenceBoundaries (new)
Description :  Find Sentence Boundaries
Reference :  Link ¶

⚼ Request

POST:  /breaksentence
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
language:
{
Description: Language tag identifying the language of the input text. If a code isn't specified, automatic language detection will be applied. ,
Required: False ,
}
string ,
script:
{
Description: Script tag identifying the script used by the input text. If a script isn't specified, the default script of the language will be assumed. ,
Required: False ,
}
string ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
body:
{
Description: Defines the content of the request ,
Required: True ,
}
{
text:
{
Description: Text to translate. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
detectedLanguage:
{
Description: The detectedLanguage property is only present in the result object when language auto-detection is requested. ,
Required: False ,
}
{
language:
{
Description: A string representing the code of the detected language. ,
Required: True ,
}
string ,
score:
{
Description: A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence. ,
Format: float ,
Required: True ,
}
number ,
}
,
sentLen:
{
Description: An integer array representing the lengths of the sentences in the input text. The length of the array is the number of sentences, and the values are the length of each sentence. ,
Required: True ,
}
[
integer ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}
LookupDictionaryExamples (new)
Description :  Lookup Dictionary Examples
Reference :  Link ¶

⚼ Request

POST:  /dictionary/examples
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
from:
{
Description: Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope. ,
Required: True ,
}
string ,
to:
{
Description: Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
body:
{
Description: Defines the content of the request ,
Required: True ,
}
{
translation:
{
Description: A string specifying the translated text previously returned by the Dictionary lookup operation. This should be the value from the normalizedTarget field in the translations list of the Dictionary lookup response. The service will return examples for the specific source-target word-pair. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
normalizedSource:
{
Description: A string giving the normalized form of the source term. Generally, this should be identical to the value of the Text field at the matching list index in the body of the request. ,
Required: True ,
}
string ,
normalizedTarget:
{
Description: A string giving the normalized form of the target term. Generally, this should be identical to the value of the Translation field at the matching list index in the body of the request. ,
Required: True ,
}
string ,
examples:
{
Description: A list of examples for the (source term, target term) pair. ,
Required: True ,
}
[
{
sourcePrefix:
{
Description: The string to concatenate before the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. ,
Required: True ,
}
string ,
sourceTerm:
{
Description: A string equal to the actual term looked up. The string is added with sourcePrefix and sourceSuffix to form the complete example. Its value is separated so it can be marked in a user interface, e.g., by bolding it. ,
Required: True ,
}
string ,
sourceSuffix:
{
Description: The string to concatenate after the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string. ,
Required: True ,
}
string ,
targetPrefix:
{
Description: A string similar to sourcePrefix but for the target. ,
Required: True ,
}
string ,
targetTerm:
{
Description: A string similar to sourceTerm but for the target. ,
Required: True ,
}
string ,
targetSuffix:
{
Description: A string similar to sourceSuffix but for the target. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}
LookupDictionaryEntries (new)
Description :  Lookup Dictionary Entries
Reference :  Link ¶

⚼ Request

POST:  /dictionary/lookup
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
from:
{
Description: Specifies the language of the input text. The source language must be one of the supported languages included in the dictionary scope. ,
Required: True ,
}
string ,
to:
{
Description: Specifies the language of the output text. The target language must be one of the supported languages included in the dictionary scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
body:
{
Description: Defines the content of the request ,
Required: True ,
}
{
text:
{
Description: Text to translate. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
normalizedSource:
{
Description: A string giving the normalized form of the source term. For example, if the request is "JOHN", the normalized form will be "john". The content of this field becomes the input to lookup examples. ,
Required: True ,
}
string ,
displaySource:
{
Description: A string giving the source term in a form best suited for end-user display. For example, if the input is "JOHN", the display form will reflect the usual spelling of the name: "John". ,
Required: True ,
}
string ,
translations:
{
Description: A list of translations for the source term. ,
Required: True ,
}
[
{
normalizedTarget:
{
Description: A string giving the normalized form of this term in the target language. This value should be used as input to lookup examples. ,
Required: True ,
}
string ,
displayTarget:
{
Description: A string giving the term in the target language and in a form best suited for end-user display. Generally, this will only differ from the normalizedTarget in terms of capitalization. For example, a proper noun like "Juan" will have normalizedTarget = "juan" and displayTarget = "Juan". ,
Required: True ,
}
string ,
posTag:
{
Description: A string associating this term with a part-of-speech tag. ,
Required: True ,
}
string ,
confidence:
{
Description: A value between 0.0 and 1.0 which represents the "confidence" (or perhaps more accurately, "probability in the training data") of that translation pair. The sum of confidence scores for one source word may or may not sum to 1.0. ,
Format: float ,
Required: True ,
}
number ,
prefixWord:
{
Description: A string giving the word to display as a prefix of the translation. Currently, this is the gendered determiner of nouns, in languages that have gendered determiners. For example, the prefix of the Spanish word "mosca" is "la", since "mosca" is a feminine noun in Spanish. This is only dependent on the translation, and not on the source. If there is no prefix, it will be the empty string. ,
Required: True ,
}
string ,
backTranslations:
{
Description: A list of "back translations" of the target. For example, source words that the target can translate to. The list is guaranteed to contain the source word that was requested (e.g., if the source word being looked up is "fly", then it is guaranteed that "fly" will be in the backTranslations list). However, it is not guaranteed to be in the first position, and often will not be. ,
Required: True ,
}
[
{
normalizedText:
{
Description: A string giving the normalized form of the source term that is a back-translation of the target. This value should be used as input to lookup examples. ,
Required: True ,
}
string ,
displayText:
{
Description: A string giving the source term that is a back-translation of the target in a form best suited for end-user display. ,
Required: True ,
}
string ,
numExamples:
{
Description: An integer representing the number of examples that are available for this translation pair. Actual examples must be retrieved with a separate call to lookup examples. The number is mostly intended to facilitate display in a UX. For example, a user interface may add a hyperlink to the back-translation if the number of examples is greater than zero and show the back-translation as plain text if there are no examples. Note that the actual number of examples returned by a call to lookup examples may be less than numExamples, because additional filtering may be applied on the fly to remove "bad" examples. ,
Format: int32 ,
Required: True ,
}
integer ,
frequencyCount:
{
Description: An integer representing the frequency of this translation pair in the data. The main purpose of this field is to provide a user interface with a means to sort back-translations so the most frequent terms are first. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}
GetSupportedLanguages (new)
Description :  Gets the set of languages currently supported by other operations of the Translator.
Reference :  Link ¶

⚼ Request

GET:  /languages
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
scope:
{
Description: 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`. To decide which set of supported languages is appropriate for your scenario, see the description of the [response object](#response-body). ,
Required: False ,
}
string ,
Accept-Language:
{
Description: 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 is not specified or when localization is not available. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Passing the value of the ETag response header in an If-None-Match field will allow the service to optimize the response. If the resource has not been modified, the service will return status code 304 and an empty response body. ,
Required: False ,
}
string ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: 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. ,
}
string ,
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Response for the languages API. ,
}
{
translation:
{
Description: Languages that support translate API. ,
Required: False ,
}
object ,
transliteration:
{
Description: Languages that support transliteration API. ,
Required: False ,
}
object ,
dictionary:
{
Description: Languages that support dictionary API. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}
Translate (new)
Description :  Translate Text
Reference :  Link ¶

⚼ Request

POST:  /translate
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
to:
{
Description: Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. For example, use to=de to translate to German. It's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. For example, use to=de&to=it to translate to German and Italian. ,
Required: True ,
}
array ,
from:
{
Description: Specifies the language of the input text. Find which languages are available to translate from by looking up supported languages using the translation scope. If the from parameter isn't specified, automatic language detection is applied to determine the source language. You must use the from parameter rather than autodetection when using the dynamic dictionary feature. Note: the dynamic dictionary feature is case-sensitive. ,
Required: False ,
}
string ,
textType:
{
Description: Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, complete element. Possible values are: plain (default) or html. ,
Required: False ,
}
string ,
category:
{
Description: A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general. ,
Required: False ,
}
string ,
profanityAction:
{
Description: Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted. ,
Required: False ,
}
string ,
profanityMarker:
{
Description: Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag. ,
Required: False ,
}
string ,
includeAlignment:
{
Description: Specifies whether to include alignment projection from source text to translated text. Possible values are: true or false (default). ,
Required: False ,
}
boolean ,
includeSentenceLength:
{
Description: Specifies whether to include sentence boundaries for the input text and the translated text. Possible values are: true or false (default). ,
Required: False ,
}
boolean ,
suggestedFrom:
{
Description: Specifies a fallback language if the language of the input text can't be identified. Language autodetection is applied when the from parameter is omitted. If detection fails, the suggestedFrom language will be assumed. ,
Required: False ,
}
string ,
fromScript:
{
Description: Specifies the script of the input text. ,
Required: False ,
}
string ,
toScript:
{
Description: Specifies the script of the translated text. ,
Required: False ,
}
string ,
allowFallback:
{
Description: Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. allowFallback=false specifies that the translation should only use systems trained for the category specified by the request. If a translation for language X to language Y requires chaining through a pivot language E, then all the systems in the chain (X → E and E → Y) will need to be custom and have the same category. If no system is found with the specific category, the request will return a 400 status code. allowFallback=true specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
body:
{
Description: Defines the content of the request ,
Required: True ,
}
{
text:
{
Description: Text to translate. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
x-metered-usage:
{
Description: Specifies consumption (the number of characters for which the user will be charged) for the translation job request. For example, if the word "Hello" is translated from English (en) to French (fr), this field will return the value '5'. ,
}
integer ,
x-mt-system:
{
Description: Specifies the system type that was used for translation for each 'to' language requested for translation. The value is a comma-separated list of strings. Each string indicates a type: * Custom - Request includes a custom system and at least one custom system was used during translation. * Team - All other requests ,
}
string ,
}
,
$schema:
{
detectedLanguage:
{
Description: The detectedLanguage property is only present in the result object when language auto-detection is requested. ,
Required: False ,
}
{
language:
{
Description: A string representing the code of the detected language. ,
Required: True ,
}
string ,
score:
{
Description: A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence. ,
Format: float ,
Required: True ,
}
number ,
}
,
translations:
{
Description: An array of translation results. The size of the array matches the number of target languages specified through the to query parameter. ,
Required: True ,
}
[
{
to:
{
Description: A string representing the language code of the target language. ,
Required: True ,
}
string ,
text:
{
Description: A string giving the translated text. ,
Required: True ,
}
string ,
transliteration:
{
Description: An object giving the translated text in the script specified by the toScript parameter. ,
Required: False ,
}
{
text:
{
Description: A string which is the result of converting the input string to the output script. ,
Required: True ,
}
string ,
script:
{
Description: A string specifying the script used in the output. ,
Required: True ,
}
string ,
}
,
alignment:
{
Description: Alignment information. ,
Required: False ,
}
{
proj:
{
Description: Maps input text to translated text. The alignment information is only provided when the request parameter includeAlignment is true. Alignment is returned as a string value of the following format: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. The colon separates start and end index, the dash separates the languages, and space separates the words. One word may align with zero, one, or multiple words in the other language, and the aligned words may be non-contiguous. When no alignment information is available, the alignment element will be empty. ,
Required: True ,
}
string ,
}
,
sentLen:
{
Description: Sentence boundaries in the input and output texts. ,
Required: False ,
}
{
srcSentLen:
{
Description: An integer array representing the lengths of the sentences in the input text. The length of the array is the number of sentences, and the values are the length of each sentence. ,
Required: True ,
}
[
integer ,
]
,
transSentLen:
{
Description: An integer array representing the lengths of the sentences in the translated text. The length of the array is the number of sentences, and the values are the length of each sentence. ,
Required: True ,
}
[
integer ,
]
,
}
,
}
,
]
,
sourceText:
{
Description: Input text in the default script of the source language. sourceText property is present only when the input is expressed in a script that's not the usual script for the language. For example, if the input were Arabic written in Latin script, then sourceText.text would be the same Arabic text converted into Arab script. ,
Required: False ,
}
{
text:
{
Description: Input text in the default script of the source language. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}
Transliterate (new)
Description :  Transliterate Text
Reference :  Link ¶

⚼ Request

POST:  /transliterate
{
X-ClientTraceId:
{
Description: A client-generated GUID to uniquely identify the request. ,
Required: False ,
}
string ,
language:
{
Description: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. ,
Required: True ,
}
string ,
fromScript:
{
Description: Specifies the script used by the input text. Look up supported languages using the transliteration scope, to find input scripts available for the selected language. ,
Required: True ,
}
string ,
toScript:
{
Description: Specifies the output script. Look up supported languages using the transliteration scope, to find output scripts available for the selected combination of input language and input script. ,
Required: True ,
}
string ,
api-version:
{
Description: Mandatory API version parameter ,
Required: True ,
}
string ,
body:
{
Description: Defines the content of the request ,
Required: True ,
}
{
text:
{
Description: Text to translate. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
text:
{
Description: A string which is the result of converting the input string to the output script. ,
Required: True ,
}
string ,
script:
{
Description: A string specifying the script used in the output. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-requestid:
{
Description: Value generated by the service to identify the request. It is used for troubleshooting purposes. ,
}
string ,
}
,
$schema:
{
Description: Representation of the Error Response from Translator Service. ,
}
{
error:
{
Description: Error details. ,
Required: True ,
}
{
code:
{
Description: Number identifier of the error. ,
Format: int32 ,
Required: True ,
}
integer ,
message:
{
Description: Human readable error description. ,
Required: True ,
}
string ,
}
,
}
,
}