IdentificationResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-identification-result-schema.json",
  "title": "IdentificationResult",
  "description": "Identify result.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-identify-api-openapi.yml#/components/schemas/IdentificationResult",
  "type": "object",
  "properties": {
    "faceId": {
      "$ref": "#/$defs/Azure.Core.uuid",
      "description": "faceId of the query face."
    },
    "candidates": {
      "type": "array",
      "description": "Identified person candidates for that face (ranked by confidence). Array size should be no larger than input maxNumOfCandidatesReturned. If no person is identified, will return an empty array.",
      "items": {
        "$ref": "#/$defs/IdentificationCandidate"
      }
    }
  },
  "required": [
    "faceId",
    "candidates"
  ],
  "$defs": {
    "Azure.Core.uuid": {
      "type": "string",
      "format": "uuid",
      "description": "Universally Unique Identifier"
    },
    "IdentificationCandidate": {
      "type": "object",
      "description": "Candidate for identify call.",
      "properties": {
        "personId": {
          "$ref": "#/$defs/Azure.Core.uuid",
          "description": "personId of candidate person."
        },
        "confidence": {
          "type": "number",
          "format": "float",
          "description": "Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1].",
          "minimum": 0,
          "maximum": 1
        }
      },
      "required": [
        "personId",
        "confidence"
      ]
    }
  }
}