Microsoft Azure AI Foundry Identify API

openapi: 3.2.0
info:
  title: Azure AI Face Identify API
  version: v1.2
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- KeyAuth: []
- AADToken:
  - https://cognitiveservices.azure.com/.default
tags:
- name: Identify
paths:
  /identify:
    post:
      operationId: FaceRecognitionOperations_IdentifyFromPersonGroup
      summary: 1-to-many identification to find the closest matches of the specific query…
      description: 'For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Group (given by personGroupId), and return candidate person(s) for that face ranked by similarity confidence. The Person Group should be trained to make it ready for identification. See more in "Train Person Group".

        > [!NOTE]

        >

        > *

        > * The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.

        > * Each person could have more than one face, but no more than 248 faces.

        > * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.

        > * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.

        > * Try "Find Similar" when you need to find similar faces from a Face List/Large Face List instead of a Person Group.

        > * The ''recognitionModel'' associated with the query faces'' faceIds should be the same as the ''recognitionModel'' used by the target Person Group.'
      responses:
        '200':
          description: A successful call returns the identified candidate person(s) for each query face.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdentificationResult'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                faceIds:
                  type: array
                  description: Array of query faces faceIds, created by the "Detect". Each of the faces are identified independently. The valid number of faceIds is between [1, 10].
                  minItems: 1
                  maxItems: 10
                  items:
                    $ref: '#/components/schemas/Azure.Core.uuid'
                personGroupId:
                  type: string
                  description: personGroupId of the target Person Group, created by "Create Person Group". Parameter personGroupId and largePersonGroupId should not be provided at the same time.
                maxNumOfCandidatesReturned:
                  type: integer
                  format: int32
                  description: The range of maxNumOfCandidatesReturned is between 1 and 100. Default value is 10.
                  default: 10
                  minimum: 1
                  maximum: 100
                confidenceThreshold:
                  type: number
                  format: float
                  description: Customized identification confidence threshold, in the range of [0, 1]. Advanced user can tweak this value to override default internal threshold for better precision on their scenario data. Note there is no guarantee of this threshold value working on other data and after algorithm updates.
                  minimum: 0
                  maximum: 1
              required:
              - faceIds
              - personGroupId
        required: true
      tags:
      - Identify
components:
  schemas:
    FaceError:
      type: object
      description: 'The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.'
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
      required:
      - code
      - message
    IdentificationResult:
      type: object
      description: Identify result.
      properties:
        faceId:
          $ref: '#/components/schemas/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: '#/components/schemas/IdentificationCandidate'
      required:
      - faceId
      - candidates
    Azure.Core.uuid:
      type: string
      format: uuid
      description: Universally Unique Identifier
    IdentificationCandidate:
      type: object
      description: Candidate for identify call.
      properties:
        personId:
          $ref: '#/components/schemas/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
    FaceErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/FaceError'
          description: The error object.
      required:
      - error
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            https://cognitiveservices.azure.com/.default: ''
          authorizationUrl: https://api.example.com/oauth2/authorize
          tokenUrl: https://api.example.com/oauth2/token
      description: The Azure Active Directory OAuth2 Flow
    KeyAuth:
      type: apiKey
      description: The secret key for your Azure AI Face subscription.
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/face/{apiVersion}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Supported Cognitive Services endpoints (protocol and hostname, for example:

      https://{resource-name}.cognitiveservices.azure.com).'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true


# --- truncated at 32 KB (63 KB total) ---
# Full source: https://artifacts.apis.io/azure-ai-foundry/openapi/azure-ai-foundry-identify-api-openapi.yml