v27

latestSwagger 2.0raw.githubusercontent.com2022-12-116362180.5 KB

Add a face to a person into a person group for face identification or verification. To deal with an image contains 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 will be stored on server until PersonGroup PersonFace - Delete, PersonGroup Person - Delete or PersonGroup - Delete is called. <br /> Note persistedFaceId is different from faceId generated by Face - 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.
  • Each person entry can hold up to 248 faces.
  • 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 Face - 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.
  • Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.
patch/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

Path parameters

personGroupIdstring required

Id referencing a particular person group.

personIdstring uuid required

Id referencing a particular person.

persistedFaceIdstring uuid required

Id referencing a particular persistedFaceId of an existing face.

Request body

userDatastring

User-provided data attached to the face. The size limit is 1KB.

Response

A successful call returns an empty response body.