FaceList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-face-list-schema.json",
  "title": "FaceList",
  "description": "Face list is a list of faces, up to 1,000 faces.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-facelists-api-openapi.yml#/components/schemas/FaceList",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "User defined name, maximum length is 128.",
      "minLength": 1,
      "maxLength": 128
    },
    "userData": {
      "type": "string",
      "description": "Optional user defined data. Length should not exceed 16K.",
      "maxLength": 16384
    },
    "recognitionModel": {
      "$ref": "#/$defs/RecognitionModel",
      "description": "Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds."
    },
    "faceListId": {
      "$ref": "#/$defs/collectionId",
      "description": "Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.",
      "readOnly": true
    },
    "persistedFaces": {
      "type": "array",
      "description": "Face ids of registered faces in the face list.",
      "items": {
        "$ref": "#/$defs/FaceListFace"
      }
    }
  },
  "required": [
    "name",
    "faceListId"
  ],
  "$defs": {
    "Azure.Core.uuid": {
      "type": "string",
      "format": "uuid",
      "description": "Universally Unique Identifier"
    },
    "FaceListFace": {
      "type": "object",
      "description": "Face resource for face list.",
      "properties": {
        "persistedFaceId": {
          "$ref": "#/$defs/Azure.Core.uuid",
          "description": "Face ID of the face.",
          "readOnly": true
        },
        "userData": {
          "type": "string",
          "description": "User-provided data attached to the face. The length limit is 1K.",
          "maxLength": 1024
        }
      },
      "required": [
        "persistedFaceId"
      ]
    },
    "RecognitionModel": {
      "type": "string",
      "description": "The recognition model for the face.",
      "enum": [
        "recognition_01",
        "recognition_02",
        "recognition_03",
        "recognition_04"
      ],
      "x-ms-enum": {
        "name": "RecognitionModel",
        "modelAsString": true,
        "values": [
          {
            "name": "recognition_01",
            "value": "recognition_01",
            "description": "The default recognition model for \"Detect\". All those faceIds created before 2019 March are bonded with this recognition model."
          },
          {
            "name": "recognition_02",
            "value": "recognition_02",
            "description": "Recognition model released in 2019 March."
          },
          {
            "name": "recognition_03",
            "value": "recognition_03",
            "description": "Recognition model released in 2020 May."
          },
          {
            "name": "recognition_04",
            "value": "recognition_04",
            "description": "Recognition model released in 2021 February. It's recommended to use this recognition model for better recognition accuracy."
          }
        ]
      }
    },
    "collectionId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9-_]+$"
    }
  }
}