class Aws::TranscribeStreamingService::Types::StartMedicalStreamTranscriptionRequest

@note When making an API call, you may pass StartMedicalStreamTranscriptionRequest

data as a hash:

    {
      language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
      media_sample_rate_hertz: 1, # required
      media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
      vocabulary_name: "VocabularyName",
      specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE, CARDIOLOGY, NEUROLOGY, ONCOLOGY, RADIOLOGY, UROLOGY
      type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
      show_speaker_label: false,
      session_id: "SessionId",
      input_event_stream_hander: EventStreams::AudioStream.new,
      enable_channel_identification: false,
      number_of_channels: 1,
      content_identification_type: "PHI", # accepts PHI
    }

@!attribute [rw] language_code

Indicates the source language used in the input audio stream. For
Amazon Transcribe Medical, this is US English (en-US).
@return [String]

@!attribute [rw] media_sample_rate_hertz

The sample rate of the input audio in Hertz. Sample rates of 16000
Hz or higher are accepted.
@return [Integer]

@!attribute [rw] media_encoding

The encoding used for the input audio.
@return [String]

@!attribute [rw] vocabulary_name

The name of the medical custom vocabulary to use when processing the
real-time stream.
@return [String]

@!attribute [rw] specialty

The medical specialty of the clinician or provider.
@return [String]

@!attribute [rw] type

The type of input audio. Choose `DICTATION` for a provider dictating
patient notes. Choose `CONVERSATION` for a dialogue between a
patient and one or more medical professionanls.
@return [String]

@!attribute [rw] show_speaker_label

When `true`, enables speaker identification in your real-time
stream.
@return [Boolean]

@!attribute [rw] session_id

Optional. An identifier for the transcription session. If you don't
provide a session ID, Amazon Transcribe generates one for you and
returns it in the response.
@return [String]

@!attribute [rw] audio_stream

Represents the audio stream from your application to Amazon
Transcribe.
@return [Types::AudioStream]

@!attribute [rw] enable_channel_identification

When `true`, instructs Amazon Transcribe Medical to process each
audio channel separately and then merge the transcription output of
each channel into a single transcription.

Amazon Transcribe Medical also produces a transcription of each
item. An item includes the start time, end time, and any alternative
transcriptions.

You can't set both `ShowSpeakerLabel` and
`EnableChannelIdentification` in the same request. If you set both,
your request returns a `BadRequestException`.
@return [Boolean]

@!attribute [rw] number_of_channels

The number of channels that are in your audio stream.
@return [Integer]

@!attribute [rw] content_identification_type

Set this field to `PHI` to identify personal health information in
the transcription output.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscriptionRequest AWS API Documentation

Constants

SENSITIVE