Settings - Transcribe

Settings

Allows additional optional settings in your StartTranscriptionJob request, including channel identification, alternative transcriptions, and speaker labeling. You can use that to apply custom vocabularies to your transcription job.

Contents

ChannelIdentification

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Transcribing multi-channel audio.

Type: Boolean

Required: No

MaxAlternatives

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: No

MaxSpeakerLabels

Specify the maximum number of speakers you want to identify in your media.

Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: No

ShowAlternatives

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

For more information, see Alternative transcriptions.

Type: Boolean

Required: No

ShowSpeakerLabels

Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Identifying speakers (diarization).

Type: Boolean

Required: No

VocabularyFilterMethod

Specify how you want your custom 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.

Type: String

Valid Values: remove | mask | tag

Required: No

VocabularyFilterName

The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No

VocabularyName

The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.

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: