Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

SearchFacesByImageCommand

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.

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces 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, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

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.

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.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RekognitionClient, SearchFacesByImageCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
// const { RekognitionClient, SearchFacesByImageCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
const client = new RekognitionClient(config);
const input = { // SearchFacesByImageRequest
  CollectionId: "STRING_VALUE", // required
  Image: { // Image
    Bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
    S3Object: { // S3Object
      Bucket: "STRING_VALUE",
      Name: "STRING_VALUE",
      Version: "STRING_VALUE",
    },
  },
  MaxFaces: Number("int"),
  FaceMatchThreshold: Number("float"),
  QualityFilter: "NONE" || "AUTO" || "LOW" || "MEDIUM" || "HIGH",
};
const command = new SearchFacesByImageCommand(input);
const response = await client.send(command);
// { // SearchFacesByImageResponse
//   SearchedFaceBoundingBox: { // BoundingBox
//     Width: Number("float"),
//     Height: Number("float"),
//     Left: Number("float"),
//     Top: Number("float"),
//   },
//   SearchedFaceConfidence: Number("float"),
//   FaceMatches: [ // FaceMatchList
//     { // FaceMatch
//       Similarity: Number("float"),
//       Face: { // Face
//         FaceId: "STRING_VALUE",
//         BoundingBox: {
//           Width: Number("float"),
//           Height: Number("float"),
//           Left: Number("float"),
//           Top: Number("float"),
//         },
//         ImageId: "STRING_VALUE",
//         ExternalImageId: "STRING_VALUE",
//         Confidence: Number("float"),
//         IndexFacesModelVersion: "STRING_VALUE",
//         UserId: "STRING_VALUE",
//       },
//     },
//   ],
//   FaceModelVersion: "STRING_VALUE",
// };

Example Usage

Loading code editor