Class: Aws::Translate::Types::TranslationSettings

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

[1]: docs.aws.amazon.com/translate/latest/dg/customizing-translations-brevity

Returns:

  • (String) 


2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-translate/types.rb', line 2015

class TranslationSettings < Struct.new(
  :formality,
  :profanity,
  :brevity)
  SENSITIVE = []
  include Aws::Structure
end

#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][2

in the Amazon Translate Developer Guide.

[1]: en.wikipedia.org/wiki/Register_(sociolinguistics) [2]: docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html#customizing-translations-formality-languages

Returns:

  • (String) 


2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-translate/types.rb', line 2015

class TranslationSettings < Struct.new(
  :formality,
  :profanity,
  :brevity)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/translate/latest/dg/customizing-translations-profanity.html#customizing-translations-profanity-languages

Returns:

  • (String) 


2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-translate/types.rb', line 2015

class TranslationSettings < Struct.new(
  :formality,
  :profanity,
  :brevity)
  SENSITIVE = []
  include Aws::Structure
end