# SearchFacesByImage For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. **Note** To search for all faces in an input image, you might first call the [IndexFaces](API_IndexFaces.md) operation, and then use the face IDs returned in subsequent calls to the [SearchFaces](API_SearchFaces.md) operation. You can also call the `DetectFaces` operation and use the bounding boxes in the response to make face crops, which then you can pass in to the `SearchFacesByImage` operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The 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 found. Along with the metadata, the response also includes a `similarity` indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. If no faces are detected in the input image, `SearchFacesByImage` returns an `InvalidParameterException` error. For an example, see [Searching for a Face Using an Image](https://docs.aws.amazon.com/rekognition/latest/dg/search-face-with-image-procedure.html). The `QualityFilter` input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use `QualityFilter` to set the quality bar for filtering by specifying `LOW`, `MEDIUM`, or `HIGH`. If you do not want to filter detected faces, specify `NONE`. The default value is `NONE`. **Note** To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call [DescribeCollection](API_DescribeCollection.md). This operation requires permissions to perform the `rekognition:SearchFacesByImage` action. ## Request Syntax ``` { "CollectionId": "string", "FaceMatchThreshold": number, "Image": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "MaxFaces": number, "QualityFilter": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CollectionId](#API_SearchFacesByImage_RequestSyntax) ** ID of the collection to search. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[a-zA-Z0-9_.\-]+` Required: Yes ** [FaceMatchThreshold](#API_SearchFacesByImage_RequestSyntax) ** (Optional) Specifies 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 ** [Image](#API_SearchFacesByImage_RequestSyntax) ** The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the `Bytes` field. For more information, see [Image specifications](https://docs.aws.amazon.com/rekognition/latest/dg/images-information.html). Type: [Image](API_Image.md) object Required: Yes ** [MaxFaces](#API_SearchFacesByImage_RequestSyntax) ** 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 ** [QualityFilter](#API_SearchFacesByImage_RequestSyntax) ** A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify `AUTO`, Amazon Rekognition chooses the quality bar. If you specify `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify `NONE`, no filtering is performed. The default value is `NONE`. To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher. Type: String Valid Values: `NONE | AUTO | LOW | MEDIUM | HIGH` 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", "SearchedFaceBoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "SearchedFaceConfidence": number } ``` ## 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](#API_SearchFacesByImage_ResponseSyntax) ** An array of faces that match the input face, along with the confidence in the match. Type: Array of [FaceMatch](API_FaceMatch.md) objects ** [FaceModelVersion](#API_SearchFacesByImage_ResponseSyntax) ** Version number of the face detection model associated with the input collection (`CollectionId`). Type: String ** [SearchedFaceBoundingBox](#API_SearchFacesByImage_ResponseSyntax) ** The bounding box around the face in the input image that Amazon Rekognition used for the search. Type: [BoundingBox](API_BoundingBox.md) object ** [SearchedFaceConfidence](#API_SearchFacesByImage_ResponseSyntax) ** The level of confidence that the `searchedFaceBoundingBox`, contains a face. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You are not authorized to perform the action. HTTP Status Code: 400 ** ImageTooLargeException ** The input image size exceeds the allowed limit. If you are calling [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md), the image size or resolution exceeds the allowed limit. For more information, see [Guidelines and quotas in Amazon Rekognition](https://docs.aws.amazon.com/rekognition/latest/dg/limits.html). HTTP Status Code: 400 ** InternalServerError ** Amazon Rekognition experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidImageFormatException ** The provided image format is not supported. HTTP Status Code: 400 ** InvalidParameterException ** Input parameter violated a constraint. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Rekognition is unable to access the S3 object specified in the request. 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rekognition-2016-06-27/SearchFacesByImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SearchFacesByImage)