software.amazon.awssdk.services.transcribe.model

Class MedicalTranscriptionSetting

java.lang.Object

software.amazon.awssdk.services.transcribe.model.MedicalTranscriptionSetting

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>

@Generated(value="software.amazon.awssdk:codegen")
public final class MedicalTranscriptionSetting
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MedicalTranscriptionSetting.Builder

Method Summary

Modifier and Type	Method and Description
static MedicalTranscriptionSetting.Builder	builder()
Boolean	channelIdentification() Enables channel identification in multi-channel audio.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxAlternatives() Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
Integer	maxSpeakerLabels() Specify the maximum number of speakers you want to identify in your media.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalTranscriptionSetting.Builder>	serializableBuilderClass()
Boolean	showAlternatives() To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
Boolean	showSpeakerLabels() Enables speaker identification (diarization) in your transcription output.
MedicalTranscriptionSetting.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyName() The name of the custom vocabulary you want to use when processing your medical transcription job.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

showSpeakerLabels

public final Boolean 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).

Returns:

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

maxSpeakerLabels

public final Integer 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.

Returns:

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.

channelIdentification

public final 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.

Returns:

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.

showAlternatives

public final 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.

Returns:

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.

maxAlternatives

public final 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.

Returns:

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.

vocabularyName

public final String vocabularyName()

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

The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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:

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

The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the 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.

toBuilder

public MedicalTranscriptionSetting.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>

builder

public static MedicalTranscriptionSetting.Builder builder()

serializableBuilderClass

public static Class<? extends MedicalTranscriptionSetting.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo