Class: Aws::Translate::Types::TranslateDocumentRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-translate/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ Types::Document

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

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/aws-sdk-translate/types.rb', line 1761

class TranslateDocumentRequest < Struct.new(
  :document,
  :terminology_names,
  :source_language_code,
  :target_language_code,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::TranslationSettings

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.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/aws-sdk-translate/types.rb', line 1761

class TranslateDocumentRequest < Struct.new(
  :document,
  :terminology_names,
  :source_language_code,
  :target_language_code,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#source_language_code ⇒ String

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 markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/translate/latest/dg/what-is-languages.html [2]: docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/aws-sdk-translate/types.rb', line 1761

class TranslateDocumentRequest < Struct.new(
  :document,
  :terminology_names,
  :source_language_code,
  :target_language_code,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#target_language_code ⇒ String

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

[1]: docs.aws.amazon.com/translate/latest/dg/what-is-languages.html

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/aws-sdk-translate/types.rb', line 1761

class TranslateDocumentRequest < Struct.new(
  :document,
  :terminology_names,
  :source_language_code,
  :target_language_code,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#terminology_names ⇒ Array<String>

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].

[1]: docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html

Returns:

  • (Array<String>) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/aws-sdk-translate/types.rb', line 1761

class TranslateDocumentRequest < Struct.new(
  :document,
  :terminology_names,
  :source_language_code,
  :target_language_code,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end