All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.transcribe.model.MedicalTranscriptionSetting Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Transcribe module holds the client classes that are used for communicating with Amazon Transcribe Service

There is a newer version: 1.12.780
Show newest version
/*
 * 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;

/**
 * 

* Allows additional optional settings in your request, including channel identification, alternative transcriptions, * and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class MedicalTranscriptionSetting implements Serializable, Cloneable, StructuredPojo { /** *

* Enables speaker partitioning (diarization) in your transcription 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. *

*

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

*

* For more information, see Transcribing * multi-channel audio. *

*/ private Boolean channelIdentification; /** *

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

*/ private Boolean showAlternatives; /** *

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

*/ private Integer maxAlternatives; /** *

* The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive. *

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. *

*/ private String vocabularyName; /** *

* Enables speaker partitioning (diarization) in your transcription 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 transcription 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 transcription 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 transcription 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 transcription 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 transcription 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 MedicalTranscriptionSetting withShowSpeakerLabels(Boolean showSpeakerLabels) { setShowSpeakerLabels(showSpeakerLabels); return this; } /** *

* Enables speaker partitioning (diarization) in your transcription 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 transcription 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 MedicalTranscriptionSetting 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. *

*

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

*

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

*

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

*

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

*

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

*

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

*

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

*

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

*

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

*

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

*

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

*

* For more information, see Transcribing multi-channel * audio. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionSetting 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. *

*

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

*

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

*

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

*

* For more information, see Transcribing multi-channel * audio. */ public Boolean isChannelIdentification() { return this.channelIdentification; } /** *

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

* * @param 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. */ public void setShowAlternatives(Boolean showAlternatives) { this.showAlternatives = 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. *

* * @return 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. */ public Boolean getShowAlternatives() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionSetting withShowAlternatives(Boolean showAlternatives) { setShowAlternatives(showAlternatives); return this; } /** *

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

* * @return 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. */ public Boolean isShowAlternatives() { return this.showAlternatives; } /** *

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

* * @param 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. */ public void setMaxAlternatives(Integer maxAlternatives) { this.maxAlternatives = 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. *

* * @return 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. */ public Integer getMaxAlternatives() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionSetting withMaxAlternatives(Integer maxAlternatives) { setMaxAlternatives(maxAlternatives); return this; } /** *

* The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive. *

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. *

* * @param vocabularyName * The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive.

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. */ public void setVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; } /** *

* The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive. *

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. *

* * @return The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive.

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. */ public String getVocabularyName() { return this.vocabularyName; } /** *

* The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive. *

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. *

* * @param vocabularyName * The name of the custom vocabulary you want to use when processing your medical transcription job. Custom * vocabulary names are case sensitive.

*

* The language of the specified custom vocabulary must match the language code that you specify in your * transcription request. If the languages do not match, the custom 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. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionSetting withVocabularyName(String vocabularyName) { setVocabularyName(vocabularyName); 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 (getShowAlternatives() != null) sb.append("ShowAlternatives: ").append(getShowAlternatives()).append(","); if (getMaxAlternatives() != null) sb.append("MaxAlternatives: ").append(getMaxAlternatives()).append(","); if (getVocabularyName() != null) sb.append("VocabularyName: ").append(getVocabularyName()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof MedicalTranscriptionSetting == false) return false; MedicalTranscriptionSetting other = (MedicalTranscriptionSetting) 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.getShowAlternatives() == null ^ this.getShowAlternatives() == null) return false; if (other.getShowAlternatives() != null && other.getShowAlternatives().equals(this.getShowAlternatives()) == false) return false; if (other.getMaxAlternatives() == null ^ this.getMaxAlternatives() == null) return false; if (other.getMaxAlternatives() != null && other.getMaxAlternatives().equals(this.getMaxAlternatives()) == false) return false; if (other.getVocabularyName() == null ^ this.getVocabularyName() == null) return false; if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == 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 + ((getShowAlternatives() == null) ? 0 : getShowAlternatives().hashCode()); hashCode = prime * hashCode + ((getMaxAlternatives() == null) ? 0 : getMaxAlternatives().hashCode()); hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode()); return hashCode; } @Override public MedicalTranscriptionSetting clone() { try { return (MedicalTranscriptionSetting) 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.MedicalTranscriptionSettingMarshaller.getInstance().marshall(this, protocolMarshaller); } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy