Person Group Operations

Operations

Add Large Person Group Person Face

Add a face to a person into a Large Person Group for face identification or verification.

Add Large Person Group Person Face From Url

Add a face to a person into a Large Person Group for face identification or verification.

Add Person Group Person Face

Add a face to a person into a Person Group for face identification or verification.

Add Person Group Person Face From Url

Add a face to a person into a Person Group for face identification or verification.

Create Large Person Group

Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.

Create Large Person Group Person

Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".

Create Person Group

Create a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.

Create Person Group Person

Create a new person in a specified Person Group. To add face to this person, please call "Add Person Group Person Face".

Delete Large Person Group

Delete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person Group will be deleted.

Delete Large Person Group Person

Delete an existing person from a Large Person Group. The persistedFaceId, userData, person name and face feature(s) in the person entry will all be deleted.

Delete Large Person Group Person Face

Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId.

Delete Person Group

Delete an existing Person Group with specified personGroupId. Persisted data in this Person Group will be deleted.

Delete Person Group Person

Delete an existing person from a Person Group. The persistedFaceId, userData, person name and face feature(s) in the person entry will all be deleted.

Delete Person Group Person Face

Delete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.

Get Large Person Group

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 Person

Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s).

Get Large Person Group Person Face

Retrieve person face information. The persisted person face is specified by its largePersonGroupId, personId and persistedFaceId.

Get Large Person Group Persons

List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.

Get Large Person Groups

List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.

Get Large Person Group Training Status

To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Perso...

Get Person Group

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

Get Person Group Person

Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s).

Get Person Group Person Face

Retrieve person face information. The persisted person face is specified by its personGroupId, personId and persistedFaceId.

Get Person Group Persons

List all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.

Get Person Groups

List Person Groups' personGroupId, name, userData and recognitionModel.

Get Person Group Training Status

To check Person Group training status completed or still ongoing. Person Group training is an asynchronous operation triggered by "Train Person Group" API.

Train Large Person Group

Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group".

Train Person Group

Submit a Person Group training task. Training is a crucial step that only a trained Person Group can be used by "Identify From Person Group".

Update Large Person Group

Update an existing Large Person Group's name and userData. The properties keep unchanged if they are not in request body.

Update Large Person Group Person

Update name or userData of a person.

Update Large Person Group Person Face

Update a person persisted face's userData field.

Update Person Group

Update an existing Person Group's name and userData. The properties keep unchanged if they are not in request body.

Update Person Group Person

Update name or userData of a person.

Update Person Group Person Face

Update a person persisted face's userData field.