class Aws::Rekognition::Types::CompareFacesRequest

@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
    }

@!attribute [rw] source_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.
@return [Types::Image]

@!attribute [rw] target_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.
@return [Types::Image]

@!attribute [rw] similarity_threshold

The minimum level of confidence in the face matches that a match
must meet to be included in the `FaceMatches` array.
@return [Float]

@!attribute [rw] quality_filter

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.
@return [String]

Constants

SENSITIVE