Package software.amazon.awssdk.services.transcribestreaming.model

Class StartMedicalStreamTranscriptionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest
software.amazon.awssdk.services.transcribestreaming.model.StartMedicalStreamTranscriptionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMedicalStreamTranscriptionRequest extends TranscribeStreamingRequest implements ToCopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>

  • Method Details

    • languageCode

      public final LanguageCode languageCode()

      Specify the language code that represents the language spoken in your audio.

      Amazon Transcribe Medical only supports US English (en-US).

      If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      Specify the language code that represents the language spoken in your audio.

      Amazon Transcribe Medical only supports US English (en-US).

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Specify the language code that represents the language spoken in your audio.

      Amazon Transcribe Medical only supports US English (en-US).

      If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      Specify the language code that represents the language spoken in your audio.

      Amazon Transcribe Medical only supports US English (en-US).

      See Also:

    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

      Returns:
      The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

    • mediaEncoding

      public final MediaEncoding mediaEncoding()

      Specify the encoding used for the input audio. Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specify the encoding used for the input audio. Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      See Also:

    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      Specify the encoding used for the input audio. Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specify the encoding used for the input audio. Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      See Also:

    • vocabularyName

      public final String vocabularyName()

      Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

      Returns:
      Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

    • specialty

      public final Specialty specialty()

      Specify the medical specialty contained in your audio.

      If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

      Returns:
      Specify the medical specialty contained in your audio.
      See Also:

    • specialtyAsString

      public final String specialtyAsString()

      Specify the medical specialty contained in your audio.

      If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

      Returns:
      Specify the medical specialty contained in your audio.
      See Also:

    • type

      public final Type type()

      Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.
      See Also:

    • showSpeakerLabel

      public final Boolean showSpeakerLabel()

      Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

      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.

      For more information, see Partitioning speakers (diarization).

    • sessionId

      public final String sessionId()

      Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

      You can use a session ID to retry a streaming session.

      Returns:
      Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

      You can use a session ID to retry a streaming session.

    • enableChannelIdentification

      public final Boolean enableChannelIdentification()

      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 is not separated 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 is not separated by channel.

      For more information, see Transcribing multi-channel audio.

    • numberOfChannels

      public final Integer numberOfChannels()

      Specify the number of channels in your audio stream. Up to two channels are supported.

      Returns:
      Specify the number of channels in your audio stream. Up to two channels are supported.

    • contentIdentificationType

      public final MedicalContentIdentificationType contentIdentificationType()

      Labels all personal health information (PHI) identified in your transcript.

      Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

      For more information, see Identifying personal health information (PHI) in a transcription.

      If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

      Returns:
      Labels all personal health information (PHI) identified in your transcript.

      Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

      For more information, see Identifying personal health information (PHI) in a transcription.

      See Also:

    • contentIdentificationTypeAsString

      public final String contentIdentificationTypeAsString()

      Labels all personal health information (PHI) identified in your transcript.

      Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

      For more information, see Identifying personal health information (PHI) in a transcription.

      If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

      Returns:
      Labels all personal health information (PHI) identified in your transcript.

      Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

      For more information, see Identifying personal health information (PHI) in a transcription.

      See Also:

    • toBuilder

      public StartMedicalStreamTranscriptionRequest.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<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>
      Specified by:
      toBuilder in class TranscribeStreamingRequest
      Returns:
      a builder for type T

    • builder

      public static StartMedicalStreamTranscriptionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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