software.amazon.awssdk.services.transcribe.model

Interface MedicalTranscriptionSetting.Builder

All Superinterfaces:

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

Enclosing class:

MedicalTranscriptionSetting

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

Method Summary

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

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

showSpeakerLabels

MedicalTranscriptionSetting.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 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 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

MedicalTranscriptionSetting.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

MedicalTranscriptionSetting.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.

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.

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.

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.

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

MedicalTranscriptionSetting.Builder showAlternatives(Boolean showAlternatives)

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

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical 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 include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

For more information, see Alternative transcriptions.

Returns:

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

maxAlternatives

MedicalTranscriptionSetting.Builder maxAlternatives(Integer maxAlternatives)

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

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, 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 Medical to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, 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.

vocabularyName

MedicalTranscriptionSetting.Builder vocabularyName(String vocabularyName)

The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive.

The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

Parameters:

vocabularyName - The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive.

The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

Returns:

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