Settings
Provides optional settings for the StartTranscriptionJob
operation.
Contents
- ChannelIdentification
-
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
.Type: Boolean
Required: No
- MaxAlternatives
-
The number of alternative transcriptions that the service should return. If you specify the
MaxAlternatives
field, you must set theShowAlternatives
field to true.Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
- MaxSpeakerLabels
-
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the
MaxSpeakerLabels
field, you must set theShowSpeakerLabels
field to true.Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
- ShowAlternatives
-
Determines whether the transcription contains alternative transcriptions. If you set the
ShowAlternatives
field to true, you must also set the maximum number of alternatives to return in theMaxAlternatives
field.Type: Boolean
Required: No
- ShowSpeakerLabels
-
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the
ShowSpeakerLabels
field to true, you must also set the maximum number of speaker labelsMaxSpeakerLabels
field.You can't set both
ShowSpeakerLabels
andChannelIdentification
in the same request. If you set both, your request returns aBadRequestException
.Type: Boolean
Required: No
- VocabularyFilterMethod
-
Set to
mask
to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set toremove
to remove filtered text from the transcript without using placeholder text. Set totag
to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method totag
, the words matching your vocabulary filter are not masked or removed.Type: String
Valid Values:
remove | mask
Required: No
- VocabularyFilterName
-
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- VocabularyName
-
The name of a vocabulary to use when processing the transcription job.
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: