Skip to content

EvaluateSessionResponse

Source code in docs_src/capo_voice_id/types/evaluate_session_response.py
class EvaluateSessionResponse(TypedDict, closed=True):
    domain_id: NotRequired["capo_voice_id.types.domain_id.DomainId"]
    """<p>The identifier of the domain that contains the session.</p>"""
    session_id: NotRequired["capo_voice_id.types.session_id.SessionId"]
    """<p>The service-generated identifier of the session.</p>"""
    session_name: NotRequired["capo_voice_id.types.session_name.SessionName"]
    """<p>The client-provided name of the session.</p>"""
    streaming_status: NotRequired[
        "capo_voice_id.types.streaming_status.StreamingStatus"
    ]
    """<p>The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.</p>"""
    authentication_result: NotRequired[
        "capo_voice_id.types.authentication_result.AuthenticationResult"
    ]
    """<p>Details resulting from the authentication process, such as authentication decision and authentication score.</p>"""
    fraud_detection_result: NotRequired[
        "capo_voice_id.types.fraud_detection_result.FraudDetectionResult"
    ]
    """<p>Details resulting from the fraud detection process, such as fraud detection decision and risk score.</p>"""

authentication_result instance-attribute

authentication_result: NotRequired[AuthenticationResult]

Details resulting from the authentication process, such as authentication decision and authentication score.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The identifier of the domain that contains the session.

fraud_detection_result instance-attribute

fraud_detection_result: NotRequired[FraudDetectionResult]

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

session_id instance-attribute

session_id: NotRequired[SessionId]

The service-generated identifier of the session.

session_name instance-attribute

session_name: NotRequired[SessionName]

The client-provided name of the session.

streaming_status instance-attribute

streaming_status: NotRequired[StreamingStatus]

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.