Sign in

v5

latestSwagger 2.02026-07-136680294.1 KB

1-to-many identification to find the closest matches of the specific query person face from a Person Group.

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.
post/identify

Request body

faceIdsAzureCoreUuid[] required

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].

personGroupIdstring required

personGroupId of the target Person Group, created by "Create Person Group". Parameter personGroupId and largePersonGroupId should not be provided at the same time.

maxNumOfCandidatesReturnedinteger

The range of maxNumOfCandidatesReturned is between 1 and 100. Default value is 10.

confidenceThresholdnumber float

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.

Response

A successful call returns the identified candidate person(s) for each query face.

faceIdstring uuid required

Universally Unique Identifier