CreateLargeFaceList interface
Methods
| delete(Request |
Adding/deleting faces to/from a same Large Face List are processed sequentially and to/from different Large Face Lists are in parallel. |
| get(Get |
Retrieve a Large Face List's largeFaceListId, name, userData and recognitionModel. |
| patch(Update |
Update information of a Large Face List, including name and userData. |
| put(Create |
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
|
Method Details
delete(RequestParameters)
Adding/deleting faces to/from a same Large Face List are processed sequentially and to/from different Large Face Lists are in parallel.
function delete(options?: RequestParameters): StreamableMethod<DeleteLargeFaceList200Response | DeleteLargeFaceListDefaultResponse>Parameters
- options
- RequestParameters
Returns
get(GetLargeFaceListParameters)
Retrieve a Large Face List's largeFaceListId, name, userData and recognitionModel.
function get(options?: GetLargeFaceListParameters): StreamableMethod<GetLargeFaceList200Response | GetLargeFaceListDefaultResponse>Parameters
- options
- GetLargeFaceListParameters
Returns
patch(UpdateLargeFaceListParameters)
Update information of a Large Face List, including name and userData.
function patch(options: UpdateLargeFaceListParameters): StreamableMethod<UpdateLargeFaceList200Response | UpdateLargeFaceListDefaultResponse>Parameters
- options
- UpdateLargeFaceListParameters
Returns
put(CreateLargeFaceListParameters)
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.
function put(options: CreateLargeFaceListParameters): StreamableMethod<CreateLargeFaceList200Response | CreateLargeFaceListDefaultResponse>Parameters
- options
- CreateLargeFaceListParameters
