TranslationTarget interface

Reference dataset ID having sentence pair to generate adaptive customized translation.

adaptiveDatasetId?: string

Property Value

In the case where a custom system is being used, specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. In the case where a Large Language Model is being used, specifies that the service is allowed to fall back to a Small Language Model if an error occurs. 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.

allowFallback?: boolean

Property Value

Default is 'general', which uses NMT system. 'abc-inc-gpt-4o', and 'abc-inc-gpt-4o-mini' are examples of deployment names which use GPT-4o uses or GPT-4o-mini model. 'gpt-4o' uses GPT-4o model.

<custom model id> uses the custom NMT model tuned by customer. 'best' system determines which is the best model to use for the request. This intelligence could be introduced in future. Customer should have deployed it in their resource.

deploymentName?: string

Property Value

Desired gender of target translation. Accepted values are female, male, or neutral.

Possible values: "neutral", "male", "female"

gender?: string

Property Value

Specifies the language of the output text. The target language must be one of the supported languages included in the translation scope. It's possible to translate to multiple languages simultaneously by including multiple string values in the targetsLanguage array.

language: string

Property Value

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

profanityAction?: ProfanityAction

Property Value

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

profanityMarker?: ProfanityMarker

Property Value

Reference text pairs to generate adaptive customized translation.

referenceTextPairs?: ReferenceTextPair[]

Property Value

Specifies the script of the translated text.

script?: string

Property Value

Desired tone of target translation. Accepted values are formal, informal, or neutral.

Possible values: "neutral", "formal", "informal"

tone?: string

Property Value