Skip to content

Result

Source code in docs_src/capo_transcribe_streaming/types/result.py
class Result(TypedDict, closed=True):
    result_id: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>Provides a unique identifier for the <code>Result</code>.</p>"""
    start_time: "capo_transcribe_streaming.types.double.Double"
    """<p>The start time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"""
    end_time: "capo_transcribe_streaming.types.double.Double"
    """<p>The end time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"""
    is_partial: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Indicates if the segment is complete.</p> <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>"""
    alternatives: NotRequired[
        "capo_transcribe_streaming.types.alternative_list.AlternativeList"
    ]
    """<p>A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>"""
    channel_id: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>Indicates which audio channel is associated with the <code>Result</code>.</p>"""
    language_code: NotRequired[
        "capo_transcribe_streaming.types.language_code.LanguageCode"
    ]
    """<p>The language code that represents the language spoken in your audio stream.</p>"""
    language_identification: NotRequired[
        "capo_transcribe_streaming.types.language_identification.LanguageIdentification"
    ]
    """<p>The language code of the dominant language identified in your stream.</p> <p>If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.</p>"""

alternatives instance-attribute

alternatives: NotRequired[AlternativeList]

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

channel_id instance-attribute

channel_id: NotRequired[String]

Indicates which audio channel is associated with the Result.

end_time instance-attribute

end_time: Double

The end time of the Result in seconds, with millisecond precision (e.g., 1.056).

is_partial instance-attribute

is_partial: Boolean

Indicates if the segment is complete.

If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

language_code instance-attribute

language_code: NotRequired[LanguageCode]

The language code that represents the language spoken in your audio stream.

language_identification instance-attribute

language_identification: NotRequired[LanguageIdentification]

The language code of the dominant language identified in your stream.

If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.

result_id instance-attribute

result_id: NotRequired[String]

Provides a unique identifier for the Result.

start_time instance-attribute

start_time: Double

The start time of the Result in seconds, with millisecond precision (e.g., 1.056).