software.amazon.awssdk.services.transcribe.model

Interface Settings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Settings.Builder,Settings>, SdkBuilder<Settings.Builder,Settings>, SdkPojo

Enclosing class:

Settings

public static interface Settings.Builder
extends SdkPojo, CopyableBuilder<Settings.Builder,Settings>

Method Summary

Modifier and Type	Method and Description
Settings.Builder	channelIdentification(Boolean channelIdentification) Enables channel identification in multi-channel audio.
Settings.Builder	maxAlternatives(Integer maxAlternatives) Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
Settings.Builder	maxSpeakerLabels(Integer maxSpeakerLabels) Specify the maximum number of speakers you want to partition in your media.
Settings.Builder	showAlternatives(Boolean showAlternatives) To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
Settings.Builder	showSpeakerLabels(Boolean showSpeakerLabels) Enables speaker partitioning (diarization) in your transcription output.
Settings.Builder	vocabularyFilterMethod(String vocabularyFilterMethod) Specify how you want your custom vocabulary filter applied to your transcript.
Settings.Builder	vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) Specify how you want your custom vocabulary filter applied to your transcript.
Settings.Builder	vocabularyFilterName(String vocabularyFilterName) The name of the custom vocabulary filter you want to use in your transcription job request.
Settings.Builder	vocabularyName(String vocabularyName) The name of the custom vocabulary you want to use in your transcription job request.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

vocabularyName

Settings.Builder vocabularyName(String 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 Amazon Web Services account.

Parameters:

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 Amazon Web Services account.

Returns:

Returns a reference to this object so that method calls can be chained together.

showSpeakerLabels

Settings.Builder showSpeakerLabels(Boolean showSpeakerLabels)

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning 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 Partitioning speakers (diarization).

Parameters:

showSpeakerLabels - Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning 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 Partitioning speakers (diarization).

Returns:

Returns a reference to this object so that method calls can be chained together.

maxSpeakerLabels

Settings.Builder maxSpeakerLabels(Integer maxSpeakerLabels)

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

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

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

Parameters:

maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your media.

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

channelIdentification

Settings.Builder channelIdentification(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

showAlternatives

Settings.Builder showAlternatives(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxAlternatives

Settings.Builder maxAlternatives(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

vocabularyFilterName

Settings.Builder vocabularyFilterName(String 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 Amazon Web Services account.

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

Parameters:

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 Amazon Web Services account.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

vocabularyFilterMethod

Settings.Builder vocabularyFilterMethod(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VocabularyFilterMethod, VocabularyFilterMethod

vocabularyFilterMethod

Settings.Builder vocabularyFilterMethod(VocabularyFilterMethod 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VocabularyFilterMethod, VocabularyFilterMethod