com.amazonaws.services.transcribe.model.MedicalScribeSettings Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transcribe Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.transcribe.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MedicalScribeSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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).
*
*/
private Boolean showSpeakerLabels;
/**
*
* 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.
*
*/
private Integer maxSpeakerLabels;
/**
*
* 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.
*
*/
private Boolean channelIdentification;
/**
*
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are
* case sensitive.
*
*/
private String vocabularyName;
/**
*
* 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.
*
*/
private String vocabularyFilterName;
/**
*
* 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.
*
*/
private String vocabularyFilterMethod;
/**
*
* 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).
*
*
* @param 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).
*/
public void setShowSpeakerLabels(Boolean showSpeakerLabels) {
this.showSpeakerLabels = 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).
*
*
* @return 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).
*/
public Boolean getShowSpeakerLabels() {
return this.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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeSettings withShowSpeakerLabels(Boolean showSpeakerLabels) {
setShowSpeakerLabels(showSpeakerLabels);
return this;
}
/**
*
* 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).
*
*
* @return 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).
*/
public Boolean isShowSpeakerLabels() {
return this.showSpeakerLabels;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMaxSpeakerLabels(Integer maxSpeakerLabels) {
this.maxSpeakerLabels = 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.
*
*
* @return 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.
*/
public Integer getMaxSpeakerLabels() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeSettings withMaxSpeakerLabels(Integer maxSpeakerLabels) {
setMaxSpeakerLabels(maxSpeakerLabels);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setChannelIdentification(Boolean channelIdentification) {
this.channelIdentification = 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.
*
*
* @return 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.
*/
public Boolean getChannelIdentification() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeSettings withChannelIdentification(Boolean channelIdentification) {
setChannelIdentification(channelIdentification);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isChannelIdentification() {
return this.channelIdentification;
}
/**
*
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are
* case sensitive.
*
*
* @param vocabularyName
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary
* names are case sensitive.
*/
public void setVocabularyName(String vocabularyName) {
this.vocabularyName = vocabularyName;
}
/**
*
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are
* case sensitive.
*
*
* @return The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary
* names are case sensitive.
*/
public String getVocabularyName() {
return this.vocabularyName;
}
/**
*
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are
* case sensitive.
*
*
* @param vocabularyName
* The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary
* names are case sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeSettings withVocabularyName(String vocabularyName) {
setVocabularyName(vocabularyName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setVocabularyFilterName(String vocabularyFilterName) {
this.vocabularyFilterName = 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.
*
*
* @return 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.
*/
public String getVocabularyFilterName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeSettings withVocabularyFilterName(String vocabularyFilterName) {
setVocabularyFilterName(vocabularyFilterName);
return this;
}
/**
*
* 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.
*
*
* @param 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 VocabularyFilterMethod
*/
public void setVocabularyFilterMethod(String vocabularyFilterMethod) {
this.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.
*
*
* @return 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 VocabularyFilterMethod
*/
public String getVocabularyFilterMethod() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyFilterMethod
*/
public MedicalScribeSettings withVocabularyFilterMethod(String vocabularyFilterMethod) {
setVocabularyFilterMethod(vocabularyFilterMethod);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyFilterMethod
*/
public MedicalScribeSettings withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) {
this.vocabularyFilterMethod = vocabularyFilterMethod.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getShowSpeakerLabels() != null)
sb.append("ShowSpeakerLabels: ").append(getShowSpeakerLabels()).append(",");
if (getMaxSpeakerLabels() != null)
sb.append("MaxSpeakerLabels: ").append(getMaxSpeakerLabels()).append(",");
if (getChannelIdentification() != null)
sb.append("ChannelIdentification: ").append(getChannelIdentification()).append(",");
if (getVocabularyName() != null)
sb.append("VocabularyName: ").append(getVocabularyName()).append(",");
if (getVocabularyFilterName() != null)
sb.append("VocabularyFilterName: ").append(getVocabularyFilterName()).append(",");
if (getVocabularyFilterMethod() != null)
sb.append("VocabularyFilterMethod: ").append(getVocabularyFilterMethod());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MedicalScribeSettings == false)
return false;
MedicalScribeSettings other = (MedicalScribeSettings) obj;
if (other.getShowSpeakerLabels() == null ^ this.getShowSpeakerLabels() == null)
return false;
if (other.getShowSpeakerLabels() != null && other.getShowSpeakerLabels().equals(this.getShowSpeakerLabels()) == false)
return false;
if (other.getMaxSpeakerLabels() == null ^ this.getMaxSpeakerLabels() == null)
return false;
if (other.getMaxSpeakerLabels() != null && other.getMaxSpeakerLabels().equals(this.getMaxSpeakerLabels()) == false)
return false;
if (other.getChannelIdentification() == null ^ this.getChannelIdentification() == null)
return false;
if (other.getChannelIdentification() != null && other.getChannelIdentification().equals(this.getChannelIdentification()) == false)
return false;
if (other.getVocabularyName() == null ^ this.getVocabularyName() == null)
return false;
if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == false)
return false;
if (other.getVocabularyFilterName() == null ^ this.getVocabularyFilterName() == null)
return false;
if (other.getVocabularyFilterName() != null && other.getVocabularyFilterName().equals(this.getVocabularyFilterName()) == false)
return false;
if (other.getVocabularyFilterMethod() == null ^ this.getVocabularyFilterMethod() == null)
return false;
if (other.getVocabularyFilterMethod() != null && other.getVocabularyFilterMethod().equals(this.getVocabularyFilterMethod()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getShowSpeakerLabels() == null) ? 0 : getShowSpeakerLabels().hashCode());
hashCode = prime * hashCode + ((getMaxSpeakerLabels() == null) ? 0 : getMaxSpeakerLabels().hashCode());
hashCode = prime * hashCode + ((getChannelIdentification() == null) ? 0 : getChannelIdentification().hashCode());
hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode());
hashCode = prime * hashCode + ((getVocabularyFilterName() == null) ? 0 : getVocabularyFilterName().hashCode());
hashCode = prime * hashCode + ((getVocabularyFilterMethod() == null) ? 0 : getVocabularyFilterMethod().hashCode());
return hashCode;
}
@Override
public MedicalScribeSettings clone() {
try {
return (MedicalScribeSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.MedicalScribeSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}