Sign in

v5

latestSwagger 2.02026-07-136680294.1 KB

Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.

Large Face List is a list of faces, up to 1,000,000 faces, and used by "Find Similar From Large Face List".

After creation, user should use Add Large Face List Face to import the faces and Train Large Face List to make it ready for "Find Similar". No image will be stored. Only the extracted face feature(s) will be stored on server until Delete Large Face List is called.

"Find Similar" is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use Person Group / Large Person Group and "Identify".

[!NOTE]

    • Free-tier subscription quota: 64 Large Face Lists.
    • S0-tier subscription quota: 1,000,000 Large Face Lists.
put/largefacelists/{largeFaceListId}

Path parameters

largeFaceListIdstring required

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

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.