Skip to content

StartMedicalScribeStreamResponse

Source code in docs_src/capo_transcribe_streaming/types/start_medical_scribe_stream_response.py
class StartMedicalScribeStreamResponse(TypedDict, closed=True):
    session_id: NotRequired["capo_transcribe_streaming.types.session_id.SessionId"]
    """<p>The identifier (in UUID format) for your streaming session.</p> <p>If you already started streaming, this is same ID as the one you specified in your initial <code>StartMedicalScribeStreamRequest</code>. </p>"""
    request_id: NotRequired["capo_transcribe_streaming.types.request_id.RequestId"]
    """<p>The unique identifier for your streaming request. </p>"""
    language_code: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_language_code.MedicalScribeLanguageCode"
    ]
    """<p>The Language Code that you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code>. </p>"""
    media_sample_rate_hertz: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_media_sample_rate_hertz.MedicalScribeMediaSampleRateHertz"
    ]
    """<p>The sample rate (in hertz) that you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code> </p>"""
    media_encoding: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_media_encoding.MedicalScribeMediaEncoding"
    ]
    """<p>The Media Encoding you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code> </p>"""
    result_stream: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_result_stream.MedicalScribeResultStream"
    ]
    """<p>The result stream where you will receive the output events. </p>"""

language_code instance-attribute

language_code: NotRequired[MedicalScribeLanguageCode]

The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest.

media_encoding instance-attribute

media_encoding: NotRequired[MedicalScribeMediaEncoding]

The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest

media_sample_rate_hertz instance-attribute

media_sample_rate_hertz: NotRequired[MedicalScribeMediaSampleRateHertz]

The sample rate (in hertz) that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest

request_id instance-attribute

request_id: NotRequired[RequestId]

The unique identifier for your streaming request.

result_stream instance-attribute

result_stream: NotRequired[MedicalScribeResultStream]

The result stream where you will receive the output events.

session_id instance-attribute

session_id: NotRequired[SessionId]

The identifier (in UUID format) for your streaming session.

If you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest.