2023/10/31 - Amazon Translate - 5 updated api methods
Changes Added support for Brevity translation settings feature.
{'TextTranslationJobProperties': {'Settings': {'Brevity': 'ON'}}}
Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
See also: AWS API Documentation
Request Syntax
client.describe_text_translation_job(
JobId='string'
)
string
[REQUIRED]
The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
dict
Response Syntax
{
'TextTranslationJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'JobDetails': {
'TranslatedDocumentsCount': 123,
'DocumentsWithErrorsCount': 123,
'InputDocumentsCount': 123
},
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'TerminologyNames': [
'string',
],
'ParallelDataNames': [
'string',
],
'Message': 'string',
'SubmittedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'ContentType': 'string'
},
'OutputDataConfig': {
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
'DataAccessRoleArn': 'string',
'Settings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
}
}
Response Structure
(dict) --
TextTranslationJobProperties (dict) --
An object that contains the properties associated with an asynchronous batch translation job.
JobId (string) --
The ID of the translation job.
JobName (string) --
The user-defined name of the translation job.
JobStatus (string) --
The status of the translation job.
JobDetails (dict) --
The number of documents successfully and unsuccessfully processed during the translation job.
TranslatedDocumentsCount (integer) --
The number of documents successfully processed during a translation job.
DocumentsWithErrorsCount (integer) --
The number of documents that could not be processed during a translation job.
InputDocumentsCount (integer) --
The number of documents used as input in a translation job.
SourceLanguageCode (string) --
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
TargetLanguageCodes (list) --
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
(string) --
TerminologyNames (list) --
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
(string) --
ParallelDataNames (list) --
A list containing the names of the parallel data resources applied to the translation job.
(string) --
Message (string) --
An explanation of any errors that may have occurred during the translation job.
SubmittedTime (datetime) --
The time at which the translation job was submitted.
EndTime (datetime) --
The time at which the translation job ended.
InputDataConfig (dict) --
The input configuration properties that were specified when the job was requested.
S3Uri (string) --
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
ContentType (string) --
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
application/x-xliff+xml : The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
Warning
If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.
OutputDataConfig (dict) --
The output configuration properties that were specified when the job was requested.
S3Uri (string) --
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
EncryptionKey (dict) --
The encryption key used to encrypt this object.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
Settings (dict) --
Settings that modify the translation output.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
{'TextTranslationJobPropertiesList': {'Settings': {'Brevity': 'ON'}}}
Gets a list of the batch translation jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
client.list_text_translation_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmittedBeforeTime': datetime(2015, 1, 1),
'SubmittedAfterTime': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
dict
The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.
JobName (string) --
Filters the list of jobs by name.
JobStatus (string) --
Filters the list of jobs based by job status.
SubmittedBeforeTime (datetime) --
Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
SubmittedAfterTime (datetime) --
Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
string
The token to request the next page of results.
integer
The maximum number of results to return in each page. The default value is 100.
dict
Response Syntax
{
'TextTranslationJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'JobDetails': {
'TranslatedDocumentsCount': 123,
'DocumentsWithErrorsCount': 123,
'InputDocumentsCount': 123
},
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'TerminologyNames': [
'string',
],
'ParallelDataNames': [
'string',
],
'Message': 'string',
'SubmittedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'ContentType': 'string'
},
'OutputDataConfig': {
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
'DataAccessRoleArn': 'string',
'Settings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TextTranslationJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a translation job.
JobId (string) --
The ID of the translation job.
JobName (string) --
The user-defined name of the translation job.
JobStatus (string) --
The status of the translation job.
JobDetails (dict) --
The number of documents successfully and unsuccessfully processed during the translation job.
TranslatedDocumentsCount (integer) --
The number of documents successfully processed during a translation job.
DocumentsWithErrorsCount (integer) --
The number of documents that could not be processed during a translation job.
InputDocumentsCount (integer) --
The number of documents used as input in a translation job.
SourceLanguageCode (string) --
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
TargetLanguageCodes (list) --
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
(string) --
TerminologyNames (list) --
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
(string) --
ParallelDataNames (list) --
A list containing the names of the parallel data resources applied to the translation job.
(string) --
Message (string) --
An explanation of any errors that may have occurred during the translation job.
SubmittedTime (datetime) --
The time at which the translation job was submitted.
EndTime (datetime) --
The time at which the translation job ended.
InputDataConfig (dict) --
The input configuration properties that were specified when the job was requested.
S3Uri (string) --
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
ContentType (string) --
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
application/x-xliff+xml : The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
Warning
If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.
OutputDataConfig (dict) --
The output configuration properties that were specified when the job was requested.
S3Uri (string) --
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
EncryptionKey (dict) --
The encryption key used to encrypt this object.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
Settings (dict) --
Settings that modify the translation output.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'Settings': {'Brevity': 'ON'}}
Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing .
Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
See also: AWS API Documentation
Request Syntax
client.start_text_translation_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string',
'ContentType': 'string'
},
OutputDataConfig={
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
DataAccessRoleArn='string',
SourceLanguageCode='string',
TargetLanguageCodes=[
'string',
],
TerminologyNames=[
'string',
],
ParallelDataNames=[
'string',
],
ClientToken='string',
Settings={
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
)
string
The name of the batch translation job to be performed.
dict
[REQUIRED]
Specifies the format and location of the input documents for the translation job.
S3Uri (string) -- [REQUIRED]
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
ContentType (string) -- [REQUIRED]
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
application/x-xliff+xml : The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
Warning
If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.
dict
[REQUIRED]
Specifies the S3 folder to which your job output will be saved.
S3Uri (string) -- [REQUIRED]
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
EncryptionKey (dict) --
The encryption key used to encrypt this object.
Type (string) -- [REQUIRED]
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .
string
[REQUIRED]
The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto . Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages .
list
[REQUIRED]
The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.
Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages .
(string) --
list
The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
This parameter accepts only one custom terminology resource.
If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.
For a list of available custom terminology resources, use the ListTerminologies operation.
For more information, see Custom terminology .
(string) --
list
The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.
When you add parallel data to a translation job, you create an Active Custom Translation job.
This parameter accepts only one parallel data resource.
Note
Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing .
For a list of available parallel data resources, use the ListParallelData operation.
For more information, see Customizing your translations with parallel data .
(string) --
string
[REQUIRED]
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
This field is autopopulated if not provided.
dict
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.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
JobStatus (string) --
The status of the job. Possible values include:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Translate is processing the job.
COMPLETED - The job was successfully completed and the output is available.
COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
STOP_REQUESTED - The user who started the job has requested that it be stopped.
STOPPED - The job has been stopped.
{'Settings': {'Brevity': 'ON'}}
Response {'AppliedSettings': {'Brevity': 'ON'}}
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. TranslateDocument 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 .
See also: AWS API Documentation
Request Syntax
client.translate_document(
Document={
'Content': b'bytes',
'ContentType': 'string'
},
TerminologyNames=[
'string',
],
SourceLanguageCode='string',
TargetLanguageCode='string',
Settings={
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
)
dict
[REQUIRED]
The content and content type for the document to be translated. The document size must not exceed 100 KB.
Content (bytes) -- [REQUIRED]
The Content field type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.
ContentType (string) -- [REQUIRED]
Describes the format of the document. You can specify one of the following:
text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.
application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).
list
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 ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology .
(string) --
string
[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 the SourceLanguageCode field. If you specify auto , Amazon Translate will call Amazon Comprehend to determine the source language.
Note
If you specify auto , you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
string
[REQUIRED]
The language code requested for the translated document. For a list of supported language codes, see Supported languages .
dict
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.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
dict
Response Syntax
{
'TranslatedDocument': {
'Content': b'bytes'
},
'SourceLanguageCode': 'string',
'TargetLanguageCode': 'string',
'AppliedTerminologies': [
{
'Name': 'string',
'Terms': [
{
'SourceText': 'string',
'TargetText': 'string'
},
]
},
],
'AppliedSettings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
}
Response Structure
(dict) --
TranslatedDocument (dict) --
The document containing the translated content. The document format matches the source document format.
Content (bytes) --
The document containing the translated content.
SourceLanguageCode (string) --
The language code of the source document.
TargetLanguageCode (string) --
The language code of the translated document.
AppliedTerminologies (list) --
The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.
(dict) --
The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.
Name (string) --
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
Terms (list) --
The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.
(dict) --
The term being translated by the custom terminology.
SourceText (string) --
The source text of the term being translated by the custom terminology.
TargetText (string) --
The target text of the term being translated by the custom terminology.
AppliedSettings (dict) --
Settings to configure your translation output. You can configure the following options:
Brevity: reduces the length of the translation output for most translations. Available for TranslateText only.
Formality: sets the formality level of the translation output.
Profanity: masks profane words and phrases in the translation output.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
{'Settings': {'Brevity': 'ON'}}
Response {'AppliedSettings': {'Brevity': 'ON'}}
Translates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages .
See also: AWS API Documentation
Request Syntax
client.translate_text(
Text='string',
TerminologyNames=[
'string',
],
SourceLanguageCode='string',
TargetLanguageCode='string',
Settings={
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
)
string
[REQUIRED]
The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.
list
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 ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology .
(string) --
string
[REQUIRED]
The language code for the language of the source text. For a list of language codes, see Supported languages .
To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto , Amazon Translate will call Amazon Comprehend to determine the source language.
Note
If you specify auto , you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
string
[REQUIRED]
The language code requested for the language of the target text. For a list of language codes, see Supported languages .
dict
Settings to configure your translation output. You can configure the following options:
Brevity: reduces the length of the translated output for most translations.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
dict
Response Syntax
{
'TranslatedText': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCode': 'string',
'AppliedTerminologies': [
{
'Name': 'string',
'Terms': [
{
'SourceText': 'string',
'TargetText': 'string'
},
]
},
],
'AppliedSettings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK',
'Brevity': 'ON'
}
}
Response Structure
(dict) --
TranslatedText (string) --
The translated text.
SourceLanguageCode (string) --
The language code for the language of the source text.
TargetLanguageCode (string) --
The language code for the language of the target text.
AppliedTerminologies (list) --
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
(dict) --
The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.
Name (string) --
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
Terms (list) --
The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.
(dict) --
The term being translated by the custom terminology.
SourceText (string) --
The source text of the term being translated by the custom terminology.
TargetText (string) --
The target text of the term being translated by the custom terminology.
AppliedSettings (dict) --
Optional settings that modify the translation output.
Formality (string) --
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.
If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Profanity (string) --
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Brevity (string) --
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.