AZazure

Changed on

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).

get/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

personGroupIdstring required

Id referencing a particular person group.

personIdstring uuid required

Id referencing a particular person.

persistedFaceIdstring uuid required

Id referencing a particular persistedFaceId of an existing face.

Response

A successful call returns target persisted face's information (persistedFaceId and userData).

persistedFaceIdstring uuid required

The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in at the time specified by faceIdTimeToLive after the detection call.

userDatastring

User-provided data attached to the face. The size limit is 1KB.

Changes