AZazure

Changed on

Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use LargePersonGroup Person - List instead to retrieve person information under the large person group.

get/largepersongroups/{largePersonGroupId}

Request

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

Path parameters

largePersonGroupIdstring required

Id referencing a particular large person group.

Query parameters

returnRecognitionModelboolean

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

Response

A successful call returns the large person group's information.

largePersonGroupIdstring required

LargePersonGroupId of the target large person groups

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