Skip to content

FraudDetectionResult

Source code in docs_src/capo_voice_id/types/fraud_detection_result.py
class FraudDetectionResult(TypedDict, closed=True):
    fraud_detection_result_id: NotRequired[
        "capo_voice_id.types.unique_id_large.UniqueIdLarge"
    ]
    """<p>The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection 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 fraud detection result.</p>"""
    audio_aggregation_ended_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when audio aggregation ended for this fraud detection result.</p>"""
    configuration: NotRequired[
        "capo_voice_id.types.fraud_detection_configuration.FraudDetectionConfiguration"
    ]
    """<p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection result.</p>"""
    decision: NotRequired[
        "capo_voice_id.types.fraud_detection_decision.FraudDetectionDecision"
    ]
    """<p>The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.</p>"""
    reasons: NotRequired[
        "capo_voice_id.types.fraud_detection_reasons.FraudDetectionReasons"
    ]
    """<p>The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is <code>HIGH_RISK</code>, and the following possible values: <code>KNOWN_FRAUDSTER</code> and <code>VOICE_SPOOFING</code>.</p>"""
    risk_details: NotRequired["capo_voice_id.types.fraud_risk_details.FraudRiskDetails"]
    """<p>Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.</p>"""

audio_aggregation_ended_at instance-attribute

audio_aggregation_ended_at: NotRequired[Timestamp]

A timestamp of when audio aggregation ended for this fraud detection result.

audio_aggregation_started_at instance-attribute

audio_aggregation_started_at: NotRequired[Timestamp]

A timestamp of when audio aggregation started for this fraud detection result.

configuration instance-attribute

configuration: NotRequired[FraudDetectionConfiguration]

The FraudDetectionConfiguration used to generate this fraud detection result.

decision instance-attribute

decision: NotRequired[FraudDetectionDecision]

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

fraud_detection_result_id instance-attribute

fraud_detection_result_id: NotRequired[UniqueIdLarge]

The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

reasons instance-attribute

reasons: NotRequired[FraudDetectionReasons]

The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

risk_details instance-attribute

risk_details: NotRequired[FraudRiskDetails]

Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.