Class MedicalTranscriptionSetting

java.lang.Object
software.amazon.awssdk.services.transcribe.model.MedicalTranscriptionSetting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>
@Generated("software.amazon.awssdk:codegen") public final class MedicalTranscriptionSetting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>

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 Also:

  • Method Details

    • showSpeakerLabels

      public final Boolean 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).

      Returns:
      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).

    • maxSpeakerLabels

      public final 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.

      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.

    • channelIdentification

      public final Boolean channelIdentification()

      Enables channel identification in multi-channel audio.

      Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

      If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

      For more information, see Transcribing multi-channel audio.

      Returns:
      Enables channel identification in multi-channel audio.

      Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

      If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

      For more information, see Transcribing multi-channel audio.

    • showAlternatives

      public final Boolean showAlternatives()

      To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

      If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

      For more information, see Alternative transcriptions.

      Returns:
      To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

      If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

      For more information, see Alternative transcriptions.

    • maxAlternatives

      public final Integer maxAlternatives()

      Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

      If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

      If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

      For more information, see Alternative transcriptions.

      Returns:
      Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

      If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

      If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

      For more information, see Alternative transcriptions.

    • vocabularyName

      public final String 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.

      Returns:
      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.

    • toBuilder

      public MedicalTranscriptionSetting.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MedicalTranscriptionSetting.Builder,MedicalTranscriptionSetting>
      Returns:
      a builder for type T

    • builder

      public static MedicalTranscriptionSetting.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MedicalTranscriptionSetting.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.