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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxSpeakerLabels() The maximum number of speakers to identify in the input audio.
List<SdkField<?>>	sdkFields()
static Class<? extends Settings.Builder>	serializableBuilderClass()
Boolean	showSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
Settings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vocabularyName() The name of a vocabulary to use when processing the transcription job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

vocabularyName

public 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 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 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 will be 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 will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

channelIdentification

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

toBuilder

public Settings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Settings.Builder,Settings>

Returns:

a builder for type T

builder

public static Settings.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.