Class EngineTranscribeSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EngineTranscribeSettings.Builder,
EngineTranscribeSettings>
Settings specific for Amazon Transcribe as the live transcription engine.
If you specify an invalid combination of parameters, a TranscriptFailed
event will be sent with the
contents of the BadRequestException
generated by Amazon Transcribe. For more information on each
parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Labels all personally identifiable information (PII) identified in your transcript.final String
Labels all personally identifiable information (PII) identified in your transcript.Content redaction is performed at the segment level.final String
Content redaction is performed at the segment level.final Boolean
Enables partial result stabilization for your transcription.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 Boolean
Enables automatic language identification for your transcription.final TranscribeLanguageCode
Specify the language code that represents the language spoken.final String
Specify the language code that represents the language spoken.final String
Specify the name of the custom language model that you want to use when processing your transcription.final String
Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization
).final String
Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization
).final String
Specify which types of personally identifiable information (PII) you want to redact in your transcript.final TranscribeLanguageCode
Specify a preferred language from the subset of languages codes you specified inLanguageOptions
.final String
Specify a preferred language from the subset of languages codes you specified inLanguageOptions
.final TranscribeRegion
region()
The AWS Region in which to use Amazon Transcribe.final String
The AWS Region in which to use Amazon Transcribe.static Class
<? extends EngineTranscribeSettings.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.Specify how you want your vocabulary filter applied to your transcript.final String
Specify how you want your vocabulary filter applied to your transcript.final String
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.final String
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.final String
Specify the name of the custom vocabulary that you want to use when processing your transcription.final String
Specify the names of the custom vocabularies that you want to use when processing your transcription.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
languageCode
Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using
IdentifyLanguage
to enable automatic language identification.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnTranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using
IdentifyLanguage
to enable automatic language identification. - See Also:
-
languageCodeAsString
Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using
IdentifyLanguage
to enable automatic language identification.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnTranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using
IdentifyLanguage
to enable automatic language identification. - See Also:
-
vocabularyFilterMethod
Specify how you want your vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
.If the service returns an enum value that is not available in the current SDK version,
vocabularyFilterMethod
will returnTranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- Specify how you want your vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
. - See Also:
-
vocabularyFilterMethodAsString
Specify how you want your vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
.If the service returns an enum value that is not available in the current SDK version,
vocabularyFilterMethod
will returnTranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- Specify how you want your vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
. - See Also:
-
vocabularyFilterName
Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you include
IdentifyLanguage
and want to use one or more vocabulary filters with your transcription, use theVocabularyFilterNames
parameter instead.- Returns:
- Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you include
IdentifyLanguage
and want to use one or more vocabulary filters with your transcription, use theVocabularyFilterNames
parameter instead.
-
vocabularyName
Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you include
IdentifyLanguage
and want to use one or more custom vocabularies with your transcription, use theVocabularyNames
parameter instead.- Returns:
- Specify the name of the custom vocabulary that you want to use when processing your transcription. Note
that vocabulary names are case sensitive.
If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you include
IdentifyLanguage
and want to use one or more custom vocabularies with your transcription, use theVocabularyNames
parameter instead.
-
region
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the
MediaRegion
parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in theMediaRegion
, then a TranscriptFailed event is sent.Use
auto
to use Amazon Transcribe in a Region near the meeting’sMediaRegion
. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.If the service returns an enum value that is not available in the current SDK version,
region
will returnTranscribeRegion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregionAsString()
.- Returns:
- The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the
MediaRegion
parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in theMediaRegion
, then a TranscriptFailed event is sent.Use
auto
to use Amazon Transcribe in a Region near the meeting’sMediaRegion
. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide. - See Also:
-
regionAsString
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the
MediaRegion
parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in theMediaRegion
, then a TranscriptFailed event is sent.Use
auto
to use Amazon Transcribe in a Region near the meeting’sMediaRegion
. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.If the service returns an enum value that is not available in the current SDK version,
region
will returnTranscribeRegion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregionAsString()
.- Returns:
- The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the
MediaRegion
parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in theMediaRegion
, then a TranscriptFailed event is sent.Use
auto
to use Amazon Transcribe in a Region near the meeting’sMediaRegion
. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide. - See Also:
-
enablePartialResultsStabilization
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
- Returns:
- Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
-
partialResultsStability
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization
).Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
If the service returns an enum value that is not available in the current SDK version,
partialResultsStability
will returnTranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompartialResultsStabilityAsString()
.- Returns:
- Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization
).Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
- See Also:
-
partialResultsStabilityAsString
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization
).Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
If the service returns an enum value that is not available in the current SDK version,
partialResultsStability
will returnTranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompartialResultsStabilityAsString()
.- Returns:
- Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization
).Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
- See Also:
-
contentIdentificationType
Labels all personally identifiable information (PII) identified in your transcript. If you don't include
PiiEntityTypes
, all PII is identified.You can’t set
ContentIdentificationType
andContentRedactionType
.If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType
will returnTranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentIdentificationTypeAsString()
.- Returns:
- Labels all personally identifiable information (PII) identified in your transcript. If you don't include
PiiEntityTypes
, all PII is identified.You can’t set
ContentIdentificationType
andContentRedactionType
. - See Also:
-
contentIdentificationTypeAsString
Labels all personally identifiable information (PII) identified in your transcript. If you don't include
PiiEntityTypes
, all PII is identified.You can’t set
ContentIdentificationType
andContentRedactionType
.If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType
will returnTranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentIdentificationTypeAsString()
.- Returns:
- Labels all personally identifiable information (PII) identified in your transcript. If you don't include
PiiEntityTypes
, all PII is identified.You can’t set
ContentIdentificationType
andContentRedactionType
. - See Also:
-
contentRedactionType
Content redaction is performed at the segment level. If you don't include
PiiEntityTypes
, all PII is redacted.You can’t set
ContentIdentificationType
andContentRedactionType
.If the service returns an enum value that is not available in the current SDK version,
contentRedactionType
will returnTranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentRedactionTypeAsString()
.- Returns:
- Content redaction is performed at the segment level. If you don't include
PiiEntityTypes
, all PII is redacted.You can’t set
ContentIdentificationType
andContentRedactionType
. - See Also:
-
contentRedactionTypeAsString
Content redaction is performed at the segment level. If you don't include
PiiEntityTypes
, all PII is redacted.You can’t set
ContentIdentificationType
andContentRedactionType
.If the service returns an enum value that is not available in the current SDK version,
contentRedactionType
will returnTranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentRedactionTypeAsString()
.- Returns:
- Content redaction is performed at the segment level. If you don't include
PiiEntityTypes
, all PII is redacted.You can’t set
ContentIdentificationType
andContentRedactionType
. - See Also:
-
piiEntityTypes
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select
ALL
.Values must be comma-separated and can include:
ADDRESS
,BANK_ACCOUNT_NUMBER
,BANK_ROUTING
,CREDIT_DEBIT_CVV
,CREDIT_DEBIT_EXPIRY
CREDIT_DEBIT_NUMBER
,EMAIL
,NAME
,PHONE
,PIN
,SSN
, orALL
.Note that if you include
PiiEntityTypes
, you must also includeContentIdentificationType
orContentRedactionType
.If you include
ContentRedactionType
orContentIdentificationType
, but do not includePiiEntityTypes
, all PII is redacted or identified.- Returns:
- Specify which types of personally identifiable information (PII) you want to redact in your transcript.
You can include as many types as you'd like, or you can select
ALL
.Values must be comma-separated and can include:
ADDRESS
,BANK_ACCOUNT_NUMBER
,BANK_ROUTING
,CREDIT_DEBIT_CVV
,CREDIT_DEBIT_EXPIRY
CREDIT_DEBIT_NUMBER
,EMAIL
,NAME
,PHONE
,PIN
,SSN
, orALL
.Note that if you include
PiiEntityTypes
, you must also includeContentIdentificationType
orContentRedactionType
.If you include
ContentRedactionType
orContentIdentificationType
, but do not includePiiEntityTypes
, all PII is redacted or identified.
-
languageModelName
Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
- Returns:
- Specify the name of the custom language model that you want to use when processing your transcription.
Note that language model names are case sensitive.
The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
-
identifyLanguage
Enables automatic language identification for your transcription.
If you include
IdentifyLanguage
, you can optionally useLanguageOptions
to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.You can also use
PreferredLanguage
to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.You must include either
LanguageCode
orIdentifyLanguage
.Language identification can't be combined with custom language models or redaction.
- Returns:
- Enables automatic language identification for your transcription.
If you include
IdentifyLanguage
, you can optionally useLanguageOptions
to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.You can also use
PreferredLanguage
to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.You must include either
LanguageCode
orIdentifyLanguage
.Language identification can't be combined with custom language models or redaction.
-
languageOptions
Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
Including language options can improve the accuracy of language identification.
If you include
LanguageOptions
, you must also includeIdentifyLanguage
.You can only include one language dialect per language. For example, you cannot include
en-US
anden-AU
.- Returns:
- Specify two or more language codes that represent the languages you think may be present in your media;
including more than five is not recommended. If you're unsure what languages are present, do not include
this parameter.
Including language options can improve the accuracy of language identification.
If you include
LanguageOptions
, you must also includeIdentifyLanguage
.You can only include one language dialect per language. For example, you cannot include
en-US
anden-AU
.
-
preferredLanguage
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions
.You can only use this parameter if you include
IdentifyLanguage
andLanguageOptions
.If the service returns an enum value that is not available in the current SDK version,
preferredLanguage
will returnTranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreferredLanguageAsString()
.- Returns:
- Specify a preferred language from the subset of languages codes you specified in
LanguageOptions
.You can only use this parameter if you include
IdentifyLanguage
andLanguageOptions
. - See Also:
-
preferredLanguageAsString
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions
.You can only use this parameter if you include
IdentifyLanguage
andLanguageOptions
.If the service returns an enum value that is not available in the current SDK version,
preferredLanguage
will returnTranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreferredLanguageAsString()
.- Returns:
- Specify a preferred language from the subset of languages codes you specified in
LanguageOptions
.You can only use this parameter if you include
IdentifyLanguage
andLanguageOptions
. - See Also:
-
vocabularyNames
Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you don't include
IdentifyLanguage
and want to use a custom vocabulary with your transcription, use theVocabularyName
parameter instead.- Returns:
- Specify the names of the custom vocabularies that you want to use when processing your transcription.
Note that vocabulary names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you don't include
IdentifyLanguage
and want to use a custom vocabulary with your transcription, use theVocabularyName
parameter instead.
-
vocabularyFilterNames
Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you're not including
IdentifyLanguage
and want to use a custom vocabulary filter with your transcription, use theVocabularyFilterName
parameter instead.- Returns:
- Specify the names of the custom vocabulary filters that you want to use when processing your
transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you're not including
IdentifyLanguage
and want to use a custom vocabulary filter with your transcription, use theVocabularyFilterName
parameter instead.
-
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<EngineTranscribeSettings.Builder,
EngineTranscribeSettings> - 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
-