AmazonTranscribeCallAnalyticsProcessorConfiguration
A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.
Contents
- LanguageCode
-
The language code in the configuration.
Type: String
Valid Values:
en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR
Required: Yes
- CallAnalyticsStreamCategories
-
By default, all
CategoryEvents
are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- 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 do, 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
andContentIdentificationType
in the same request. If you do, 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
- 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,
UtteranceEvents
withIsPartial: true
are filtered out of the insights target.Type: Boolean
Required: No
- LanguageModelName
-
Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.
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
- PartialResultsStability
-
Specifies 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
-
Specifies 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
.Length Constraints: Minimum length of 1. Maximum length of 300.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
^[A-Z_, ]+
Required: No
- PostCallAnalyticsSettings
-
The settings for a post-call analysis task in an analytics configuration.
Type: PostCallAnalyticsSettings object
Required: No
- VocabularyFilterMethod
-
Specifies how to apply a vocabulary filter to a transcript.
To replace words with ***, choose
mask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
.Type: String
Valid Values:
remove | mask | tag
Required: No
- VocabularyFilterName
-
Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive.
If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.
For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide.
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
- VocabularyName
-
Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive.
If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.
For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: