AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the CompareFaces operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Rekognition.Model.CompareFacesResponse

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class CompareFacesResponse : AmazonWebServiceResponse

The CompareFacesResponse type exposes the following members

Constructors

NameDescription
Public Method CompareFacesResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property FaceMatches System.Collections.Generic.List<Amazon.Rekognition.Model.CompareFacesMatch>

Gets and sets the property FaceMatches.

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SourceImageFace Amazon.Rekognition.Model.ComparedSourceImageFace

Gets and sets the property SourceImageFace.

The face in the source image that was used for comparison.

Public Property SourceImageOrientationCorrection Amazon.Rekognition.OrientationCorrection

Gets and sets the property SourceImageOrientationCorrection.

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Public Property TargetImageOrientationCorrection Amazon.Rekognition.OrientationCorrection

Gets and sets the property TargetImageOrientationCorrection.

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Public Property UnmatchedFaces System.Collections.Generic.List<Amazon.Rekognition.Model.ComparedFace>

Gets and sets the property UnmatchedFaces.

An array of faces in the target image that did not match the source image face.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5