* 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. *
*/ public class MedicalTranscriptionSetting implements Serializable { /** ** 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including both
* parameters returns a BadRequestException.
*
* 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.
*
* Constraints:
* Range: 2 - 10
*/
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. *
*
* 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. *
*/ 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. *
*
* Constraints:
* Range: 2 - 10
*/
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
* don't 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.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/
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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including both
* parameters returns a BadRequestException.
*
* 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including
* both parameters returns a BadRequestException.
*
* For more information, see Partitioning speakers (diarization). *
*/ public Boolean isShowSpeakerLabels() { return 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including both
* parameters returns a BadRequestException.
*
* 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including
* both parameters returns a BadRequestException.
*
* For more information, see Partitioning speakers (diarization). *
*/ public Boolean getShowSpeakerLabels() { return 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including both
* parameters returns a BadRequestException.
*
* 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request.
* Including both parameters returns a
* BadRequestException.
*
* 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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request. Including both
* parameters returns a BadRequestException.
*
* For more information, see Partitioning speakers (diarization). *
** Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* You can't include ShowSpeakerLabels and
* ChannelIdentification in the same request.
* Including both parameters returns a
* BadRequestException.
*
* For more information, see Partitioning speakers (diarization). *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionSetting withShowSpeakerLabels(Boolean showSpeakerLabels) { this.showSpeakerLabels = showSpeakerLabels; return this; } /** ** 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.
*
* Constraints:
* Range: 2 - 10
*
* @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.
*
* 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.
*
* Constraints:
* Range: 2 - 10
*
* @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.
*
* 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 2 - 10
*
* @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.
*
* 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. *
* * @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. *
*
* 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. *
*/ public Boolean isChannelIdentification() { return 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. *
* * @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. *
*
* 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. *
*/ public Boolean getChannelIdentification() { return 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. *
* * @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. *
*
* 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. *
*/ 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. *
*
* 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 a reference to this object so that method calls can be chained * together. * * @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. *
*
* 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionSetting withChannelIdentification(Boolean channelIdentification) { this.channelIdentification = channelIdentification; 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 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 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. *
*/ 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionSetting withShowAlternatives(Boolean showAlternatives) { this.showAlternatives = showAlternatives; return this; } /** ** 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. *
*
* Constraints:
* Range: 2 - 10
*
* @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 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. *
*
* Constraints:
* Range: 2 - 10
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 2 - 10
*
* @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 A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionSetting withMaxAlternatives(Integer maxAlternatives) { this.maxAlternatives = 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
* don't 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.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 don't 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.
*
* 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
* don't 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.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 don't 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.
*
* 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
* don't 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 don't 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.
*