v5
latestSwagger 2.02026-07-136680294.1 KBAdd a face to a specified Large Face List, up to 1,000,000 faces.
To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until "Delete Large Face List Face" or "Delete Large Face List" is called.
Note that persistedFaceId is different from faceId generated by "Detect".
-
- Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
- JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
- "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from "Detect", there's no guarantee to detect and add the face successfully.
- Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
- The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
- Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to here.
[!NOTE]
- Free-tier subscription quota: 1,000 faces per Large Face List.
- S0-tier subscription quota: 1,000,000 faces per Large Face List.
Path parameters
Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.
Query parameters
A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'.
The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
User-provided data attached to the face. The size limit is 1K.
Request body
Response
A successful call returns a new persistedFaceId.