software.amazon.awssdk.services.transcribe.model

Class Settings

java.lang.Object

software.amazon.awssdk.services.transcribe.model.Settings

All Implemented Interfaces:

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

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

Provides optional settings for the StartTranscriptionJob operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Settings.Builder

Method Summary

Modifier and Type	Method and Description
static Settings.Builder	builder()
Boolean	channelIdentification() Instructs Amazon Transcribe 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 number of alternative transcriptions that the service should return.
Integer	maxSpeakerLabels() The maximum number of speakers to identify in the input audio.
List<SdkField<?>>	sdkFields()
static Class<? extends Settings.Builder>	serializableBuilderClass()
Boolean	showAlternatives() Determines whether the transcription contains alternative transcriptions.
Boolean	showSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
Settings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod() Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
String	vocabularyFilterMethodAsString() Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
String	vocabularyFilterName() The name of the vocabulary filter to use when transcribing the audio.
String	vocabularyName() The name of a vocabulary to use when processing the 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

vocabularyName

public final String vocabularyName()

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

Returns:

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

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 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 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 to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe 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 the item including the confidence that Amazon Transcribe has in the transcription.

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 to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe 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 the item including the confidence that Amazon Transcribe has in the transcription.

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 the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Returns:

Determines whether the transcription contains alternative transcriptions. If you set the 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 number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Returns:

The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

vocabularyFilterName

public final String vocabularyFilterName()

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Returns:

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

vocabularyFilterMethod

public final VocabularyFilterMethod vocabularyFilterMethod()

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

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:

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

See Also:

VocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

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:

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

See Also:

VocabularyFilterMethod

toBuilder

public Settings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Settings.Builder,Settings>

builder

public static Settings.Builder builder()

serializableBuilderClass

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