Package software.amazon.awssdk.services.frauddetector.model

Class PredictionExplanations

java.lang.Object
software.amazon.awssdk.services.frauddetector.model.PredictionExplanations
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PredictionExplanations.Builder,PredictionExplanations>
@Generated("software.amazon.awssdk:codegen") public final class PredictionExplanations extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PredictionExplanations.Builder,PredictionExplanations>

The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.

See Also:

  • Method Details

    • hasVariableImpactExplanations

      public final boolean hasVariableImpactExplanations()
      For responses, this returns true if the service returned a value for the VariableImpactExplanations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • variableImpactExplanations

      public final List<VariableImpactExplanation> variableImpactExplanations()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariableImpactExplanations() method.

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

    • hasAggregatedVariablesImpactExplanations

      public final boolean hasAggregatedVariablesImpactExplanations()
      For responses, this returns true if the service returned a value for the AggregatedVariablesImpactExplanations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • aggregatedVariablesImpactExplanations

      public final List<AggregatedVariablesImpactExplanation> aggregatedVariablesImpactExplanations()

      The details of the aggregated variables impact on the prediction score.

      Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggregatedVariablesImpactExplanations() method.

      Returns:
      The details of the aggregated variables impact on the prediction score.

      Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

    • toBuilder

      public PredictionExplanations.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PredictionExplanations.Builder,PredictionExplanations>
      Returns:
      a builder for type T

    • builder

      public static PredictionExplanations.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PredictionExplanations.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.