getEventPrediction method

Future<GetEventPredictionResult> getEventPrediction({ required String detectorId, required List<Entity> entities, required String eventId, required String eventTimestamp, required String eventTypeName, required Map<String, String> eventVariables, String? detectorVersionId, Map<String, ModelEndpointDataBlob>? externalModelEndpointDataBlobs, })

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ResourceUnavailableException. May throw ThrottlingException. May throw ValidationException.

Parameter detectorId : The detector ID.

Parameter entities : The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

Parameter eventId : The unique ID used to identify the event.

Parameter eventTimestamp : Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

Parameter eventTypeName : The event type associated with the detector specified for the prediction.

Parameter eventVariables : 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. To ensure most accurate 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 imported SageMaker models:

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.

Parameter detectorVersionId : The detector version ID.

Parameter externalModelEndpointDataBlobs : The Amazon SageMaker model endpoint input data blobs.

Implementation

Future<GetEventPredictionResult> getEventPrediction({
  required String detectorId,
  required List<Entity> entities,
  required String eventId,
  required String eventTimestamp,
  required String eventTypeName,
  required Map<String, String> eventVariables,
  String? detectorVersionId,
  Map<String, ModelEndpointDataBlob>? externalModelEndpointDataBlobs,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSHawksNestServiceFacade.GetEventPrediction'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'detectorId': detectorId,
      'entities': entities,
      'eventId': eventId,
      'eventTimestamp': eventTimestamp,
      'eventTypeName': eventTypeName,
      'eventVariables': eventVariables,
      if (detectorVersionId != null) 'detectorVersionId': detectorVersionId,
      if (externalModelEndpointDataBlobs != null)
        'externalModelEndpointDataBlobs': externalModelEndpointDataBlobs,
    },
  );

  return GetEventPredictionResult.fromJson(jsonResponse.body);
}