SearchFacesByImageRequest

SearchFacesByImageRequest schema from Amazon Rekognition

Celebrity RecognitionComputer VisionContent ModerationCustom LabelsDeep LearningFace LivenessFacial RecognitionImage AnalysisMachine LearningObject DetectionText DetectionVideo Analysis

Properties

Name	Type	Description
CollectionId	string
Image	object
MaxFaces	integer
FaceMatchThreshold	number
QualityFilter	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-rekognition/refs/heads/main/json-schema/amazon-rekognition-search-faces-by-image-request-schema.json",
  "title": "SearchFacesByImageRequest",
  "description": "SearchFacesByImageRequest schema from Amazon Rekognition",
  "type": "object",
  "properties": {
    "CollectionId": {
      "type": "string",
      "example": "my-face-collection"
    },
    "Image": {
      "$ref": "#/components/schemas/Image"
    },
    "MaxFaces": {
      "type": "integer",
      "example": 5
    },
    "FaceMatchThreshold": {
      "type": "number",
      "format": "float",
      "example": 80.0
    },
    "QualityFilter": {
      "type": "string",
      "enum": [
        "NONE",
        "AUTO",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "CollectionId",
    "Image"
  ]
}