Package version:

Interface CreateFaceList

interface CreateFaceList {
    delete(options?): StreamableMethod<DeleteFaceList200Response | DeleteFaceListDefaultResponse>;
    get(options?): StreamableMethod<GetFaceList200Response | GetFaceListDefaultResponse>;
    patch(options?): StreamableMethod<UpdateFaceList200Response | UpdateFaceListDefaultResponse>;
    put(options?): StreamableMethod<CreateFaceList200Response | CreateFaceListDefaultResponse>;
}

Index

Methods

delete get patch put

Methods

delete

delete(options?): StreamableMethod<DeleteFaceList200Response | DeleteFaceListDefaultResponse>
Delete a specified Face List.
Parameters
- Optional options: any
Returns StreamableMethod<DeleteFaceList200Response | DeleteFaceListDefaultResponse>
- Defined in clientDefinitions.ts:684

get

get(options?): StreamableMethod<GetFaceList200Response | GetFaceListDefaultResponse>
Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.
Parameters
- Optional options: any
Returns StreamableMethod<GetFaceList200Response | GetFaceListDefaultResponse>
- Defined in clientDefinitions.ts:688

patch

patch(options?): StreamableMethod<UpdateFaceList200Response | UpdateFaceListDefaultResponse>
Update information of a Face List, including name and userData.
Parameters
- Optional options: any
Returns StreamableMethod<UpdateFaceList200Response | UpdateFaceListDefaultResponse>
- Defined in clientDefinitions.ts:692

put

put(options?): StreamableMethod<CreateFaceList200Response | CreateFaceListDefaultResponse>
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.
Parameters
- Optional options: any
Returns StreamableMethod<CreateFaceList200Response | CreateFaceListDefaultResponse>
- Defined in clientDefinitions.ts:680