Skip to content

StartMedicalStreamTranscriptionResponse

Source code in docs_src/capo_transcribe_streaming/types/start_medical_stream_transcription_response.py
class StartMedicalStreamTranscriptionResponse(TypedDict, closed=True):
    request_id: NotRequired["capo_transcribe_streaming.types.request_id.RequestId"]
    """<p>Provides the identifier for your streaming request.</p>"""
    language_code: NotRequired[
        "capo_transcribe_streaming.types.language_code.LanguageCode"
    ]
    """<p>Provides the language code that you specified in your request. This must be <code>en-US</code>.</p>"""
    media_sample_rate_hertz: NotRequired[
        "capo_transcribe_streaming.types.media_sample_rate_hertz.MediaSampleRateHertz"
    ]
    """<p>Provides the sample rate that you specified in your request.</p>"""
    media_encoding: NotRequired[
        "capo_transcribe_streaming.types.media_encoding.MediaEncoding"
    ]
    """<p>Provides the media encoding you specified in your request.</p>"""
    vocabulary_name: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_name.VocabularyName"
    ]
    """<p>Provides the name of the custom vocabulary that you specified in your request.</p>"""
    specialty: NotRequired["capo_transcribe_streaming.types.specialty.Specialty"]
    """<p>Provides the medical specialty that you specified in your request.</p>"""
    type: NotRequired["capo_transcribe_streaming.types.type.Type"]
    """<p>Provides the type of audio you specified in your request.</p>"""
    show_speaker_label: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Shows whether speaker partitioning was enabled for your transcription.</p>"""
    session_id: NotRequired["capo_transcribe_streaming.types.session_id.SessionId"]
    """<p>Provides the identifier for your transcription session.</p>"""
    transcript_result_stream: NotRequired[
        "capo_transcribe_streaming.types.medical_transcript_result_stream.MedicalTranscriptResultStream"
    ]
    """<p>Provides detailed information about your streaming session.</p>"""
    enable_channel_identification: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Shows whether channel identification was enabled for your transcription.</p>"""
    number_of_channels: NotRequired[
        "capo_transcribe_streaming.types.number_of_channels.NumberOfChannels"
    ]
    """<p>Provides the number of channels that you specified in your request.</p>"""
    content_identification_type: NotRequired[
        "capo_transcribe_streaming.types.medical_content_identification_type.MedicalContentIdentificationType"
    ]
    """<p>Shows whether content identification was enabled for your transcription.</p>"""

content_identification_type instance-attribute

content_identification_type: NotRequired[MedicalContentIdentificationType]

Shows whether content identification was enabled for your transcription.

enable_channel_identification instance-attribute

enable_channel_identification: Boolean

Shows whether channel identification was enabled for your transcription.

language_code instance-attribute

language_code: NotRequired[LanguageCode]

Provides the language code that you specified in your request. This must be en-US.

media_encoding instance-attribute

media_encoding: NotRequired[MediaEncoding]

Provides the media encoding you specified in your request.

media_sample_rate_hertz instance-attribute

media_sample_rate_hertz: NotRequired[MediaSampleRateHertz]

Provides the sample rate that you specified in your request.

number_of_channels instance-attribute

number_of_channels: NotRequired[NumberOfChannels]

Provides the number of channels that you specified in your request.

request_id instance-attribute

request_id: NotRequired[RequestId]

Provides the identifier for your streaming request.

session_id instance-attribute

session_id: NotRequired[SessionId]

Provides the identifier for your transcription session.

show_speaker_label instance-attribute

show_speaker_label: Boolean

Shows whether speaker partitioning was enabled for your transcription.

specialty instance-attribute

specialty: NotRequired[Specialty]

Provides the medical specialty that you specified in your request.

transcript_result_stream instance-attribute

transcript_result_stream: NotRequired[MedicalTranscriptResultStream]

Provides detailed information about your streaming session.

type instance-attribute

type: NotRequired[Type]

Provides the type of audio you specified in your request.

vocabulary_name instance-attribute

vocabulary_name: NotRequired[VocabularyName]

Provides the name of the custom vocabulary that you specified in your request.