Get largepersongroupslargepersongroupid

v5

latestSwagger 2.02026-07-136680294.1 KB

Retrieve the information of a Large Person Group, including its name, userData and recognitionModel. This API returns Large Person Group information only, use "Get Large Person Group Persons" instead to retrieve person information under the Large Person Group.

get/largepersongroups/{largePersonGroupId}

Path parameters

largePersonGroupIdstring required

ID of the container.

Query parameters

returnRecognitionModelboolean

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

Response

A successful call returns the Large 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.

largePersonGroupIdstring required