MedicalScribeSettings (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MedicalScribeSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MedicalScribeSettings()

Constructors
Constructor and Description
`MedicalScribeSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MedicalScribeSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getChannelIdentification()` Enables channel identification in multi-channel audio.
`Integer`	`getMaxSpeakerLabels()` Specify the maximum number of speakers you want to partition in your media.
`Boolean`	`getShowSpeakerLabels()` Enables speaker partitioning (diarization) in your Medical Scribe output.
`String`	`getVocabularyFilterMethod()` Specify how you want your custom vocabulary filter applied to your transcript.
`String`	`getVocabularyFilterName()` The name of the custom vocabulary filter you want to include in your Medical Scribe request.
`String`	`getVocabularyName()` The name of the custom vocabulary you want to include in your Medical Scribe request.
`int`	`hashCode()`
`Boolean`	`isChannelIdentification()` Enables channel identification in multi-channel audio.
`Boolean`	`isShowSpeakerLabels()` Enables speaker partitioning (diarization) in your Medical Scribe 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`	`setMaxSpeakerLabels(Integer maxSpeakerLabels)` Specify the maximum number of speakers you want to partition in your media.
`void`	`setShowSpeakerLabels(Boolean showSpeakerLabels)` Enables speaker partitioning (diarization) in your Medical Scribe output.
`void`	`setVocabularyFilterMethod(String vocabularyFilterMethod)` Specify how you want your custom vocabulary filter applied to your transcript.
`void`	`setVocabularyFilterName(String vocabularyFilterName)` The name of the custom vocabulary filter you want to include in your Medical Scribe request.
`void`	`setVocabularyName(String vocabularyName)` The name of the custom vocabulary you want to include in your Medical Scribe request.
`String`	`toString()` Returns a string representation of this object.
`MedicalScribeSettings`	`withChannelIdentification(Boolean channelIdentification)` Enables channel identification in multi-channel audio.
`MedicalScribeSettings`	`withMaxSpeakerLabels(Integer maxSpeakerLabels)` Specify the maximum number of speakers you want to partition in your media.
`MedicalScribeSettings`	`withShowSpeakerLabels(Boolean showSpeakerLabels)` Enables speaker partitioning (diarization) in your Medical Scribe output.
`MedicalScribeSettings`	`withVocabularyFilterMethod(String vocabularyFilterMethod)` Specify how you want your custom vocabulary filter applied to your transcript.
`MedicalScribeSettings`	`withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)` Specify how you want your custom vocabulary filter applied to your transcript.
`MedicalScribeSettings`	`withVocabularyFilterName(String vocabularyFilterName)` The name of the custom vocabulary filter you want to include in your Medical Scribe request.
`MedicalScribeSettings`	`withVocabularyName(String vocabularyName)` The name of the custom vocabulary you want to include in your Medical Scribe request.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MedicalScribeSettings
```
public MedicalScribeSettings()
```
- Method Detail
  - setShowSpeakerLabels
```
public void setShowSpeakerLabels(Boolean showSpeakerLabels)
```
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    For more information, see Partitioning speakers (diarization).
    
    Parameters:
    
    showSpeakerLabels - Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    For more information, see Partitioning speakers (diarization).
  - getShowSpeakerLabels
```
public Boolean getShowSpeakerLabels()
```
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    For more information, see Partitioning speakers (diarization).
    
    Returns:
    
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    For more information, see Partitioning speakers (diarization).
  - withShowSpeakerLabels
```
public MedicalScribeSettings withShowSpeakerLabels(Boolean showSpeakerLabels)
```
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    For more information, see Partitioning speakers (diarization).
    
    Parameters:
    
    showSpeakerLabels - Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    For more information, see Partitioning speakers (diarization).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowSpeakerLabels
```
public Boolean isShowSpeakerLabels()
```
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .
    
    For more information, see Partitioning speakers (diarization).
    
    Returns:
    
    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
    
    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
    
    For more information, see Partitioning speakers (diarization).
  - setMaxSpeakerLabels
```
public void setMaxSpeakerLabels(Integer maxSpeakerLabels)
```
    Specify the maximum number of speakers you want to partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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 partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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 partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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 partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
    
    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
  - withMaxSpeakerLabels
```
public MedicalScribeSettings withMaxSpeakerLabels(Integer maxSpeakerLabels)
```
    Specify the maximum number of speakers you want to partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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 partition in your media.
    
    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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.
    
    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.
    
    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.
    
    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.
    
    For more information, see Transcribing multi-channel audio.
  - withChannelIdentification
```
public MedicalScribeSettings 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.
    
    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.
    
    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.
    
    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.
    
    For more information, see Transcribing multi-channel audio.
  - setVocabularyName
```
public void setVocabularyName(String vocabularyName)
```
    The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
    
    Parameters:
    
    vocabularyName - The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
  - getVocabularyName
```
public String getVocabularyName()
```
    The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
    
    Returns:
    
    The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
  - withVocabularyName
```
public MedicalScribeSettings withVocabularyName(String vocabularyName)
```
    The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
    
    Parameters:
    
    vocabularyName - The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVocabularyFilterName
```
public void setVocabularyFilterName(String vocabularyFilterName)
```
    The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
    
    Parameters:
    
    vocabularyFilterName - The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
  - getVocabularyFilterName
```
public String getVocabularyFilterName()
```
    The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
    
    Returns:
    
    The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
  - withVocabularyFilterName
```
public MedicalScribeSettings withVocabularyFilterName(String vocabularyFilterName)
```
    The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
    
    Parameters:
    
    vocabularyFilterName - The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
    
    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVocabularyFilterMethod
```
public void setVocabularyFilterMethod(String vocabularyFilterMethod)
```
    Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Parameters:
    
    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    See Also:
    
    VocabularyFilterMethod
  - getVocabularyFilterMethod
```
public String getVocabularyFilterMethod()
```
    Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Returns:
    
    Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    See Also:
    
    VocabularyFilterMethod
  - withVocabularyFilterMethod
```
public MedicalScribeSettings withVocabularyFilterMethod(String vocabularyFilterMethod)
```
    Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Parameters:
    
    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - withVocabularyFilterMethod
```
public MedicalScribeSettings withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)
```
    Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Parameters:
    
    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - 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 MedicalScribeSettings 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.

AWS SDK for Java 1.x API Reference - 1.12.777

Class MedicalScribeSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MedicalScribeSettings

Method Detail

setShowSpeakerLabels

getShowSpeakerLabels

withShowSpeakerLabels

isShowSpeakerLabels

setMaxSpeakerLabels

getMaxSpeakerLabels

withMaxSpeakerLabels

setChannelIdentification

getChannelIdentification

withChannelIdentification

isChannelIdentification

setVocabularyName

getVocabularyName

withVocabularyName

setVocabularyFilterName

getVocabularyFilterName

withVocabularyFilterName

setVocabularyFilterMethod

getVocabularyFilterMethod

withVocabularyFilterMethod

withVocabularyFilterMethod

toString

equals

hashCode

clone

marshall