Skip to content

UtteranceEvent

Source code in docs_src/capo_transcribe_streaming/types/utterance_event.py
class UtteranceEvent(TypedDict, closed=True):
    utterance_id: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>The unique identifier that is associated with the specified <code>UtteranceEvent</code>.</p>"""
    is_partial: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Indicates whether the segment in the <code>UtteranceEvent</code> is complete (<code>FALSE</code>) or partial (<code>TRUE</code>).</p>"""
    participant_role: NotRequired[
        "capo_transcribe_streaming.types.participant_role.ParticipantRole"
    ]
    """<p>Provides the role of the speaker for each audio channel, either <code>CUSTOMER</code> or <code>AGENT</code>.</p>"""
    begin_offset_millis: NotRequired["capo_transcribe_streaming.types.long.Long"]
    """<p>The time, in milliseconds, from the beginning of the audio stream to the start of the <code>UtteranceEvent</code>.</p>"""
    end_offset_millis: NotRequired["capo_transcribe_streaming.types.long.Long"]
    """<p>The time, in milliseconds, from the beginning of the audio stream to the start of the <code>UtteranceEvent</code>.</p>"""
    transcript: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>Contains transcribed text.</p>"""
    items: NotRequired[
        "capo_transcribe_streaming.types.call_analytics_item_list.CallAnalyticsItemList"
    ]
    """<p>Contains words, phrases, or punctuation marks that are associated with the specified <code>UtteranceEvent</code>.</p>"""
    entities: NotRequired[
        "capo_transcribe_streaming.types.call_analytics_entity_list.CallAnalyticsEntityList"
    ]
    """<p>Contains entities identified as personally identifiable information (PII) in your transcription output.</p>"""
    sentiment: NotRequired["capo_transcribe_streaming.types.sentiment.Sentiment"]
    """<p>Provides the sentiment that was detected in the specified segment.</p>"""
    issues_detected: NotRequired[
        "capo_transcribe_streaming.types.issues_detected.IssuesDetected"
    ]
    """<p>Provides the issue that was detected in the specified segment.</p>"""
    language_code: NotRequired[
        "capo_transcribe_streaming.types.call_analytics_language_code.CallAnalyticsLanguageCode"
    ]
    """<p>The language code that represents the language spoken in your audio stream.</p>"""
    language_identification: NotRequired[
        "capo_transcribe_streaming.types.call_analytics_language_identification.CallAnalyticsLanguageIdentification"
    ]
    """<p>The language code of the dominant language identified in your stream.</p>"""

begin_offset_millis instance-attribute

begin_offset_millis: NotRequired[Long]

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

end_offset_millis instance-attribute

end_offset_millis: NotRequired[Long]

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

entities instance-attribute

entities: NotRequired[CallAnalyticsEntityList]

Contains entities identified as personally identifiable information (PII) in your transcription output.

is_partial instance-attribute

is_partial: Boolean

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

issues_detected instance-attribute

issues_detected: NotRequired[IssuesDetected]

Provides the issue that was detected in the specified segment.

items instance-attribute

items: NotRequired[CallAnalyticsItemList]

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

language_code instance-attribute

language_code: NotRequired[CallAnalyticsLanguageCode]

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

language_identification instance-attribute

language_identification: NotRequired[CallAnalyticsLanguageIdentification]

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

participant_role instance-attribute

participant_role: NotRequired[ParticipantRole]

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

sentiment instance-attribute

sentiment: NotRequired[Sentiment]

Provides the sentiment that was detected in the specified segment.

transcript instance-attribute

transcript: NotRequired[String]

Contains transcribed text.

utterance_id instance-attribute

utterance_id: NotRequired[String]

The unique identifier that is associated with the specified UtteranceEvent.