Skip to content

CallAnalyticsEntity

Source code in docs_src/capo_transcribe_streaming/types/call_analytics_entity.py
class CallAnalyticsEntity(TypedDict, closed=True):
    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 identified entity.</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 end of the identified entity.</p>"""
    category: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>The category of information identified. For example, <code>PII</code>.</p>"""
    type: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>The type of PII identified. For example, <code>NAME</code> or <code>CREDIT_DEBIT_NUMBER</code>.</p>"""
    content: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>The word or words that represent the identified entity.</p>"""
    confidence: NotRequired["capo_transcribe_streaming.types.confidence.Confidence"]
    """<p>The confidence score associated with the identification of an entity in your transcript.</p> <p>Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.</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 identified entity.

category instance-attribute

category: NotRequired[String]

The category of information identified. For example, PII.

confidence instance-attribute

confidence: NotRequired[Confidence]

The confidence score associated with the identification of an entity in your transcript.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

content instance-attribute

content: NotRequired[String]

The word or words that represent the identified entity.

end_offset_millis instance-attribute

end_offset_millis: NotRequired[Long]

The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.

type instance-attribute

type: NotRequired[String]

The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.