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.

Container for the parameters to the SearchFaces operation. For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFaces action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.SearchFacesRequest

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

Syntax

C#
public class SearchFacesRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The SearchFacesRequest type exposes the following members

Constructors

NameDescription
Public Method SearchFacesRequest()

Properties

NameTypeDescription
Public Property CollectionId System.String

Gets and sets the property CollectionId.

ID of the collection the face belongs to.

Public Property FaceId System.String

Gets and sets the property FaceId.

ID of a face to find matches for in the collection.

Public Property FaceMatchThreshold System.Single

Gets and sets the property FaceMatchThreshold.

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Public Property MaxFaces System.Int32

Gets and sets the property MaxFaces.

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Examples

This operation searches for matching faces in the collection the supplied face belongs to.

To delete a face


var response = client.DeleteFaces(new DeleteFacesRequest 
{
    CollectionId = "myphotos",
    FaceIds = new List {
        "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
    }
});

List deletedFaces = response.DeletedFaces;

            

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