AZazure

Changed on

Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.

get/facelists/{faceListId}

Request

  • Base URL
    {Endpoint}/face/v1.0
  • URL
    {Endpoint}/face/v1.0/facelists/{faceListId}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

faceListIdstring required

Id referencing a particular face list.

Query parameters

returnRecognitionModelboolean

A value indicating whether the operation should return 'recognitionModel' in response.

Response

A successful call returns the face list's information.

faceListIdstring required

FaceListId of the target face list.

namestring required

User defined name, maximum length is 128.

userDatastring

User specified data. Length should not exceed 16KB.

recognitionModel'recognition_01' | 'recognition_02' | 'recognition_03' | 'recognition_04'

Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.

Changes