AmazonTranscribeProcessorConfiguration
A structure that contains the configuration settings for an Amazon Transcribe processor.
Note
Calls to this API must include a LanguageCode
, IdentifyLanguage
, or IdentifyMultipleLanguages
parameter.
If you include more than one of those parameters, your transcription job fails.
Contents
- ContentIdentificationType
-
Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in
PiiEntityTypes
is flagged upon complete transcription of an audio segment.You can’t set
ContentIdentificationType
andContentRedactionType
in the same request. If you set both, your request returns aBadRequestException
.For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
Type: String
Valid Values:
PII
Required: No
- ContentRedactionType
-
Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a
BadRequestException
.For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
Type: String
Valid Values:
PII
Required: No
- EnablePartialResultsStabilization
-
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
Type: Boolean
Required: No
- FilterPartialResults
-
If true,
TranscriptEvents
withIsPartial: true
are filtered out of the insights target.Type: Boolean
Required: No
- IdentifyLanguage
-
Turns language identification on or off.
Type: Boolean
Required: No
- IdentifyMultipleLanguages
-
Turns language identification on or off for multiple languages.
Note
Calls to this API must include a
LanguageCode
,IdentifyLanguage
, orIdentifyMultipleLanguages
parameter. If you include more than one of those parameters, your transcription job fails.Type: Boolean
Required: No
- LanguageCode
-
The language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using
IdentifyLanguage
to enable automatic language identification.For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.
Type: String
Valid Values:
en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR
Required: No
- LanguageModelName
-
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 you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
For more information, see Custom language models in the Amazon Transcribe Developer Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- LanguageOptions
-
The language options for the transcription, such as automatic language detection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[a-zA-Z-,]+
Required: No
- PartialResultsStability
-
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.
For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
Type: String
Valid Values:
high | medium | low
Required: No
- PiiEntityTypes
-
The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select
ALL
.To include
PiiEntityTypes
in your Call Analytics request, you must also includeContentIdentificationType
orContentRedactionType
, but you can't include both.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
.If you leave this parameter empty, the default behavior is equivalent to
ALL
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
^[A-Z_, ]+
Required: No
- PreferredLanguage
-
The preferred language for the transcription.
Type: String
Valid Values:
en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR
Required: No
- ShowSpeakerLabel
-
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide.
Type: Boolean
Required: No
- VocabularyFilterMethod
-
The vocabulary filtering method used in your Call Analytics transcription.
Type: String
Valid Values:
remove | mask | tag
Required: No
- VocabularyFilterName
-
The name of the custom vocabulary filter that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- VocabularyFilterNames
-
The names of the custom vocabulary filter or filters using during transcription.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
^[a-zA-Z0-9,-._]+
Required: No
- VocabularyName
-
The name of the custom vocabulary that you specified in your Call Analytics request.
Length Constraints: Minimum length of 1. Maximum length of 200.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- VocabularyNames
-
The names of the custom vocabulary or vocabularies used during transcription.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
^[a-zA-Z0-9,-._]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: