amazonka-frauddetector-2.0: Amazon Fraud Detector 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.FraudDetector.Types.VariableImpactExplanation

Description

 
Synopsis

Documentation

data VariableImpactExplanation Source #

The details of the event variable's impact on the prediction score.

See: newVariableImpactExplanation smart constructor.

Constructors

VariableImpactExplanation' 

Fields

  • eventVariableName :: Maybe Text

    The event variable name.

  • logOddsImpact :: Maybe Double

    The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.

    • A positive value indicates that the variable drove the risk score up.
    • A negative value indicates that the variable drove the risk score down.
  • relativeImpact :: Maybe Text

    The event variable's relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.

Instances

Instances details
FromJSON VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

Generic VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

Associated Types

type Rep VariableImpactExplanation :: Type -> Type #

Read VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

Show VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

NFData VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

Eq VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

Hashable VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

type Rep VariableImpactExplanation Source # 
Instance details

Defined in Amazonka.FraudDetector.Types.VariableImpactExplanation

type Rep VariableImpactExplanation = D1 ('MetaData "VariableImpactExplanation" "Amazonka.FraudDetector.Types.VariableImpactExplanation" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "VariableImpactExplanation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventVariableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "logOddsImpact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "relativeImpact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newVariableImpactExplanation :: VariableImpactExplanation Source #

Create a value of VariableImpactExplanation 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:eventVariableName:VariableImpactExplanation', variableImpactExplanation_eventVariableName - The event variable name.

$sel:logOddsImpact:VariableImpactExplanation', variableImpactExplanation_logOddsImpact - The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.

  • A positive value indicates that the variable drove the risk score up.
  • A negative value indicates that the variable drove the risk score down.

$sel:relativeImpact:VariableImpactExplanation', variableImpactExplanation_relativeImpact - The event variable's relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.

variableImpactExplanation_logOddsImpact :: Lens' VariableImpactExplanation (Maybe Double) Source #

The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.

  • A positive value indicates that the variable drove the risk score up.
  • A negative value indicates that the variable drove the risk score down.

variableImpactExplanation_relativeImpact :: Lens' VariableImpactExplanation (Maybe Text) Source #

The event variable's relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.