Package software.amazon.awssdk.services.transcribe.model

Class MedicalScribeSettings

java.lang.Object

software.amazon.awssdk.services.transcribe.model.MedicalScribeSettings

All Implemented Interfaces:

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

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

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MedicalScribeSettings.Builder

Method Summary

Modifier and Type	Method	Description
static MedicalScribeSettings.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	maxSpeakerLabels()	Specify the maximum number of speakers you want to partition in your media.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalScribeSettings.Builder>	serializableBuilderClass()
Boolean	showSpeakerLabels()	Enables speaker partitioning (diarization) in your Medical Scribe output.
MedicalScribeSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod()	Specify how you want your custom vocabulary filter applied to your transcript.
String	vocabularyFilterMethodAsString()	Specify how you want your custom vocabulary filter applied to your transcript.
String	vocabularyFilterName()	The name of the custom vocabulary filter you want to include in your Medical Scribe request.
String	vocabularyName()	The name of the custom vocabulary you want to include in your Medical Scribe request.

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 partitioning (diarization) in your Medical Scribe 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 .

For more information, see Partitioning speakers (diarization).

Returns:

Enables speaker partitioning (diarization) in your Medical Scribe 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.

For more information, see Partitioning speakers (diarization).

maxSpeakerLabels

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

Returns:

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.

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.

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.

For more information, see Transcribing multi-channel audio.

vocabularyName

public final String vocabularyName()

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

Returns:

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

vocabularyFilterName

public final String vocabularyFilterName()

The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

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

Returns:

The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

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

vocabularyFilterMethod

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

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

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.

See Also:

VocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

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.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

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.

See Also:

VocabularyFilterMethod

toBuilder

public MedicalScribeSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeSettings.Builder,MedicalScribeSettings>

builder

public static MedicalScribeSettings.Builder builder()

serializableBuilderClass

public static Class<? extends MedicalScribeSettings.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