Divide candidate faces into groups based on face similarity.

Changed on
    • The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result.
    • MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.
    • Group API needs at least 2 candidate faces and 1000 at most. We suggest to try "Verify Face To Face" when you only have 2 candidate faces.
    • The 'recognitionModel' associated with the query faces' faceIds should be the same.
post/group

Request

  • Base URL
    {endpoint}/face/{apiVersion}
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or OAuth 2
      Authorization codehttps://api.example.com/oauth2/authorize
      Token URLhttps://api.example.com/oauth2/token
      Scopeshttps://cognitiveservices.azure.com/.default

Request body

faceIdsAzureCoreUuid[] required

Array of candidate faceIds created by "Detect". The maximum is 1000 faces.

Response

A successful call returns one or more groups of similar faces (rank by group size) and a messyGroup.

messyGroupAzureCoreUuid[] required

Face ids array of faces that cannot find any similar faces from original faces.

Changes