Skip to content

StartStreamTranscriptionResponse

Source code in docs_src/capo_transcribe_streaming/types/start_stream_transcription_response.py
class StartStreamTranscriptionResponse(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.</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>"""
    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.transcript_result_stream.TranscriptResultStream"
    ]
    """<p>Provides detailed information about your streaming session.</p>"""
    vocabulary_filter_name: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_filter_name.VocabularyFilterName"
    ]
    """<p>Provides the name of the custom vocabulary filter that you specified in your request.</p>"""
    vocabulary_filter_method: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_filter_method.VocabularyFilterMethod"
    ]
    """<p>Provides the vocabulary filtering method used in your transcription.</p>"""
    show_speaker_label: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Shows whether speaker partitioning was enabled for your transcription.</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>"""
    enable_partial_results_stabilization: (
        "capo_transcribe_streaming.types.boolean.Boolean"
    )
    """<p>Shows whether partial results stabilization was enabled for your transcription.</p>"""
    partial_results_stability: NotRequired[
        "capo_transcribe_streaming.types.partial_results_stability.PartialResultsStability"
    ]
    """<p>Provides the stabilization level used for your transcription.</p>"""
    content_identification_type: NotRequired[
        "capo_transcribe_streaming.types.content_identification_type.ContentIdentificationType"
    ]
    """<p>Shows whether content identification was enabled for your transcription.</p>"""
    content_redaction_type: NotRequired[
        "capo_transcribe_streaming.types.content_redaction_type.ContentRedactionType"
    ]
    """<p>Shows whether content redaction was enabled for your transcription.</p>"""
    pii_entity_types: NotRequired[
        "capo_transcribe_streaming.types.pii_entity_types.PiiEntityTypes"
    ]
    """<p>Lists the PII entity types you specified in your request.</p>"""
    language_model_name: NotRequired[
        "capo_transcribe_streaming.types.model_name.ModelName"
    ]
    """<p>Provides the name of the custom language model that you specified in your request.</p>"""
    identify_language: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Shows whether automatic language identification was enabled for your transcription.</p>"""
    language_options: NotRequired[
        "capo_transcribe_streaming.types.language_options.LanguageOptions"
    ]
    """<p>Provides the language codes that you specified in your request.</p>"""
    preferred_language: NotRequired[
        "capo_transcribe_streaming.types.language_code.LanguageCode"
    ]
    """<p>Provides the preferred language that you specified in your request.</p>"""
    identify_multiple_languages: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Shows whether automatic multi-language identification was enabled for your transcription.</p>"""
    vocabulary_names: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_names.VocabularyNames"
    ]
    """<p>Provides the names of the custom vocabularies that you specified in your request.</p>"""
    vocabulary_filter_names: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_filter_names.VocabularyFilterNames"
    ]
    """<p>Provides the names of the custom vocabulary filters that you specified in your request.</p>"""
    session_resume_window: NotRequired[
        "capo_transcribe_streaming.types.session_resume_window.SessionResumeWindow"
    ]
    """<p>Provides the session resume window, in minutes, that you specified in your request.</p>"""
    transcript_format: NotRequired[
        "capo_transcribe_streaming.types.transcript_format.TranscriptFormat"
    ]
    """<p>Provides the transcript format that you specified in your request.</p>"""

content_identification_type instance-attribute

content_identification_type: NotRequired[ContentIdentificationType]

Shows whether content identification was enabled for your transcription.

content_redaction_type instance-attribute

content_redaction_type: NotRequired[ContentRedactionType]

Shows whether content redaction was enabled for your transcription.

enable_channel_identification instance-attribute

enable_channel_identification: Boolean

Shows whether channel identification was enabled for your transcription.

enable_partial_results_stabilization instance-attribute

enable_partial_results_stabilization: Boolean

Shows whether partial results stabilization was enabled for your transcription.

identify_language instance-attribute

identify_language: Boolean

Shows whether automatic language identification was enabled for your transcription.

identify_multiple_languages instance-attribute

identify_multiple_languages: Boolean

Shows whether automatic multi-language identification was enabled for your transcription.

language_code instance-attribute

language_code: NotRequired[LanguageCode]

Provides the language code that you specified in your request.

language_model_name instance-attribute

language_model_name: NotRequired[ModelName]

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

language_options instance-attribute

language_options: NotRequired[LanguageOptions]

Provides the language codes that you specified in your request.

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.

partial_results_stability instance-attribute

partial_results_stability: NotRequired[PartialResultsStability]

Provides the stabilization level used for your transcription.

pii_entity_types instance-attribute

pii_entity_types: NotRequired[PiiEntityTypes]

Lists the PII entity types you specified in your request.

preferred_language instance-attribute

preferred_language: NotRequired[LanguageCode]

Provides the preferred language 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.

session_resume_window instance-attribute

session_resume_window: NotRequired[SessionResumeWindow]

Provides the session resume window, in minutes, that you specified in your request.

show_speaker_label instance-attribute

show_speaker_label: Boolean

Shows whether speaker partitioning was enabled for your transcription.

transcript_format instance-attribute

transcript_format: NotRequired[TranscriptFormat]

Provides the transcript format that you specified in your request.

transcript_result_stream instance-attribute

transcript_result_stream: NotRequired[TranscriptResultStream]

Provides detailed information about your streaming session.

vocabulary_filter_method instance-attribute

vocabulary_filter_method: NotRequired[VocabularyFilterMethod]

Provides the vocabulary filtering method used in your transcription.

vocabulary_filter_name instance-attribute

vocabulary_filter_name: NotRequired[VocabularyFilterName]

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

vocabulary_filter_names instance-attribute

vocabulary_filter_names: NotRequired[VocabularyFilterNames]

Provides the names of the custom vocabulary filters that 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.

vocabulary_names instance-attribute

vocabulary_names: NotRequired[VocabularyNames]

Provides the names of the custom vocabularies that you specified in your request.