@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EngineTranscribeSettings extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
EngineTranscribeSettings() |
Modifier and Type | Method and Description |
---|---|
EngineTranscribeSettings |
clone() |
boolean |
equals(Object obj) |
String |
getContentIdentificationType()
Labels all personally identifiable information (PII) identified in your transcript.
|
String |
getContentRedactionType()
Content redaction is performed at the segment level.
|
Boolean |
getEnablePartialResultsStabilization()
Enables partial result stabilization for your transcription.
|
Boolean |
getIdentifyLanguage()
Enables automatic language identification for your transcription.
|
String |
getLanguageCode()
Specify the language code that represents the language spoken.
|
String |
getLanguageModelName()
Specify the name of the custom language model that you want to use when processing your transcription.
|
String |
getLanguageOptions()
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.
|
String |
getPartialResultsStability()
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization ). |
String |
getPiiEntityTypes()
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
|
String |
getPreferredLanguage()
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions . |
String |
getRegion()
The Amazon Web Services Region in which to use Amazon Transcribe.
|
String |
getVocabularyFilterMethod()
Specify how you want your vocabulary filter applied to your transcript.
|
String |
getVocabularyFilterName()
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
|
String |
getVocabularyFilterNames()
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.
|
String |
getVocabularyName()
Specify the name of the custom vocabulary that you want to use when processing your transcription.
|
String |
getVocabularyNames()
Specify the names of the custom vocabularies that you want to use when processing your transcription.
|
int |
hashCode() |
Boolean |
isEnablePartialResultsStabilization()
Enables partial result stabilization for your transcription.
|
Boolean |
isIdentifyLanguage()
Enables automatic language identification for your transcription.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setContentIdentificationType(String contentIdentificationType)
Labels all personally identifiable information (PII) identified in your transcript.
|
void |
setContentRedactionType(String contentRedactionType)
Content redaction is performed at the segment level.
|
void |
setEnablePartialResultsStabilization(Boolean enablePartialResultsStabilization)
Enables partial result stabilization for your transcription.
|
void |
setIdentifyLanguage(Boolean identifyLanguage)
Enables automatic language identification for your transcription.
|
void |
setLanguageCode(String languageCode)
Specify the language code that represents the language spoken.
|
void |
setLanguageModelName(String languageModelName)
Specify the name of the custom language model that you want to use when processing your transcription.
|
void |
setLanguageOptions(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.
|
void |
setPartialResultsStability(String partialResultsStability)
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization ). |
void |
setPiiEntityTypes(String piiEntityTypes)
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
|
void |
setPreferredLanguage(String preferredLanguage)
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions . |
void |
setRegion(String region)
The Amazon Web Services Region in which to use Amazon Transcribe.
|
void |
setVocabularyFilterMethod(String vocabularyFilterMethod)
Specify how you want your vocabulary filter applied to your transcript.
|
void |
setVocabularyFilterName(String vocabularyFilterName)
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
|
void |
setVocabularyFilterNames(String vocabularyFilterNames)
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.
|
void |
setVocabularyName(String vocabularyName)
Specify the name of the custom vocabulary that you want to use when processing your transcription.
|
void |
setVocabularyNames(String vocabularyNames)
Specify the names of the custom vocabularies that you want to use when processing your transcription.
|
String |
toString()
Returns a string representation of this object.
|
EngineTranscribeSettings |
withContentIdentificationType(String contentIdentificationType)
Labels all personally identifiable information (PII) identified in your transcript.
|
EngineTranscribeSettings |
withContentIdentificationType(TranscribeContentIdentificationType contentIdentificationType)
Labels all personally identifiable information (PII) identified in your transcript.
|
EngineTranscribeSettings |
withContentRedactionType(String contentRedactionType)
Content redaction is performed at the segment level.
|
EngineTranscribeSettings |
withContentRedactionType(TranscribeContentRedactionType contentRedactionType)
Content redaction is performed at the segment level.
|
EngineTranscribeSettings |
withEnablePartialResultsStabilization(Boolean enablePartialResultsStabilization)
Enables partial result stabilization for your transcription.
|
EngineTranscribeSettings |
withIdentifyLanguage(Boolean identifyLanguage)
Enables automatic language identification for your transcription.
|
EngineTranscribeSettings |
withLanguageCode(String languageCode)
Specify the language code that represents the language spoken.
|
EngineTranscribeSettings |
withLanguageCode(TranscribeLanguageCode languageCode)
Specify the language code that represents the language spoken.
|
EngineTranscribeSettings |
withLanguageModelName(String languageModelName)
Specify the name of the custom language model that you want to use when processing your transcription.
|
EngineTranscribeSettings |
withLanguageOptions(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.
|
EngineTranscribeSettings |
withPartialResultsStability(String partialResultsStability)
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization ). |
EngineTranscribeSettings |
withPartialResultsStability(TranscribePartialResultsStability partialResultsStability)
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization ). |
EngineTranscribeSettings |
withPiiEntityTypes(String piiEntityTypes)
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
|
EngineTranscribeSettings |
withPreferredLanguage(String preferredLanguage)
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions . |
EngineTranscribeSettings |
withPreferredLanguage(TranscribeLanguageCode preferredLanguage)
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions . |
EngineTranscribeSettings |
withRegion(String region)
The Amazon Web Services Region in which to use Amazon Transcribe.
|
EngineTranscribeSettings |
withRegion(TranscribeRegion region)
The Amazon Web Services Region in which to use Amazon Transcribe.
|
EngineTranscribeSettings |
withVocabularyFilterMethod(String vocabularyFilterMethod)
Specify how you want your vocabulary filter applied to your transcript.
|
EngineTranscribeSettings |
withVocabularyFilterMethod(TranscribeVocabularyFilterMethod vocabularyFilterMethod)
Specify how you want your vocabulary filter applied to your transcript.
|
EngineTranscribeSettings |
withVocabularyFilterName(String vocabularyFilterName)
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
|
EngineTranscribeSettings |
withVocabularyFilterNames(String vocabularyFilterNames)
Specify the names of the custom vocabulary filters that you want to use when processing your transcription.
|
EngineTranscribeSettings |
withVocabularyName(String vocabularyName)
Specify the name of the custom vocabulary that you want to use when processing your transcription.
|
EngineTranscribeSettings |
withVocabularyNames(String vocabularyNames)
Specify the names of the custom vocabularies that you want to use when processing your transcription.
|
public void setLanguageCode(String 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.
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.
TranscribeLanguageCode
public String getLanguageCode()
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 you're unsure of the language spoken in your audio, consider using IdentifyLanguage
to
enable automatic language identification.
TranscribeLanguageCode
public EngineTranscribeSettings withLanguageCode(String 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.
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.
TranscribeLanguageCode
public EngineTranscribeSettings withLanguageCode(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.
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.
TranscribeLanguageCode
public void setVocabularyFilterMethod(String 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
.
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
.
TranscribeVocabularyFilterMethod
public String getVocabularyFilterMethod()
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
.
To replace words with ***
, choose mask
.
To delete words, choose remove
.
To flag words without changing them, choose tag
.
TranscribeVocabularyFilterMethod
public EngineTranscribeSettings withVocabularyFilterMethod(String 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
.
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
.
TranscribeVocabularyFilterMethod
public EngineTranscribeSettings withVocabularyFilterMethod(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
.
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
.
TranscribeVocabularyFilterMethod
public void setVocabularyFilterName(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.
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.
public String getVocabularyFilterName()
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 EngineTranscribeSettings withVocabularyFilterName(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.
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.
public void setVocabularyName(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.
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.
public String getVocabularyName()
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 EngineTranscribeSettings withVocabularyName(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.
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.
public void setRegion(String region)
The Amazon Web Services 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.
region
- The Amazon Web Services 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.
TranscribeRegion
public String getRegion()
The Amazon Web Services 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 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.
TranscribeRegion
public EngineTranscribeSettings withRegion(String region)
The Amazon Web Services 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.
region
- The Amazon Web Services 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.
TranscribeRegion
public EngineTranscribeSettings withRegion(TranscribeRegion region)
The Amazon Web Services 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.
region
- The Amazon Web Services 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.
TranscribeRegion
public void setEnablePartialResultsStabilization(Boolean enablePartialResultsStabilization)
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
enablePartialResultsStabilization
- Enables partial result stabilization for your transcription. Partial result stabilization can reduce
latency in your output, but may impact accuracy.public Boolean getEnablePartialResultsStabilization()
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
public EngineTranscribeSettings withEnablePartialResultsStabilization(Boolean enablePartialResultsStabilization)
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
enablePartialResultsStabilization
- Enables partial result stabilization for your transcription. Partial result stabilization can reduce
latency in your output, but may impact accuracy.public Boolean isEnablePartialResultsStabilization()
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
public void setPartialResultsStability(String 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.
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.
TranscribePartialResultsStability
public String getPartialResultsStability()
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.
EnablePartialResultsStabilization
).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
TranscribePartialResultsStability
public EngineTranscribeSettings withPartialResultsStability(String 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.
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.
TranscribePartialResultsStability
public EngineTranscribeSettings withPartialResultsStability(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.
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.
TranscribePartialResultsStability
public void setContentIdentificationType(String 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
.
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
.
TranscribeContentIdentificationType
public String getContentIdentificationType()
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
.
PiiEntityTypes
, all PII is identified.
You can’t set ContentIdentificationType
and ContentRedactionType
.
TranscribeContentIdentificationType
public EngineTranscribeSettings withContentIdentificationType(String 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
.
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
.
TranscribeContentIdentificationType
public EngineTranscribeSettings withContentIdentificationType(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
.
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
.
TranscribeContentIdentificationType
public void setContentRedactionType(String 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
.
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
.
TranscribeContentRedactionType
public String getContentRedactionType()
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
.
PiiEntityTypes
,
all PII is redacted.
You can’t set ContentRedactionType
and ContentIdentificationType
.
TranscribeContentRedactionType
public EngineTranscribeSettings withContentRedactionType(String 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
.
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
.
TranscribeContentRedactionType
public EngineTranscribeSettings withContentRedactionType(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
.
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
.
TranscribeContentRedactionType
public void setPiiEntityTypes(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.
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.
public String getPiiEntityTypes()
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 EngineTranscribeSettings withPiiEntityTypes(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.
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.
public void setLanguageModelName(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.
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.
public String getLanguageModelName()
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 EngineTranscribeSettings withLanguageModelName(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.
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.
public void setIdentifyLanguage(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.
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.
public Boolean getIdentifyLanguage()
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 EngineTranscribeSettings withIdentifyLanguage(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.
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.
public Boolean isIdentifyLanguage()
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 void setLanguageOptions(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
.
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
.
public String getLanguageOptions()
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 EngineTranscribeSettings withLanguageOptions(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
.
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
.
public void setPreferredLanguage(String 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
.
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
.
TranscribeLanguageCode
public String getPreferredLanguage()
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
.
LanguageOptions
.
You can only use this parameter if you include IdentifyLanguage
and
LanguageOptions
.
TranscribeLanguageCode
public EngineTranscribeSettings withPreferredLanguage(String 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
.
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
.
TranscribeLanguageCode
public EngineTranscribeSettings withPreferredLanguage(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
.
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
.
TranscribeLanguageCode
public void setVocabularyNames(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.
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.
public String getVocabularyNames()
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 EngineTranscribeSettings withVocabularyNames(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.
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.
public void setVocabularyFilterNames(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.
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.
public String getVocabularyFilterNames()
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 withVocabularyFilterNames(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.
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.
public String toString()
toString
in class Object
Object.toString()
public EngineTranscribeSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.