amazonka-voice-id-2.0: Amazon Voice ID SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Description

 
Synopsis

Documentation

data EnrollmentJobFraudDetectionConfig Source #

The configuration defining the action to take when a speaker is flagged by the fraud detection system during a batch speaker enrollment job, and the risk threshold to use for identification.

See: newEnrollmentJobFraudDetectionConfig smart constructor.

Constructors

EnrollmentJobFraudDetectionConfig' 

Fields

  • fraudDetectionAction :: Maybe 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.

  • riskThreshold :: Maybe Natural

    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.

Instances

Instances details
FromJSON EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

ToJSON EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Generic EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Associated Types

type Rep EnrollmentJobFraudDetectionConfig :: Type -> Type #

Read EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Show EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

NFData EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Eq EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

Hashable EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

type Rep EnrollmentJobFraudDetectionConfig Source # 
Instance details

Defined in Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig

type Rep EnrollmentJobFraudDetectionConfig = D1 ('MetaData "EnrollmentJobFraudDetectionConfig" "Amazonka.VoiceId.Types.EnrollmentJobFraudDetectionConfig" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "EnrollmentJobFraudDetectionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fraudDetectionAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudDetectionAction)) :*: S1 ('MetaSel ('Just "riskThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newEnrollmentJobFraudDetectionConfig :: EnrollmentJobFraudDetectionConfig Source #

Create a value of EnrollmentJobFraudDetectionConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fraudDetectionAction:EnrollmentJobFraudDetectionConfig', enrollmentJobFraudDetectionConfig_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.

$sel:riskThreshold:EnrollmentJobFraudDetectionConfig', enrollmentJobFraudDetectionConfig_riskThreshold - 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.

enrollmentJobFraudDetectionConfig_fraudDetectionAction :: Lens' EnrollmentJobFraudDetectionConfig (Maybe FraudDetectionAction) Source #

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.

enrollmentJobFraudDetectionConfig_riskThreshold :: Lens' EnrollmentJobFraudDetectionConfig (Maybe Natural) Source #

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.