Container for the parameters to the CompareFaces operation. Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.
CompareFaces uses machine learning algorithms, which are probabilistic. A false negative
is an incorrect prediction that a face in the target image has a low similarity confidence
score when compared to the face in the source image. To reduce the probability of
false negatives, we recommend that you compare the target image against multiple source
images. If you plan to use CompareFaces to make a decision that impacts an
individual's rights, privacy, or access to services, we recommend that you pass the
result to a human for review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.
By default, only faces with a similarity score of greater than or equal to 80% are
returned in the response. You can change this value by specifying the SimilarityThreshold
parameter.
CompareFaces also returns an array of faces that don't match the source image.
For each face, it returns a bounding box, confidence value, landmarks, pose details,
and quality. The response also returns information about the face in the source image,
including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces that
don’t meet a required quality bar. The quality bar is based on a variety of common
use cases. Use QualityFilter to set the quality bar by specifying LOW,
MEDIUM, or HIGH. If you do not want to filter detected faces, specify
NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns orientation
information for the source and target images. Use these values to display the images
with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces returns
an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't persist.
For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:CompareFaces
action.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Rekognition.AmazonRekognitionRequest
Amazon.Rekognition.Model.CompareFacesRequest
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
Syntax
public class CompareFacesRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The CompareFacesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CompareFacesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
QualityFilter | Amazon.Rekognition.QualityFilter |
Gets and sets the property 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 To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher. |
|
|
SimilarityThreshold | System.Single |
Gets and sets the property SimilarityThreshold.
The minimum level of confidence in the face matches that a match must meet to be included
in the |
|
|
SourceImage | Amazon.Rekognition.Model.Image |
Gets and sets the property SourceImage. 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 |
|
|
TargetImage | Amazon.Rekognition.Model.Image |
Gets and sets the property TargetImage. 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 |
Examples
This operation compares the largest face detected in the source image with each face detected in the target image.
To compare two images
var client = new AmazonRekognitionClient();
var response = client.CompareFaces(new CompareFacesRequest
{
SimilarityThreshold = 90,
SourceImage = new Image { S3Object = new S3Object {
Bucket = "mybucket",
Name = "mysourceimage"
} },
TargetImage = new Image { S3Object = new S3Object {
Bucket = "mybucket",
Name = "mytargetimage"
} }
});
List<CompareFacesMatch> faceMatches = response.FaceMatches;
ComparedSourceImageFace sourceImageFace = response.SourceImageFace;
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5