Class: Aws::Translate::Types::TranslateTextRequest

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

#settings ⇒ Types::TranslationSettings

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.

Returns:



1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/aws-sdk-translate/types.rb', line 1882

class TranslateTextRequest < Struct.new(
  :text,
  :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 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 `TranslateText` 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) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/aws-sdk-translate/types.rb', line 1882

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

#target_language_code ⇒ String

The language code requested for the language of the target text. For a list of language codes, see [Supported languages].

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

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/aws-sdk-translate/types.rb', line 1882

class TranslateTextRequest < Struct.new(
  :text,
  :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>) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/aws-sdk-translate/types.rb', line 1882

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

#text ⇒ String

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.

Returns:

  • (String) 


1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/aws-sdk-translate/types.rb', line 1882

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