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 Searching for a face using its face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public class SearchFacesRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The SearchFacesRequest type exposes the following members
Name | Description | |
---|---|---|
SearchFacesRequest() |
Name | Type | Description | |
---|---|---|---|
CollectionId | System.String |
Gets and sets the property CollectionId. ID of the collection the face belongs to. |
|
FaceId | System.String |
Gets and sets the property FaceId. ID of a face to find matches for in the collection. |
|
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%. The default value is 80%. |
|
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. |
This operation searches for matching faces in the collection the supplied face belongs to.
var client = new AmazonRekognitionClient(); var response = client.DeleteFaces(new DeleteFacesRequest { CollectionId = "myphotos", FaceIds = new List<string> { "ff43d742-0c13-5d16-a3e8-03d3f58e980b" } }); List<string> deletedFaces = response.DeletedFaces;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5