FindSimilarResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-find-similar-result-schema.json",
  "title": "FindSimilarResult",
  "description": "Response body for find similar face operation.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-findsimilars-api-openapi.yml#/components/schemas/FindSimilarResult",
  "type": "object",
  "properties": {
    "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
    },
    "faceId": {
      "$ref": "#/$defs/Azure.Core.uuid",
      "description": "faceId of candidate face when find by faceIds. faceId is created by \"Detect\" and will expire 24 hours after the detection call."
    },
    "persistedFaceId": {
      "$ref": "#/$defs/Azure.Core.uuid",
      "description": "persistedFaceId of candidate face when find by faceListId or largeFaceListId. persistedFaceId in face list/large face list is persisted and will not expire."
    }
  },
  "required": [
    "confidence"
  ],
  "$defs": {
    "Azure.Core.uuid": {
      "type": "string",
      "format": "uuid",
      "description": "Universally Unique Identifier"
    }
  }
}