Interface StartMedicalStreamTranscriptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>, SdkBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>, SdkPojo, SdkRequest.Builder, TranscribeStreamingRequest.Builder
Enclosing class:
StartMedicalStreamTranscriptionRequest
@Mutable @NotThreadSafe public static interface StartMedicalStreamTranscriptionRequest.Builder extends TranscribeStreamingRequest.Builder, SdkPojo, CopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>

  • Method Details

    • languageCode

      StartMedicalStreamTranscriptionRequest.Builder languageCode(String languageCode)

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

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

      Parameters:
      languageCode - Specify the language code that represents the language spoken in your audio.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      StartMedicalStreamTranscriptionRequest.Builder languageCode(LanguageCode languageCode)

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

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

      Parameters:
      languageCode - Specify the language code that represents the language spoken in your audio.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaSampleRateHertz

      StartMedicalStreamTranscriptionRequest.Builder mediaSampleRateHertz(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • mediaEncoding

      StartMedicalStreamTranscriptionRequest.Builder mediaEncoding(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaEncoding

      StartMedicalStreamTranscriptionRequest.Builder mediaEncoding(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyName

      StartMedicalStreamTranscriptionRequest.Builder vocabularyName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • specialty

      StartMedicalStreamTranscriptionRequest.Builder specialty(String specialty)

      Specify the medical specialty contained in your audio.

      Parameters:
      specialty - Specify the medical specialty contained in your audio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • specialty

      StartMedicalStreamTranscriptionRequest.Builder specialty(Specialty specialty)

      Specify the medical specialty contained in your audio.

      Parameters:
      specialty - Specify the medical specialty contained in your audio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      StartMedicalStreamTranscriptionRequest.Builder type(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      StartMedicalStreamTranscriptionRequest.Builder type(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • showSpeakerLabel

      StartMedicalStreamTranscriptionRequest.Builder showSpeakerLabel(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      StartMedicalStreamTranscriptionRequest.Builder sessionId(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableChannelIdentification

      StartMedicalStreamTranscriptionRequest.Builder enableChannelIdentification(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.

      If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

      For more information, see Transcribing multi-channel audio.

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

      If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

      For more information, see Transcribing multi-channel audio.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfChannels

      StartMedicalStreamTranscriptionRequest.Builder numberOfChannels(Integer numberOfChannels)

      Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

      If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

      Parameters:
      numberOfChannels - Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

      If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentIdentificationType

      StartMedicalStreamTranscriptionRequest.Builder contentIdentificationType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentIdentificationType

      StartMedicalStreamTranscriptionRequest.Builder contentIdentificationType(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartMedicalStreamTranscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartMedicalStreamTranscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.