Sign in

Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use PersonGroup Person - List.

get/persongroups/{personGroupId}

Path parameters

personGroupIdstring required

Id referencing a particular person group.

Query parameters

returnRecognitionModelboolean

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

Response

A successful call returns the person group's information.

personGroupIdstring required

PersonGroupId of the target person group.

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

Changed in 2 of the 28 revisions of this API.11