GET /largefacelists/{largeFaceListId}

Changed on

Retrieve a Large Face List's largeFaceListId, name, userData and recognitionModel.

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

Path parameters

largeFaceListIdstring required

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

Query parameters

returnRecognitionModelboolean

Return 'recognitionModel' or not. The default value is false.

Response

A successful call returns the Large Face List's information.

namestring required

User defined name, maximum length is 128.

userDatastring

Optional user defined data. Length should not exceed 16K.

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

The recognition model for the face.

largeFaceListIdstring required

Changes

    • info

      api operation id LargeFaceList_Get removed and replaced with FaceListOperations_GetLargeFaceList