SearchFacesByImageResponse Class | AWS SDK for .NET V3

This is the response object from the SearchFacesByImage operation.

Inheritance Hierarchy

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

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

Syntax

public class SearchFacesByImageResponse : AmazonWebServiceResponse

The SearchFacesByImageResponse type exposes the following members

Constructors

	Name	Description
	SearchFacesByImageResponse()

Properties

Name	Type	Description
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
FaceMatches	System.Collections.Generic.List<Amazon.Rekognition.Model.FaceMatch>	Gets and sets the property FaceMatches. An array of faces that match the input face, along with the confidence in the match.
FaceModelVersion	System.String	Gets and sets the property FaceModelVersion. Version number of the face detection model associated with the input collection (`CollectionId`).
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
SearchedFaceBoundingBox	Amazon.Rekognition.Model.BoundingBox	Gets and sets the property SearchedFaceBoundingBox. The bounding box around the face in the input image that Amazon Rekognition used for the search.
SearchedFaceConfidence	System.Single	Gets and sets the property SearchedFaceConfidence. The level of confidence that the `searchedFaceBoundingBox`, contains a face.

Examples

This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.

To search for faces matching a supplied image


var client = new AmazonRekognitionClient();
var response = client.SearchFacesByImage(new SearchFacesByImageRequest 
{
    CollectionId = "myphotos",
    FaceMatchThreshold = 95,
    Image = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "myphoto"
    } },
    MaxFaces = 5
});

List<FaceMatch> faceMatches = response.FaceMatches;
BoundingBox searchedFaceBoundingBox = response.SearchedFaceBoundingBox;
float searchedFaceConfidence = response.SearchedFaceConfidence;

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