v5

latestSwagger 2.02026-07-136680294.1 KB

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

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.
put/largepersongroups/{largePersonGroupId}

Path parameters

largePersonGroupIdstring required

ID of the container.

Request body

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 'recognitionModel' associated with this face list. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02, 'recognition_03', and 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.

Response

The request has succeeded.