CreateFaceList interface
Methods
| delete(Request |
Delete a specified Face List. |
| get(Get |
Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List. |
| patch(Update |
Update information of a Face List, including name and userData. |
| put(Create |
Up to 64 Face Lists are allowed in one subscription. Face List is a list of faces, up to 1,000 faces, and used by "Find Similar From Face List". After creation, user should use "Add Face List Face" to import the faces. No image will be stored. Only the extracted face feature(s) will be stored on server until "Delete 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". Please consider Large Face List when the face number is large. It can support up to 1,000,000 faces. |
Method Details
delete(RequestParameters)
Delete a specified Face List.
function delete(options?: RequestParameters): StreamableMethod<DeleteFaceList200Response | DeleteFaceListDefaultResponse>Parameters
- options
- RequestParameters
Returns
get(GetFaceListParameters)
Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.
function get(options?: GetFaceListParameters): StreamableMethod<GetFaceList200Response | GetFaceListDefaultResponse>Parameters
- options
- GetFaceListParameters
Returns
patch(UpdateFaceListParameters)
Update information of a Face List, including name and userData.
function patch(options: UpdateFaceListParameters): StreamableMethod<UpdateFaceList200Response | UpdateFaceListDefaultResponse>Parameters
- options
- UpdateFaceListParameters
Returns
put(CreateFaceListParameters)
Up to 64 Face Lists are allowed in one subscription.
Face List is a list of faces, up to 1,000 faces, and used by "Find Similar From Face List".
After creation, user should use "Add Face List Face" to import the faces. No image will be stored. Only the extracted face feature(s) will be stored on server until "Delete 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".
Please consider Large Face List when the face number is large. It can support up to 1,000,000 faces.
function put(options: CreateFaceListParameters): StreamableMethod<CreateFaceList200Response | CreateFaceListDefaultResponse>Parameters
- options
- CreateFaceListParameters
