AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the TranslateDocument operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Translate.AmazonTranslateRequest
      Amazon.Translate.Model.TranslateDocumentRequest

Namespace: Amazon.Translate.Model
Assembly: AWSSDK.Translate.dll
Version: 3.x.y.z

Syntax

C# 
public class TranslateDocumentRequest : AmazonTranslateRequest
         IAmazonWebServiceRequest

The TranslateDocumentRequest type exposes the following members

Constructors

NameDescription
Public Method TranslateDocumentRequest()

Properties

NameTypeDescription
Public Property Document Amazon.Translate.Model.Document

Gets and sets the property Document.

The content and content type for the document to be translated. The document size must not exceed 100 KB.

Public Property Settings Amazon.Translate.Model.TranslationSettings

Gets and sets the property 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.

Public Property SourceLanguageCode System.String

Gets and sets the property SourceLanguageCode.

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.

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.

Public Property TargetLanguageCode System.String

Gets and sets the property TargetLanguageCode.

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

Public Property TerminologyNames System.Collections.Generic.List<System.String>

Gets and sets the property 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 ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5