Class TranslationSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TranslationSettings.Builder,
TranslationSettings>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Brevity
brevity()
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).final 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).static TranslationSettings.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Formality
You can specify the desired level of formality for translations to supported target languages.final String
You can specify the desired level of formality for translations to supported target languages.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Profanity
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.final String
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.static Class
<? extends TranslationSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
formality
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 in the Amazon Translate Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
formality
will returnFormality.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformalityAsString()
.- Returns:
- 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 in the Amazon Translate Developer Guide.
- See Also:
-
formalityAsString
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 in the Amazon Translate Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
formality
will returnFormality.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformalityAsString()
.- Returns:
- 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 in the Amazon Translate Developer Guide.
- See Also:
-
profanity
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.
If the service returns an enum value that is not available in the current SDK version,
profanity
will returnProfanity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprofanityAsString()
.- Returns:
- 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.
- See Also:
-
profanityAsString
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.
If the service returns an enum value that is not available in the current SDK version,
profanity
will returnProfanity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprofanityAsString()
.- Returns:
- 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.
- See Also:
-
brevity
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.
If the service returns an enum value that is not available in the current SDK version,
brevity
will returnBrevity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombrevityAsString()
.- Returns:
- 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.
- See Also:
-
brevityAsString
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.
If the service returns an enum value that is not available in the current SDK version,
brevity
will returnBrevity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombrevityAsString()
.- Returns:
- 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.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TranslationSettings.Builder,
TranslationSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-