Amazonka.Translate.Types.TranslationSettings

Documentation

data TranslationSettings

Optional settings that configure the translation output. Use these settings for real time translations and asynchronous translation jobs.

See: newTranslationSettings smart constructor.

Constructors

TranslationSettings'

Fields

• formality :: Maybe Formality

  You can optionally 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 :: Maybe Profanity

  Enable the profanity setting if you want Amazon Translate 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.

Instances

FromJSON TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

parseJSON :: Value -> Parser TranslationSettings

parseJSONList :: Value -> Parser [TranslationSettings]

ToJSON TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

toJSON :: TranslationSettings -> Value

toEncoding :: TranslationSettings -> Encoding

toJSONList :: [TranslationSettings] -> Value

toEncodingList :: [TranslationSettings] -> Encoding

Generic TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Associated Types

type Rep TranslationSettings :: Type -> Type

Methods

from :: TranslationSettings -> Rep TranslationSettings x

to :: Rep TranslationSettings x -> TranslationSettings

Read TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

readsPrec :: Int -> ReadS TranslationSettings

readList :: ReadS [TranslationSettings]

readPrec :: ReadPrec TranslationSettings

readListPrec :: ReadPrec [TranslationSettings]

Show TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

showsPrec :: Int -> TranslationSettings -> ShowS

show :: TranslationSettings -> String

showList :: [TranslationSettings] -> ShowS

NFData TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

rnf :: TranslationSettings -> ()

Eq TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

(==) :: TranslationSettings -> TranslationSettings -> Bool

(/=) :: TranslationSettings -> TranslationSettings -> Bool

Hashable TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

Methods

hashWithSalt :: Int -> TranslationSettings -> Int

hash :: TranslationSettings -> Int

type Rep TranslationSettings

Defined in Amazonka.Translate.Types.TranslationSettings

type Rep TranslationSettings = D1 ('MetaData "TranslationSettings" "Amazonka.Translate.Types.TranslationSettings" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "TranslationSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "formality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Formality)) :*: S1 ('MetaSel ('Just "profanity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Profanity))))

newTranslationSettings :: TranslationSettings

Create a value of TranslationSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:formality:TranslationSettings', translationSettings_formality - You can optionally 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.

$sel:profanity:TranslationSettings', translationSettings_profanity - Enable the profanity setting if you want Amazon Translate 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.

translationSettings_formality :: Lens' TranslationSettings (Maybe Formality)

You can optionally 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.

translationSettings_profanity :: Lens' TranslationSettings (Maybe Profanity)

Enable the profanity setting if you want Amazon Translate 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.