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

C#
public class SearchFacesByImageResponse : AmazonWebServiceResponse

The SearchFacesByImageResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property 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.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property 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.

Public Property 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 response = client.SearchFacesByImage(new SearchFacesByImageRequest 
{
    CollectionId = "myphotos",
    FaceMatchThreshold = 95,
    Image = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "myphoto"
    } },
    MaxFaces = 5
});

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

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms