@Generated(value="software.amazon.awssdk:codegen") public final class EngineTranscribeSettings extends Object implements SdkPojo, Serializable, 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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
EngineTranscribeSettings.Builder |
| Modifier and Type | Method and Description |
|---|---|
static EngineTranscribeSettings.Builder |
builder() |
TranscribeContentIdentificationType |
contentIdentificationType()
Labels all personally identifiable information (PII) identified in your transcript.
|
String |
contentIdentificationTypeAsString()
Labels all personally identifiable information (PII) identified in your transcript.
|
TranscribeContentRedactionType |
contentRedactionType()
Content redaction is performed at the segment level.
|
String |
contentRedactionTypeAsString()
Content redaction is performed at the segment level.
|
Boolean |
enablePartialResultsStabilization()
Enables partial result stabilization for your transcription.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Boolean |
identifyLanguage()
Enables automatic language identification for your transcription.
|
TranscribeLanguageCode |
languageCode()
Specify the language code that represents the language spoken.
|
String |
languageCodeAsString()
Specify the language code that represents the language spoken.
|
String |
languageModelName()
Specify the name of the custom language model that you want to use when processing your transcription.
|
String |
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.
|
TranscribePartialResultsStability |
partialResultsStability()
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization). |
String |
partialResultsStabilityAsString()
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization). |
String |
piiEntityTypes()
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
|
TranscribeLanguageCode |
preferredLanguage()
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions. |
String |
preferredLanguageAsString()
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions. |
TranscribeRegion |
region()
The AWS Region in which to use Amazon Transcribe.
|
String |
regionAsString()
The AWS Region in which to use Amazon Transcribe.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends EngineTranscribeSettings.Builder> |
serializableBuilderClass() |
EngineTranscribeSettings.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
TranscribeVocabularyFilterMethod |
vocabularyFilterMethod()
Specify how you want your vocabulary filter applied to your transcript.
|
String |
vocabularyFilterMethodAsString()
Specify how you want your vocabulary filter applied to your transcript.
|
String |
vocabularyFilterName()
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
|
String |
vocabularyFilterNames()
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.
|
String |
vocabularyName()
Specify the name of the custom vocabulary that you want to use when processing your transcription.
|
String |
vocabularyNames()
Specify the names of the custom vocabularies that you want to use when processing your transcription.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final TranscribeLanguageCode 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
return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from languageCodeAsString().
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to
enable automatic language identification.
TranscribeLanguageCodepublic final String 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
return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from languageCodeAsString().
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to
enable automatic language identification.
TranscribeLanguageCodepublic final TranscribeVocabularyFilterMethod vocabularyFilterMethod()
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
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 return TranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The
raw value returned by the service is available from vocabularyFilterMethodAsString().
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
TranscribeVocabularyFilterMethodpublic final String vocabularyFilterMethodAsString()
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
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 return TranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The
raw value returned by the service is available from vocabularyFilterMethodAsString().
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
TranscribeVocabularyFilterMethodpublic final String 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 the VocabularyFilterNames parameter instead.
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 the VocabularyFilterNames parameter instead.
public final String 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 the VocabularyNames parameter instead.
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 the VocabularyNames parameter instead.
public final TranscribeRegion region()
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the
MediaRegion, then a TranscriptFailed event is sent.
Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. 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
return TranscribeRegion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
regionAsString().
If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the
MediaRegion, then a TranscriptFailed event is sent.
Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion.
For more information, refer to Choosing
a transcription Region in the Amazon Chime SDK Developer Guide.
TranscribeRegionpublic final String regionAsString()
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the
MediaRegion, then a TranscriptFailed event is sent.
Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. 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
return TranscribeRegion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
regionAsString().
If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the
MediaRegion, then a TranscriptFailed event is sent.
Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion.
For more information, refer to Choosing
a transcription Region in the Amazon Chime SDK Developer Guide.
TranscribeRegionpublic final Boolean enablePartialResultsStabilization()
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
public final TranscribePartialResultsStability 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 return TranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from partialResultsStabilityAsString().
EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
TranscribePartialResultsStabilitypublic final String 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 return TranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from partialResultsStabilityAsString().
EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
TranscribePartialResultsStabilitypublic final TranscribeContentIdentificationType 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 and ContentRedactionType.
If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType will return TranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from contentIdentificationTypeAsString().
PiiEntityTypes, all PII is identified.
You can’t set ContentIdentificationType and ContentRedactionType.
TranscribeContentIdentificationTypepublic final String 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 and ContentRedactionType.
If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType will return TranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from contentIdentificationTypeAsString().
PiiEntityTypes, all PII is identified.
You can’t set ContentIdentificationType and ContentRedactionType.
TranscribeContentIdentificationTypepublic final TranscribeContentRedactionType contentRedactionType()
Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is
redacted.
You can’t set ContentRedactionType and ContentIdentificationType.
If the service returns an enum value that is not available in the current SDK version,
contentRedactionType will return TranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from contentRedactionTypeAsString().
PiiEntityTypes,
all PII is redacted.
You can’t set ContentRedactionType and ContentIdentificationType.
TranscribeContentRedactionTypepublic final String contentRedactionTypeAsString()
Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is
redacted.
You can’t set ContentRedactionType and ContentIdentificationType.
If the service returns an enum value that is not available in the current SDK version,
contentRedactionType will return TranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from contentRedactionTypeAsString().
PiiEntityTypes,
all PII is redacted.
You can’t set ContentRedactionType and ContentIdentificationType.
TranscribeContentRedactionTypepublic final String 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, or ALL.
Note that if you include PiiEntityTypes, you must also include
ContentIdentificationType or ContentRedactionType.
If you include ContentRedactionType or ContentIdentificationType, but do not include
PiiEntityTypes, all PII is redacted or identified.
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, or ALL.
Note that if you include PiiEntityTypes, you must also include
ContentIdentificationType or ContentRedactionType.
If you include ContentRedactionType or ContentIdentificationType, but do not
include PiiEntityTypes, all PII is redacted or identified.
public final String 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.
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.
public final Boolean identifyLanguage()
Enables automatic language identification for your transcription.
If you include IdentifyLanguage, you can optionally use LanguageOptions 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 or IdentifyLanguage.
Language identification can't be combined with custom language models or redaction.
If you include IdentifyLanguage, you can optionally use LanguageOptions 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 or IdentifyLanguage.
Language identification can't be combined with custom language models or redaction.
public final String 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 include IdentifyLanguage.
You can only include one language dialect per language. For example, you cannot include en-US and
en-AU.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions, you must also include IdentifyLanguage.
You can only include one language dialect per language. For example, you cannot include
en-US and en-AU.
public final TranscribeLanguageCode 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 and LanguageOptions.
If the service returns an enum value that is not available in the current SDK version, preferredLanguage
will return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from preferredLanguageAsString().
LanguageOptions.
You can only use this parameter if you include IdentifyLanguage and
LanguageOptions.
TranscribeLanguageCodepublic final String 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 and LanguageOptions.
If the service returns an enum value that is not available in the current SDK version, preferredLanguage
will return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from preferredLanguageAsString().
LanguageOptions.
You can only use this parameter if you include IdentifyLanguage and
LanguageOptions.
TranscribeLanguageCodepublic final String 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 the VocabularyName parameter instead.
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 the VocabularyName parameter instead.
public final String 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 the VocabularyFilterName parameter instead.
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 the VocabularyFilterName parameter instead.
public EngineTranscribeSettings.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>public static EngineTranscribeSettings.Builder builder()
public static Class<? extends EngineTranscribeSettings.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.