Skip to contents

Compares a face in the source input image with each of the 100 largest faces detected in the target input image

Source: R/rekognition_operations.R
rekognition_compare_faces.Rd

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

See https://www.paws-r-sdk.com/docs/rekognition_compare_faces/ for full documentation.

Usage

rekognition_compare_faces(
  SourceImage,
  TargetImage,
  SimilarityThreshold = NULL,
  QualityFilter = NULL
)

Arguments

SourceImage

[required] 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.

TargetImage

[required] 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.

SimilarityThreshold

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

QualityFilter

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.