Skip to content

EnrollmentJobFraudDetectionConfig

Source code in docs_src/capo_voice_id/types/enrollment_job_fraud_detection_config.py
class EnrollmentJobFraudDetectionConfig(TypedDict, closed=True):
    fraud_detection_action: NotRequired[
        "capo_voice_id.types.fraud_detection_action.FraudDetectionAction"
    ]
    """<p>The action to take when the given speaker is flagged by the fraud detection system. The default value is <code>FAIL</code>, which fails the speaker enrollment. Changing this value to <code>IGNORE</code> results in the speaker being enrolled even if they are flagged by the fraud detection system.</p>"""
    risk_threshold: NotRequired["capo_voice_id.types.score.Score"]
    """<p>Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.</p>"""
    watchlist_ids: NotRequired[
        "capo_voice_id.types.enrollment_job_fraud_detection_config_watchlist_ids.EnrollmentJobFraudDetectionConfigWatchlistIds"
    ]
    """<p>The identifier of watchlists against which fraud detection is performed. </p>"""

fraud_detection_action instance-attribute

fraud_detection_action: NotRequired[FraudDetectionAction]

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

risk_threshold instance-attribute

risk_threshold: NotRequired[Score]

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

watchlist_ids instance-attribute

The identifier of watchlists against which fraud detection is performed.