MedicalTranscriptionSetting (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transcribe.model.MedicalTranscriptionSetting

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MedicalTranscriptionSetting
extends Object
implements Serializable, Cloneable, StructuredPojo

Optional settings for the StartMedicalTranscriptionJob operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MedicalTranscriptionSetting()

Constructors
Constructor and Description
`MedicalTranscriptionSetting()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MedicalTranscriptionSetting`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`Integer`	`getMaxAlternatives()` The maximum number of alternatives that you tell the service to return.
`Integer`	`getMaxSpeakerLabels()` The maximum number of speakers to identify in the input audio.
`Boolean`	`getShowAlternatives()` Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
`Boolean`	`getShowSpeakerLabels()` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`String`	`getVocabularyName()` The name of the vocabulary to use when processing a medical transcription job.
`int`	`hashCode()`
`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.
`Boolean`	`isShowAlternatives()` Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
`Boolean`	`isShowSpeakerLabels()` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelIdentification(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(Integer maxAlternatives)` The maximum number of alternatives that you tell the service to return.
`void`	`setMaxSpeakerLabels(Integer maxSpeakerLabels)` The maximum number of speakers to identify in the input audio.
`void`	`setShowAlternatives(Boolean showAlternatives)` Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
`void`	`setShowSpeakerLabels(Boolean showSpeakerLabels)` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`void`	`setVocabularyName(String vocabularyName)` The name of the vocabulary to use when processing a medical transcription job.
`String`	`toString()` Returns a string representation of this object.
`MedicalTranscriptionSetting`	`withChannelIdentification(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(Integer maxAlternatives)` The maximum number of alternatives that you tell the service to return.
`MedicalTranscriptionSetting`	`withMaxSpeakerLabels(Integer maxSpeakerLabels)` The maximum number of speakers to identify in the input audio.
`MedicalTranscriptionSetting`	`withShowAlternatives(Boolean showAlternatives)` Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
`MedicalTranscriptionSetting`	`withShowSpeakerLabels(Boolean showSpeakerLabels)` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`MedicalTranscriptionSetting`	`withVocabularyName(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
  - setShowSpeakerLabels
```
public void setShowSpeakerLabels(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.
  - getShowSpeakerLabels
```
public 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.
  - withShowSpeakerLabels
```
public MedicalTranscriptionSetting withShowSpeakerLabels(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowSpeakerLabels
```
public 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.
  - setMaxSpeakerLabels
```
public void setMaxSpeakerLabels(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.
    
    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.
  - getMaxSpeakerLabels
```
public 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.
    
    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.
  - withMaxSpeakerLabels
```
public MedicalTranscriptionSetting withMaxSpeakerLabels(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelIdentification
```
public void setChannelIdentification(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
  - getChannelIdentification
```
public 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
  - withChannelIdentification
```
public MedicalTranscriptionSetting withChannelIdentification(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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isChannelIdentification
```
public 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
  - setShowAlternatives
```
public void setShowAlternatives(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.
  - getShowAlternatives
```
public 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.
  - withShowAlternatives
```
public MedicalTranscriptionSetting withShowAlternatives(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowAlternatives
```
public 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.
  - setMaxAlternatives
```
public void setMaxAlternatives(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.
    
    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.
  - getMaxAlternatives
```
public 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.
    
    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.
  - withMaxAlternatives
```
public MedicalTranscriptionSetting withMaxAlternatives(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVocabularyName
```
public void setVocabularyName(String vocabularyName)
```
    The name of the vocabulary to use when processing a medical transcription job.
    
    Parameters:
    
    vocabularyName - The name of the vocabulary to use when processing a medical transcription job.
  - getVocabularyName
```
public String getVocabularyName()
```
    The name of the vocabulary to use when processing a medical transcription job.
    
    Returns:
    
    The name of the vocabulary to use when processing a medical transcription job.
  - withVocabularyName
```
public MedicalTranscriptionSetting withVocabularyName(String vocabularyName)
```
    The name of the vocabulary to use when processing a medical transcription job.
    
    Parameters:
    
    vocabularyName - The name of the vocabulary to use when processing a medical transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MedicalTranscriptionSetting clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MedicalTranscriptionSetting

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MedicalTranscriptionSetting

Method Detail

setShowSpeakerLabels

getShowSpeakerLabels

withShowSpeakerLabels

isShowSpeakerLabels

setMaxSpeakerLabels

getMaxSpeakerLabels

withMaxSpeakerLabels

setChannelIdentification

getChannelIdentification

withChannelIdentification

isChannelIdentification

setShowAlternatives

getShowAlternatives

withShowAlternatives

isShowAlternatives

setMaxAlternatives

getMaxAlternatives

withMaxAlternatives

setVocabularyName

getVocabularyName

withVocabularyName

toString

equals

hashCode

clone

marshall