Skip to content

AuthenticationResult

Source code in docs_src/capo_voice_id/types/authentication_result.py
class AuthenticationResult(TypedDict, closed=True):
    authentication_result_id: NotRequired[
        "capo_voice_id.types.unique_id_large.UniqueIdLarge"
    ]
    """<p>The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code> changes, Voice ID always returns cached Authentication Result for this API.</p>"""
    audio_aggregation_started_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when audio aggregation started for this authentication result.</p>"""
    audio_aggregation_ended_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when audio aggregation ended for this authentication result.</p>"""
    customer_speaker_id: NotRequired[
        "capo_voice_id.types.customer_speaker_id.CustomerSpeakerId"
    ]
    """<p>The client-provided identifier for the speaker whose authentication result is produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>"""
    generated_speaker_id: NotRequired[
        "capo_voice_id.types.generated_speaker_id.GeneratedSpeakerId"
    ]
    """<p>The service-generated identifier for the speaker whose authentication result is produced.</p>"""
    decision: NotRequired[
        "capo_voice_id.types.authentication_decision.AuthenticationDecision"
    ]
    """<p>The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.</p>"""
    score: NotRequired["capo_voice_id.types.score.Score"]
    """<p>The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either <code>ACCEPT</code> or <code>REJECT</code>.</p>"""
    configuration: NotRequired[
        "capo_voice_id.types.authentication_configuration.AuthenticationConfiguration"
    ]
    """<p>The <code>AuthenticationConfiguration</code> used to generate this authentication result.</p>"""

audio_aggregation_ended_at instance-attribute

audio_aggregation_ended_at: NotRequired[Timestamp]

A timestamp of when audio aggregation ended for this authentication result.

audio_aggregation_started_at instance-attribute

audio_aggregation_started_at: NotRequired[Timestamp]

A timestamp of when audio aggregation started for this authentication result.

authentication_result_id instance-attribute

authentication_result_id: NotRequired[UniqueIdLarge]

The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

configuration instance-attribute

configuration: NotRequired[AuthenticationConfiguration]

The AuthenticationConfiguration used to generate this authentication result.

customer_speaker_id instance-attribute

customer_speaker_id: NotRequired[CustomerSpeakerId]

The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

decision instance-attribute

decision: NotRequired[AuthenticationDecision]

The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

generated_speaker_id instance-attribute

generated_speaker_id: NotRequired[GeneratedSpeakerId]

The service-generated identifier for the speaker whose authentication result is produced.

score instance-attribute

score: NotRequired[Score]

The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.