Translate Document
translate_translate_document | R Documentation |
Translates the input document from the source language to the target language¶
Description¶
Translates the input document from the source language to the target
language. This synchronous operation supports text, HTML, or Word
documents as the input document. translate_document
supports
translations from English to any supported language, and from any
supported language to English. Therefore, specify either the source
language code or the target language code as “en” (English).
If you set the Formality
parameter, the request will fail if the
target language does not support formality. For a list of target
languages that support formality, see Setting
formality.
Usage¶
translate_translate_document(Document, TerminologyNames,
SourceLanguageCode, TargetLanguageCode, Settings)
Arguments¶
Document
[required] The content and content type for the document to be translated. The document size must not exceed 100 KB.
TerminologyNames
The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the
list_terminologies
operation to get the available terminology lists.For more information about custom terminology lists, see Custom terminology.
SourceLanguageCode
[required] The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify
auto
in theSourceLanguageCode
field. If you specifyauto
, Amazon Translate will call Amazon Comprehend to determine the source language.If you specify
auto
, you must send thetranslate_document
request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.TargetLanguageCode
[required] The language code requested for the translated document. For a list of supported language codes, see Supported languages.
Settings
Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
Value¶
A list with the following syntax:
list(
TranslatedDocument = list(
Content = raw
),
SourceLanguageCode = "string",
TargetLanguageCode = "string",
AppliedTerminologies = list(
list(
Name = "string",
Terms = list(
list(
SourceText = "string",
TargetText = "string"
)
)
)
),
AppliedSettings = list(
Formality = "FORMAL"|"INFORMAL",
Profanity = "MASK",
Brevity = "ON"
)
)