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
```
Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

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()` Enables channel identification in multi-channel audio.
`Integer`	`getMaxAlternatives()` Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
`Integer`	`getMaxSpeakerLabels()` Specify the maximum number of speakers you want to identify in your media.
`Boolean`	`getShowAlternatives()` To include alternative transcriptions within your transcription output, include `ShowAlternatives` in your transcription request.
`Boolean`	`getShowSpeakerLabels()` Enables speaker identification (diarization) in your transcription output.
`String`	`getVocabularyName()` The name of the custom vocabulary you want to use when processing your medical transcription job.
`int`	`hashCode()`
`Boolean`	`isChannelIdentification()` Enables channel identification in multi-channel audio.
`Boolean`	`isShowAlternatives()` To include alternative transcriptions within your transcription output, include `ShowAlternatives` in your transcription request.
`Boolean`	`isShowSpeakerLabels()` Enables speaker identification (diarization) in your transcription output.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelIdentification(Boolean channelIdentification)` Enables channel identification in multi-channel audio.
`void`	`setMaxAlternatives(Integer maxAlternatives)` Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
`void`	`setMaxSpeakerLabels(Integer maxSpeakerLabels)` Specify the maximum number of speakers you want to identify in your media.
`void`	`setShowAlternatives(Boolean showAlternatives)` To include alternative transcriptions within your transcription output, include `ShowAlternatives` in your transcription request.
`void`	`setShowSpeakerLabels(Boolean showSpeakerLabels)` Enables speaker identification (diarization) in your transcription output.
`void`	`setVocabularyName(String vocabularyName)` The name of the custom vocabulary you want to use when processing your medical transcription job.
`String`	`toString()` Returns a string representation of this object.
`MedicalTranscriptionSetting`	`withChannelIdentification(Boolean channelIdentification)` Enables channel identification in multi-channel audio.
`MedicalTranscriptionSetting`	`withMaxAlternatives(Integer maxAlternatives)` Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
`MedicalTranscriptionSetting`	`withMaxSpeakerLabels(Integer maxSpeakerLabels)` Specify the maximum number of speakers you want to identify in your media.
`MedicalTranscriptionSetting`	`withShowAlternatives(Boolean showAlternatives)` To include alternative transcriptions within your transcription output, include `ShowAlternatives` in your transcription request.
`MedicalTranscriptionSetting`	`withShowSpeakerLabels(Boolean showSpeakerLabels)` Enables speaker identification (diarization) in your transcription output.
`MedicalTranscriptionSetting`	`withVocabularyName(String vocabularyName)` The name of the custom vocabulary you want to use when processing your 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)
```
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
    
    Parameters:
    
    showSpeakerLabels - Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
  - getShowSpeakerLabels
```
public Boolean getShowSpeakerLabels()
```
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
    
    Returns:
    
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
  - withShowSpeakerLabels
```
public MedicalTranscriptionSetting withShowSpeakerLabels(Boolean showSpeakerLabels)
```
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
    
    Parameters:
    
    showSpeakerLabels - Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowSpeakerLabels
```
public Boolean isShowSpeakerLabels()
```
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
    
    Returns:
    
    Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Identifying speakers (diarization).
  - setMaxSpeakerLabels
```
public void setMaxSpeakerLabels(Integer maxSpeakerLabels)
```
    Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
    
    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Parameters:
    
    maxSpeakerLabels - Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
    
    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
  - getMaxSpeakerLabels
```
public Integer getMaxSpeakerLabels()
```
    Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified 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:
    
    Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers will be 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)
```
    Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
    
    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Parameters:
    
    maxSpeakerLabels - Specify the maximum number of speakers you want to identify in your media.
    
    Note that if your media contains more speakers than the specified 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelIdentification
```
public void setChannelIdentification(Boolean channelIdentification)
```
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
    
    Parameters:
    
    channelIdentification - Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
  - getChannelIdentification
```
public Boolean getChannelIdentification()
```
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
    
    Returns:
    
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
  - withChannelIdentification
```
public MedicalTranscriptionSetting withChannelIdentification(Boolean channelIdentification)
```
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
    
    Parameters:
    
    channelIdentification - Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isChannelIdentification
```
public Boolean isChannelIdentification()
```
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
    
    Returns:
    
    Enables channel identification in multi-channel audio.
    
    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
    
    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
    
    You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
    
    For more information, see Transcribing multi-channel audio.
  - setShowAlternatives
```
public void setShowAlternatives(Boolean showAlternatives)
```
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
    
    Parameters:
    
    showAlternatives - To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
  - getShowAlternatives
```
public Boolean getShowAlternatives()
```
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
    
    Returns:
    
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
  - withShowAlternatives
```
public MedicalTranscriptionSetting withShowAlternatives(Boolean showAlternatives)
```
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
    
    Parameters:
    
    showAlternatives - To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowAlternatives
```
public Boolean isShowAlternatives()
```
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
    
    Returns:
    
    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
    
    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
    
    For more information, see Alternative transcriptions.
  - setMaxAlternatives
```
public void setMaxAlternatives(Integer maxAlternatives)
```
    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
    
    Parameters:
    
    maxAlternatives - Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
  - getMaxAlternatives
```
public Integer getMaxAlternatives()
```
    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
    
    Returns:
    
    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
  - withMaxAlternatives
```
public MedicalTranscriptionSetting withMaxAlternatives(Integer maxAlternatives)
```
    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
    
    Parameters:
    
    maxAlternatives - Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
    
    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
    
    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
    
    For more information, see Alternative transcriptions.
    
    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 custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
    
    Parameters:
    
    vocabularyName - The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
  - getVocabularyName
```
public String getVocabularyName()
```
    The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
    
    Returns:
    
    The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
  - withVocabularyName
```
public MedicalTranscriptionSetting withVocabularyName(String vocabularyName)
```
    The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
    
    Parameters:
    
    vocabularyName - The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
    
    The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
    
    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