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>

Optional settings for the StartMedicalTranscriptionJob operation.

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() Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxAlternatives() The maximum number of alternatives that you tell the service to return.
Integer	maxSpeakerLabels() The maximum number of speakers to identify in the input audio.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalTranscriptionSetting.Builder>	serializableBuilderClass()
Boolean	showAlternatives() Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
Boolean	showSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
MedicalTranscriptionSetting.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyName() The name of the vocabulary to use when processing a 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()

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 labels in the MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

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 labels in the MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

maxSpeakerLabels

public final Integer 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 the ShowSpeakerLabels field to true.

Returns:

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 the ShowSpeakerLabels field to true.

channelIdentification

public final Boolean channelIdentification()

Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe Medical 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 item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException

Returns:

Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe Medical 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 item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException

showAlternatives

public final Boolean showAlternatives()

Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Returns:

Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

maxAlternatives

public final Integer maxAlternatives()

The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Returns:

The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

vocabularyName

public final String vocabularyName()

The name of the vocabulary to use when processing a medical transcription job.

Returns:

The name of the vocabulary to use when processing a medical transcription job.

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