com.amazonaws.services.transcribe.model

Class MedicalTranscriptionSetting

java.lang.Object

com.amazonaws.services.transcribe.model.MedicalTranscriptionSetting

All Implemented Interfaces:

java.io.Serializable

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

Optional settings for the StartMedicalTranscriptionJob operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MedicalTranscriptionSetting()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getChannelIdentification() Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
java.lang.Integer	getMaxAlternatives() The maximum number of alternatives that you tell the service to return.
java.lang.Integer	getMaxSpeakerLabels() The maximum number of speakers to identify in the input audio.
java.lang.Boolean	getShowAlternatives() Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
java.lang.Boolean	getShowSpeakerLabels() Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
java.lang.String	getVocabularyName() The name of the vocabulary to use when processing a medical transcription job.
int	hashCode()
java.lang.Boolean	isChannelIdentification() Instructs Amazon Transcribe Medical 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 alternative transcripts are generated along with the transcript that has the highest confidence.
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 Medical 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 maximum number of alternatives that you tell the service to 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 alternative transcripts are generated along with the transcript that has the highest confidence.
void	setShowSpeakerLabels(java.lang.Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
void	setVocabularyName(java.lang.String vocabularyName) The name of the vocabulary to use when processing a medical transcription job.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
MedicalTranscriptionSetting	withChannelIdentification(java.lang.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.
MedicalTranscriptionSetting	withMaxAlternatives(java.lang.Integer maxAlternatives) The maximum number of alternatives that you tell the service to return.
MedicalTranscriptionSetting	withMaxSpeakerLabels(java.lang.Integer maxSpeakerLabels) The maximum number of speakers to identify in the input audio.
MedicalTranscriptionSetting	withShowAlternatives(java.lang.Boolean showAlternatives) Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
MedicalTranscriptionSetting	withShowSpeakerLabels(java.lang.Boolean showSpeakerLabels) Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
MedicalTranscriptionSetting	withVocabularyName(java.lang.String vocabularyName) The name of the vocabulary to use when processing a medical transcription job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MedicalTranscriptionSetting

public MedicalTranscriptionSetting()

Method Detail

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

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

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

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

withShowSpeakerLabels

public MedicalTranscriptionSetting 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 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 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 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:

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 MedicalTranscriptionSetting 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 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

getChannelIdentification

public java.lang.Boolean getChannelIdentification()

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

setChannelIdentification

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

Parameters:

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

withChannelIdentification

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

Parameters:

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:

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

isShowAlternatives

public java.lang.Boolean isShowAlternatives()

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.

getShowAlternatives

public java.lang.Boolean getShowAlternatives()

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.

setShowAlternatives

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

Parameters:

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.

withShowAlternatives

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

Parameters:

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:

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

getMaxAlternatives

public java.lang.Integer getMaxAlternatives()

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.

Constraints:
Range: 2 - 10

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.

setMaxAlternatives

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

Constraints:
Range: 2 - 10

Parameters:

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.

withMaxAlternatives

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

Constraints:
Range: 2 - 10

Parameters:

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:

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

getVocabularyName

public java.lang.String getVocabularyName()

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

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

Returns:

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

setVocabularyName

public void setVocabularyName(java.lang.String vocabularyName)

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

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

Parameters:

vocabularyName -

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

withVocabularyName

public MedicalTranscriptionSetting withVocabularyName(java.lang.String vocabularyName)

The name of the vocabulary to use when processing a medical 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 the vocabulary to use when processing a medical transcription job.

Returns:

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

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