com.amazonaws.services.transcribe.model

Class Settings

java.lang.Object

com.amazonaws.services.transcribe.model.Settings

All Implemented Interfaces:

java.io.Serializable

public class Settings
extends java.lang.Object
implements java.io.Serializable

Provides optional settings for the StartTranscriptionJob operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getChannelIdentification() Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
java.lang.Integer	getMaxAlternatives() The number of alternative transcriptions that the service should return.
java.lang.Integer	getMaxSpeakerLabels() The maximum number of speakers to identify in the input audio.
java.lang.Boolean	getShowAlternatives() Determines whether the transcription contains alternative transcriptions.
java.lang.Boolean	getShowSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
java.lang.String	getVocabularyFilterMethod() Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
java.lang.String	getVocabularyFilterName() The name of the vocabulary filter to use when transcribing the audio.
java.lang.String	getVocabularyName() The name of a vocabulary to use when processing the transcription job.
int	hashCode()
java.lang.Boolean	isChannelIdentification() Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
java.lang.Boolean	isShowAlternatives() Determines whether the transcription contains alternative transcriptions.
java.lang.Boolean	isShowSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
void	setChannelIdentification(java.lang.Boolean channelIdentification) Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
void	setMaxAlternatives(java.lang.Integer maxAlternatives) The number of alternative transcriptions that the service should return.
void	setMaxSpeakerLabels(java.lang.Integer maxSpeakerLabels) The maximum number of speakers to identify in the input audio.
void	setShowAlternatives(java.lang.Boolean showAlternatives) Determines whether the transcription contains alternative transcriptions.
void	setShowSpeakerLabels(java.lang.Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
void	setVocabularyFilterMethod(java.lang.String vocabularyFilterMethod) Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
void	setVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
void	setVocabularyFilterName(java.lang.String vocabularyFilterName) The name of the vocabulary filter to use when transcribing the audio.
void	setVocabularyName(java.lang.String vocabularyName) The name of a vocabulary to use when processing the transcription job.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Settings	withChannelIdentification(java.lang.Boolean channelIdentification) Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Settings	withMaxAlternatives(java.lang.Integer maxAlternatives) The number of alternative transcriptions that the service should return.
Settings	withMaxSpeakerLabels(java.lang.Integer maxSpeakerLabels) The maximum number of speakers to identify in the input audio.
Settings	withShowAlternatives(java.lang.Boolean showAlternatives) Determines whether the transcription contains alternative transcriptions.
Settings	withShowSpeakerLabels(java.lang.Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
Settings	withVocabularyFilterMethod(java.lang.String vocabularyFilterMethod) Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
Settings	withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
Settings	withVocabularyFilterName(java.lang.String vocabularyFilterName) The name of the vocabulary filter to use when transcribing the audio.
Settings	withVocabularyName(java.lang.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

Constructor Detail

Settings

public Settings()

Method Detail

getVocabularyName

public java.lang.String getVocabularyName()

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

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

setVocabularyName

public void setVocabularyName(java.lang.String vocabularyName)

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

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

withVocabularyName

public Settings withVocabularyName(java.lang.String vocabularyName)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

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

Returns:

A reference to this updated object so that method calls can be chained together.

isShowSpeakerLabels

public java.lang.Boolean isShowSpeakerLabels()

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 .

getShowSpeakerLabels

public java.lang.Boolean getShowSpeakerLabels()

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 .

setShowSpeakerLabels

public void setShowSpeakerLabels(java.lang.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.

Parameters:

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.

withShowSpeakerLabels

public Settings withShowSpeakerLabels(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getMaxSpeakerLabels

public java.lang.Integer getMaxSpeakerLabels()

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.

Constraints:
Range: 2 - 10

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.

setMaxSpeakerLabels

public void setMaxSpeakerLabels(java.lang.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.

Constraints:
Range: 2 - 10

Parameters:

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.

withMaxSpeakerLabels

public Settings withMaxSpeakerLabels(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 2 - 10

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isChannelIdentification

public java.lang.Boolean isChannelIdentification()

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 .

getChannelIdentification

public java.lang.Boolean getChannelIdentification()

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 .

setChannelIdentification

public void setChannelIdentification(java.lang.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.

Parameters:

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.

withChannelIdentification

public Settings withChannelIdentification(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isShowAlternatives

public java.lang.Boolean isShowAlternatives()

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.

getShowAlternatives

public java.lang.Boolean getShowAlternatives()

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.

setShowAlternatives

public void setShowAlternatives(java.lang.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.

Parameters:

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.

withShowAlternatives

public Settings withShowAlternatives(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getMaxAlternatives

public java.lang.Integer getMaxAlternatives()

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

Constraints:
Range: 2 - 10

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.

setMaxAlternatives

public void setMaxAlternatives(java.lang.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.

Constraints:
Range: 2 - 10

Parameters:

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.

withMaxAlternatives

public Settings withMaxAlternatives(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 2 - 10

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getVocabularyFilterName

public java.lang.String getVocabularyFilterName()

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.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

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.

setVocabularyFilterName

public void setVocabularyFilterName(java.lang.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.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

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.

withVocabularyFilterName

public Settings withVocabularyFilterName(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getVocabularyFilterMethod

public java.lang.String getVocabularyFilterMethod()

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.

Constraints:
Allowed Values: remove, mask

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.

See Also:

VocabularyFilterMethod

setVocabularyFilterMethod

public void setVocabularyFilterMethod(java.lang.String 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.

Constraints:
Allowed Values: remove, mask

Parameters:

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.

See Also:

VocabularyFilterMethod

withVocabularyFilterMethod

public Settings withVocabularyFilterMethod(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: remove, mask

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VocabularyFilterMethod

setVocabularyFilterMethod

public void setVocabularyFilterMethod(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.

Constraints:
Allowed Values: remove, mask

Parameters:

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.

See Also:

VocabularyFilterMethod

withVocabularyFilterMethod

public Settings withVocabularyFilterMethod(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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: remove, mask

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VocabularyFilterMethod

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object