aws-sdk-frauddetector 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b8efd1c69e484d5f59cbf3a0b409eeca74444fdcf73f2004d10766256fa923e
-  data.tar.gz: 6cbf59696fa93173a7f93484f54998ff22ae5258bfa6833694bb3d3efb6c6692
+  metadata.gz: bbd86904fddba909c196b603b40635be5efae07efe43f60bb87365c3535fbc0e
+  data.tar.gz: dbc24ed06586e6163e83a7f0167e855e49128fb91a75c34d77e6dd0bcb85775c
 SHA512:
-  metadata.gz: f20b1dacc4eb1f56b46bc2601e3d55425df51caa26b0b95dd8ee6080a4dbf7d40a5955a5db1ea5e485d38cb3157796167d62d94d47fafd46232a8596fa1095cc
-  data.tar.gz: d51893a1ea7dfaa579db5756b02bebd071decc18a2d40f7d6c33c29b217d386e6b3e3b09300a74b90e4b53469241667d6ea7d393ec4863ad9f94b038fd6afa75
+  metadata.gz: 8369d73396a68183c669a68fedfb3751d758efb8a8058d519b4673d7572eea38551bcfbeb899e5450caa5963c6dc1f9f209b93caceb0e4cf11a19b3e08eed7b1
+  data.tar.gz: 36f9ca8489fc3f5a7a9b9d8844bfd2d16e99e4769e5c4369347cde59cc6292f440f6b0899797465dd4b82c3fc8cbd01c60532f2d40b40a1228ccf2d5bb836ace

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2021-07-09)
+------------------
+
+* Feature - This release adds support for ML Explainability to display model variable importance value in Amazon Fraud Detector.
+
 1.18.0 (2021-03-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.19.0

data/lib/aws-sdk-frauddetector.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-frauddetector/customizations'
 # @!group service
 module Aws::FraudDetector
 
-  GEM_VERSION = '1.18.0'
+  GEM_VERSION = '1.19.0'
 
 end

data/lib/aws-sdk-frauddetector/client.rb

@@ -1329,6 +1329,10 @@ module Aws::FraudDetector
     #   resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].precision #=> Float
     #   resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].tpr #=> Float
     #   resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].threshold #=> Float
+    #   resp.model_version_details[0].training_result.variable_importance_metrics.logit_metrics #=> Array
+    #   resp.model_version_details[0].training_result.variable_importance_metrics.logit_metrics[0].variable_name #=> String
+    #   resp.model_version_details[0].training_result.variable_importance_metrics.logit_metrics[0].variable_type #=> String
+    #   resp.model_version_details[0].training_result.variable_importance_metrics.logit_metrics[0].variable_importance #=> Float
     #   resp.model_version_details[0].last_updated_time #=> String
     #   resp.model_version_details[0].created_time #=> String
     #   resp.model_version_details[0].arn #=> String
@@ -1596,6 +1600,30 @@ module Aws::FraudDetector
     #   Detector to represent data elements and their corresponding values for
     #   the event you are sending for evaluation.
     #
+    #   * You must provide at least one eventVariable
+    #
+    #   * If detectorVersion is associated with a modelVersion, you must
+    #     provide at least one associated eventVariable
+    #
+    #   To ensure highest possible fraud prediction and to simplify your data
+    #   preparation, Amazon Fraud Detector will replace all missing variables
+    #   or values as follows:
+    #
+    #   **For Amazon Fraud Detector trained models:**
+    #
+    #   If a null value is provided explicitly for a variable or if a variable
+    #   is missing, model will replace the null value or the missing variable
+    #   (no variable name in the eventVariables map) with calculated default
+    #   mean/medians for numeric variables and with special values for
+    #   categorical variables.
+    #
+    #   **For External models ( for example, imported SageMaker):**
+    #
+    #   If a null value is provided explicitly for a variable, the model and
+    #   rules will use “null” as the value. If a variable is not provided (no
+    #   variable name in the eventVariables map), model and rules will use the
+    #   default value that is provided for the variable.
+    #
     # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
     #   The Amazon SageMaker model endpoint input data blobs.
     #
@@ -2942,7 +2970,7 @@ module Aws::FraudDetector
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-frauddetector'
-      context[:gem_version] = '1.18.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-frauddetector/client_api.rb

@@ -127,12 +127,14 @@ module Aws::FraudDetector
     Label = Shapes::StructureShape.new(name: 'Label')
     LabelSchema = Shapes::StructureShape.new(name: 'LabelSchema')
     Language = Shapes::StringShape.new(name: 'Language')
+    ListOfLogitMetrics = Shapes::ListShape.new(name: 'ListOfLogitMetrics')
     ListOfModelScores = Shapes::ListShape.new(name: 'ListOfModelScores')
     ListOfModelVersions = Shapes::ListShape.new(name: 'ListOfModelVersions')
     ListOfRuleResults = Shapes::ListShape.new(name: 'ListOfRuleResults')
     ListOfStrings = Shapes::ListShape.new(name: 'ListOfStrings')
     ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
     ListTagsForResourceResult = Shapes::StructureShape.new(name: 'ListTagsForResourceResult')
+    LogitMetric = Shapes::StructureShape.new(name: 'LogitMetric')
     MetricDataPoint = Shapes::StructureShape.new(name: 'MetricDataPoint')
     Model = Shapes::StructureShape.new(name: 'Model')
     ModelEndpointDataBlob = Shapes::StructureShape.new(name: 'ModelEndpointDataBlob')
@@ -209,6 +211,7 @@ module Aws::FraudDetector
     Variable = Shapes::StructureShape.new(name: 'Variable')
     VariableEntry = Shapes::StructureShape.new(name: 'VariableEntry')
     VariableEntryList = Shapes::ListShape.new(name: 'VariableEntryList')
+    VariableImportanceMetrics = Shapes::StructureShape.new(name: 'VariableImportanceMetrics')
     VariableList = Shapes::ListShape.new(name: 'VariableList')
     VariablesMaxResults = Shapes::IntegerShape.new(name: 'VariablesMaxResults')
     batchPredictionsMaxPageSize = Shapes::IntegerShape.new(name: 'batchPredictionsMaxPageSize')
@@ -714,6 +717,8 @@ module Aws::FraudDetector
     LabelSchema.add_member(:label_mapper, Shapes::ShapeRef.new(shape: labelMapper, required: true, location_name: "labelMapper"))
     LabelSchema.struct_class = Types::LabelSchema
 
+    ListOfLogitMetrics.member = Shapes::ShapeRef.new(shape: LogitMetric)
+
     ListOfModelScores.member = Shapes::ShapeRef.new(shape: ModelScores)
 
     ListOfModelVersions.member = Shapes::ShapeRef.new(shape: ModelVersion)
@@ -731,6 +736,11 @@ module Aws::FraudDetector
     ListTagsForResourceResult.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
     ListTagsForResourceResult.struct_class = Types::ListTagsForResourceResult
 
+    LogitMetric.add_member(:variable_name, Shapes::ShapeRef.new(shape: string, required: true, location_name: "variableName"))
+    LogitMetric.add_member(:variable_type, Shapes::ShapeRef.new(shape: string, required: true, location_name: "variableType"))
+    LogitMetric.add_member(:variable_importance, Shapes::ShapeRef.new(shape: float, required: true, location_name: "variableImportance"))
+    LogitMetric.struct_class = Types::LogitMetric
+
     MetricDataPoint.add_member(:fpr, Shapes::ShapeRef.new(shape: float, location_name: "fpr"))
     MetricDataPoint.add_member(:precision, Shapes::ShapeRef.new(shape: float, location_name: "precision"))
     MetricDataPoint.add_member(:tpr, Shapes::ShapeRef.new(shape: float, location_name: "tpr"))
@@ -907,6 +917,7 @@ module Aws::FraudDetector
 
     TrainingResult.add_member(:data_validation_metrics, Shapes::ShapeRef.new(shape: DataValidationMetrics, location_name: "dataValidationMetrics"))
     TrainingResult.add_member(:training_metrics, Shapes::ShapeRef.new(shape: TrainingMetrics, location_name: "trainingMetrics"))
+    TrainingResult.add_member(:variable_importance_metrics, Shapes::ShapeRef.new(shape: VariableImportanceMetrics, location_name: "variableImportanceMetrics"))
     TrainingResult.struct_class = Types::TrainingResult
 
     UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: fraudDetectorArn, required: true, location_name: "resourceARN"))
@@ -1017,6 +1028,9 @@ module Aws::FraudDetector
 
     VariableEntryList.member = Shapes::ShapeRef.new(shape: VariableEntry)
 
+    VariableImportanceMetrics.add_member(:logit_metrics, Shapes::ShapeRef.new(shape: ListOfLogitMetrics, location_name: "LogitMetrics"))
+    VariableImportanceMetrics.struct_class = Types::VariableImportanceMetrics
+
     VariableList.member = Shapes::ShapeRef.new(shape: Variable)
 
     entityTypeList.member = Shapes::ShapeRef.new(shape: EntityType)
@@ -1107,6 +1121,7 @@ module Aws::FraudDetector
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
       api.add_operation(:create_detector_version, Seahorse::Model::Operation.new.tap do |o|

data/lib/aws-sdk-frauddetector/types.rb

@@ -1855,6 +1855,30 @@ module Aws::FraudDetector
     #   Names of the event type's variables you defined in Amazon Fraud
     #   Detector to represent data elements and their corresponding values
     #   for the event you are sending for evaluation.
+    #
+    #   * You must provide at least one eventVariable
+    #
+    #   * If detectorVersion is associated with a modelVersion, you must
+    #     provide at least one associated eventVariable
+    #
+    #   To ensure highest possible fraud prediction and to simplify your
+    #   data preparation, Amazon Fraud Detector will replace all missing
+    #   variables or values as follows:
+    #
+    #   **For Amazon Fraud Detector trained models:**
+    #
+    #   If a null value is provided explicitly for a variable or if a
+    #   variable is missing, model will replace the null value or the
+    #   missing variable (no variable name in the eventVariables map) with
+    #   calculated default mean/medians for numeric variables and with
+    #   special values for categorical variables.
+    #
+    #   **For External models ( for example, imported SageMaker):**
+    #
+    #   If a null value is provided explicitly for a variable, the model and
+    #   rules will use “null” as the value. If a variable is not provided
+    #   (no variable name in the eventVariables map), model and rules will
+    #   use the default value that is provided for the variable.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] external_model_endpoint_data_blobs
@@ -2502,6 +2526,30 @@ module Aws::FraudDetector
       include Aws::Structure
     end
 
+    # The logit metric details.
+    #
+    # @!attribute [rw] variable_name
+    #   The name of the variable.
+    #   @return [String]
+    #
+    # @!attribute [rw] variable_type
+    #   The type of variable.
+    #   @return [String]
+    #
+    # @!attribute [rw] variable_importance
+    #   The relative importance of the variable.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LogitMetric AWS API Documentation
+    #
+    class LogitMetric < Struct.new(
+      :variable_name,
+      :variable_type,
+      :variable_importance)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Model performance metrics data points.
     #
     # @!attribute [rw] fpr
@@ -3445,11 +3493,16 @@ module Aws::FraudDetector
     #   The training metric details.
     #   @return [Types::TrainingMetrics]
     #
+    # @!attribute [rw] variable_importance_metrics
+    #   The variable importance metrics.
+    #   @return [Types::VariableImportanceMetrics]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingResult AWS API Documentation
     #
     class TrainingResult < Struct.new(
       :data_validation_metrics,
-      :training_metrics)
+      :training_metrics,
+      :variable_importance_metrics)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4089,5 +4142,19 @@ module Aws::FraudDetector
       include Aws::Structure
     end
 
+    # The variable importance metrics details.
+    #
+    # @!attribute [rw] logit_metrics
+    #   List of variable metrics.
+    #   @return [Array<Types::LogitMetric>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableImportanceMetrics AWS API Documentation
+    #
+    class VariableImportanceMetrics < Struct.new(
+      :logit_metrics)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-frauddetector
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Fraud Detector