SearchFaces
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.
Note
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.
This operation requires permissions to perform the rekognition:SearchFaces
action.
Request Syntax
{
"CollectionId": "string",
"FaceId": "string",
"FaceMatchThreshold": number,
"MaxFaces": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CollectionId
-
ID of the collection the face belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.\-]+Required: Yes
- FaceId
-
ID of a face to find matches for in the collection.
Type: String
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: Yes
- 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%.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- MaxFaces
-
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 4096.
Required: No
Response Syntax
{
"FaceMatches": [
{
"Face": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Confidence": number,
"ExternalImageId": "string",
"FaceId": "string",
"ImageId": "string",
"IndexFacesModelVersion": "string",
"UserId": "string"
},
"Similarity": number
}
],
"FaceModelVersion": "string",
"SearchedFaceId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FaceMatches
-
An array of faces that matched the input face, along with the confidence in the match.
Type: Array of FaceMatch objects
- FaceModelVersion
-
Version number of the face detection model associated with the input collection (
CollectionId).Type: String
- SearchedFaceId
-
ID of the face that was searched for matches in a collection.
Type: String
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
