CreateLargePersonGroup interface
Methods
| delete(Request |
Delete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person Group will be deleted. |
| get(Get |
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. |
| patch(Update |
Update an existing Large Person Group's name and userData. The properties keep unchanged if they are not in request body. |
| put(Create |
A Large Person Group is a container holding the uploaded person data, including the face recognition features. It can hold up to 1,000,000 entities. After creation, use "Create Large Person Group Person" to add person into the group, and call "Train Large Person Group" to get this group ready for "Identify From Large Person Group". No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until "Delete Large Person Group Person" or "Delete Large Person Group" is called. 'recognitionModel' should be specified to associate with this Large Person Group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing Large Person Group will use the recognition model that's already associated with the collection. Existing face feature(s) in a Large Person Group can't be updated to features extracted by another version of recognition model. Note
|
Method Details
delete(RequestParameters)
Delete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person Group will be deleted.
function delete(options?: RequestParameters): StreamableMethod<DeleteLargePersonGroup200Response | DeleteLargePersonGroupDefaultResponse>Parameters
- options
- RequestParameters
Returns
get(GetLargePersonGroupParameters)
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.
function get(options?: GetLargePersonGroupParameters): StreamableMethod<GetLargePersonGroup200Response | GetLargePersonGroupDefaultResponse>Parameters
- options
- GetLargePersonGroupParameters
Returns
patch(UpdateLargePersonGroupParameters)
Update an existing Large Person Group's name and userData. The properties keep unchanged if they are not in request body.
function patch(options: UpdateLargePersonGroupParameters): StreamableMethod<UpdateLargePersonGroup200Response | UpdateLargePersonGroupDefaultResponse>Parameters
- options
- UpdateLargePersonGroupParameters
Returns
put(CreateLargePersonGroupParameters)
A Large Person Group is a container holding the uploaded person data, including the face recognition features. It can hold up to 1,000,000 entities.
After creation, use "Create Large Person Group Person" to add person into the group, and call "Train Large Person Group" to get this group ready for "Identify From Large Person Group".
No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until "Delete Large Person Group Person" or "Delete Large Person Group" is called.
'recognitionModel' should be specified to associate with this Large Person Group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing Large Person Group will use the recognition model that's already associated with the collection. Existing face feature(s) in a Large Person Group can't be updated to features extracted by another version of recognition model.
Note
-
- Free-tier subscription quota: 1,000 Large Person Groups.
- S0-tier subscription quota: 1,000,000 Large Person Groups.
function put(options: CreateLargePersonGroupParameters): StreamableMethod<CreateLargePersonGroup200Response | CreateLargePersonGroupDefaultResponse>Parameters
- options
- CreateLargePersonGroupParameters
