Class LanguageIdSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LanguageIdSettings.Builder,
LanguageIdSettings>
If using automatic language identification in your request and you want to apply a custom language model, a custom
vocabulary, or a custom vocabulary filter, include LanguageIdSettings
with the relevant sub-parameters (
VocabularyName
, LanguageModelName
, and VocabularyFilterName
). Note that
multi-language identification (IdentifyMultipleLanguages
) doesn't support custom language models.
LanguageIdSettings
supports two to five language codes. Each language code you include can have an
associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you
specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary
filters.
It's recommended that you include LanguageOptions
when using LanguageIdSettings
to ensure
that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in
en-US
but Amazon Transcribe determines that the language spoken in your media is en-AU
,
your custom vocabulary is not applied to your transcription. If you include LanguageOptions
and
include en-US
as the only English language dialect, your custom vocabulary is applied to your
transcription.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the
LanguageModelName
sub-parameter. If you want
to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to
use automatic language identification, use instead the parameter with the
VocabularyName
or
VocabularyFilterName
(or both) sub-parameter.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LanguageIdSettings.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The name of the custom language model you want to use when processing your transcription job.static Class
<? extends LanguageIdSettings.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.final String
The name of the custom vocabulary filter you want to use when processing your transcription job.final String
The name of the custom vocabulary you want to use when processing your transcription job.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vocabularyName
The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
- Returns:
- The name of the custom vocabulary you want to use when processing your transcription job. Custom
vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
-
vocabularyFilterName
The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.
The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include
VocabularyFilterName
in your request, you must also includeVocabularyFilterMethod
.- Returns:
- The name of the custom vocabulary filter you want to use when processing your transcription job. Custom
vocabulary filter names are case sensitive.
The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include
VocabularyFilterName
in your request, you must also includeVocabularyFilterMethod
.
-
languageModelName
The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
- Returns:
- The name of the custom language model you want to use when processing your transcription job. Note that
custom language model names are case sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
-
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<LanguageIdSettings.Builder,
LanguageIdSettings> - 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
-