GET /persongroups/{personGroupId}

Changed on

Retrieve Person Group name, userData and recognitionModel. To get person information under this personGroup, use "Get Person Group Persons".

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

personGroupIdstring required

ID of the container.

Query parameters

returnRecognitionModelboolean

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

Response

A successful call returns the Person Group'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.

personGroupIdstring required

Changes