Skip to content

StartMedicalScribeStreamRequest

Source code in docs_src/capo_transcribe_streaming/types/start_medical_scribe_stream_request.py
class StartMedicalScribeStreamRequest(TypedDict, closed=True):
    session_id: NotRequired["capo_transcribe_streaming.types.session_id.SessionId"]
    """<p>Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response. </p>"""
    language_code: "capo_transcribe_streaming.types.medical_scribe_language_code.MedicalScribeLanguageCode"
    """<p>Specify the language code for your HealthScribe streaming session.</p>"""
    media_sample_rate_hertz: "capo_transcribe_streaming.types.medical_scribe_media_sample_rate_hertz.MedicalScribeMediaSampleRateHertz"
    """<p>Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio. </p>"""
    media_encoding: "capo_transcribe_streaming.types.medical_scribe_media_encoding.MedicalScribeMediaEncoding"
    """<p>Specify the encoding used for the input audio.</p> <p>Supported formats are:</p> <ul> <li> <p>FLAC</p> </li> <li> <p>OPUS-encoded audio in an Ogg container</p> </li> <li> <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV) </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>. </p>"""
    input_stream: "capo_transcribe_streaming.types.medical_scribe_input_stream.MedicalScribeInputStream"
    """<p>Specify the input stream where you will send events in real time.</p> <p>The first element of the input stream must be a <code>MedicalScribeConfigurationEvent</code>. </p>"""

input_stream instance-attribute

Specify the input stream where you will send events in real time.

The first element of the input stream must be a MedicalScribeConfigurationEvent.

language_code instance-attribute

Specify the language code for your HealthScribe streaming session.

media_encoding instance-attribute

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.

media_sample_rate_hertz instance-attribute

media_sample_rate_hertz: MedicalScribeMediaSampleRateHertz

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

session_id instance-attribute

session_id: NotRequired[SessionId]

Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.