v3

latestSwagger 2.02026-07-1363357.2 KB

Translate Text

Translate Text

post/translate

Query parameters

tostring[] required

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.

fromstring

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.

textType'Plain' | 'Html'

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.

categorystring

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.

profanityAction'NoAction' | 'Marked' | 'Deleted'

Specifies how profanities should be treated in translations. Possible values are: NoAction (default), Marked or Deleted.

profanityMarker'Asterisk' | 'Tag'

Specifies how profanities should be marked in translations. Possible values are: Asterisk (default) or Tag.

includeAlignmentboolean

Specifies whether to include alignment projection from source text to translated text. Possible values are: true or false (default).

includeSentenceLengthboolean

Specifies whether to include sentence boundaries for the input text and the translated text. Possible values are: true or false (default).

suggestedFromstring

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.

fromScriptstring

Specifies the script of the input text.

toScriptstring

Specifies the script of the translated text.

allowFallbackboolean

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.

api-versionstring required

Mandatory API version parameter

Headers

X-ClientTraceIdstring

A client-generated GUID to uniquely identify the request.

Request body

textstring required

Text to translate.

Response

Response for the translation API.