You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Rekognition::Types::CompareFacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass CompareFacesRequest data as a hash:

{
  source_image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  target_image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  similarity_threshold: 1.0,
  quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
}

Instance Attribute Summary collapse

Instance Attribute Details

#quality_filterString

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Returns:

  • (String)


316
317
318
319
320
321
322
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 316

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold,
  :quality_filter)
  include Aws::Structure
end

#similarity_thresholdFloat

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Returns:

  • (Float)


316
317
318
319
320
321
322
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 316

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold,
  :quality_filter)
  include Aws::Structure
end

#source_imageTypes::Image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:



316
317
318
319
320
321
322
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 316

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold,
  :quality_filter)
  include Aws::Structure
end

#target_imageTypes::Image

The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:



316
317
318
319
320
321
322
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 316

class CompareFacesRequest < Struct.new(
  :source_image,
  :target_image,
  :similarity_threshold,
  :quality_filter)
  include Aws::Structure
end