LargeFaceListOperations class
Class representing a LargeFaceListOperations.
Constructors
| Large |
Create a LargeFaceListOperations. |
Methods
| add |
Add a face to a specified large face list, up to 1,000,000 faces.
Quota:
|
| add |
|
| add |
|
| add |
Add a face to a specified large face list, up to 1,000,000 faces.
Quota:
|
| add |
|
| add |
|
| create(string, string, Large |
Create an empty large face list with user-specified largeFaceListId, name, an optional userData
and recognitionModel.
Large face list quota:
|
| create(string, string, Large |
|
| create(string, string, Service |
|
| delete |
Delete a face from a large face list by specified largeFaceListId and persistedFaceId.
|
| delete |
|
| delete |
|
| delete |
Delete a specified large face list. |
| delete |
|
| delete |
|
| get(string, Large |
Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel. |
| get(string, Large |
|
| get(string, Service |
|
| get |
Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId). |
| get |
|
| get |
|
| get |
Retrieve the training status of a large face list (completed or ongoing). |
| get |
|
| get |
|
| list(Large |
List large face lists’ information of largeFaceListId, name, userData and recognitionModel.
|
| list(Large |
|
| list(Service |
|
| list |
List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face). |
| list |
|
| list |
|
| train(string, Request |
Queue a large face list training task, the training task may not be started immediately. |
| train(string, Request |
|
| train(string, Service |
|
| update(string, Large |
Update information of a large face list. |
| update(string, Large |
|
| update(string, Service |
|
| update |
Update a persisted face's userData field. |
| update |
|
| update |
Constructor Details
LargeFaceListOperations(FaceClientContext)
Create a LargeFaceListOperations.
new LargeFaceListOperations(client: FaceClientContext)Parameters
- client
- FaceClientContext
Reference to the service client.
Method Details
addFaceFromStream(string, HttpRequestBody, LargeFaceListAddFaceFromStreamOptionalParams)
Add a face to a specified large face list, up to 1,000,000 faces.
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 LargeFaceList
Face - Delete or
LargeFaceList - Delete is
called.
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.
- 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 face list are processed sequentially and to/from different face lists are in parallel.
- 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 How to specify a detection model.
Quota:
- Free-tier subscription quota: 1,000 faces per large face list.
- S0-tier subscription quota: 1,000,000 faces per large face list.
function addFaceFromStream(largeFaceListId: string, image: HttpRequestBody, options?: LargeFaceListAddFaceFromStreamOptionalParams): Promise<LargeFaceListAddFaceFromStreamResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- image
- HttpRequestBody
An image stream.
The optional parameters
Returns
Promise<Models.LargeFaceListAddFaceFromStreamResponse>
addFaceFromStream(string, HttpRequestBody, LargeFaceListAddFaceFromStreamOptionalParams, ServiceCallback<PersistedFace>)
function addFaceFromStream(largeFaceListId: string, image: HttpRequestBody, options: LargeFaceListAddFaceFromStreamOptionalParams, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- image
- HttpRequestBody
An image stream.
The optional parameters
- callback
The callback
addFaceFromStream(string, HttpRequestBody, ServiceCallback<PersistedFace>)
function addFaceFromStream(largeFaceListId: string, image: HttpRequestBody, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- image
- HttpRequestBody
An image stream.
- callback
The callback
addFaceFromUrl(string, string, LargeFaceListAddFaceFromUrlOptionalParams)
Add a face to a specified large face list, up to 1,000,000 faces.
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 LargeFaceList
Face - Delete or
LargeFaceList - Delete is
called.
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.
- 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 face list are processed sequentially and to/from different face lists are in parallel.
- 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 How to specify a detection model
Quota:
- Free-tier subscription quota: 1,000 faces per large face list.
- S0-tier subscription quota: 1,000,000 faces per large face list.
function addFaceFromUrl(largeFaceListId: string, url: string, options?: LargeFaceListAddFaceFromUrlOptionalParams): Promise<LargeFaceListAddFaceFromUrlResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- url
-
string
Publicly reachable URL of an image
The optional parameters
Returns
Promise<LargeFaceListAddFaceFromUrlResponse>
Promise<Models.LargeFaceListAddFaceFromUrlResponse>
addFaceFromUrl(string, string, LargeFaceListAddFaceFromUrlOptionalParams, ServiceCallback<PersistedFace>)
function addFaceFromUrl(largeFaceListId: string, url: string, options: LargeFaceListAddFaceFromUrlOptionalParams, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- url
-
string
Publicly reachable URL of an image
The optional parameters
- callback
The callback
addFaceFromUrl(string, string, ServiceCallback<PersistedFace>)
function addFaceFromUrl(largeFaceListId: string, url: string, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- url
-
string
Publicly reachable URL of an image
- callback
The callback
create(string, string, LargeFaceListCreateOptionalParams)
Create an empty large face list with user-specified largeFaceListId, name, an optional userData
and recognitionModel.
Large face list is a list of faces, up to 1,000,000 faces, and used by Face - Find
Similar.
After creation, user should use LargeFaceList Face -
Add to import the
faces and LargeFaceList -
Train to make it ready for
Face - Find Similar. No image
will be stored. Only the extracted face features are stored on server until LargeFaceList -
Delete 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 PersonGroup /
LargePersonGroup and Face -
Identify.
'recognitionModel' should be specified to associate with this large face list. The default
value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly
specify the model you need in this parameter. New faces that are added to an existing large face
list will use the recognition model that's already associated with the collection. Existing face
features in a large face list can't be updated to features extracted by another version of
recognition model. Please refer to Specify a recognition
model.
Large face list quota:
- Free-tier subscription quota: 64 large face lists.
- S0-tier subscription quota: 1,000,000 large face lists.
function create(largeFaceListId: string, name: string, options?: LargeFaceListCreateOptionalParams): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- name
-
string
User defined name, maximum length is 128.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
create(string, string, LargeFaceListCreateOptionalParams, ServiceCallback<void>)
function create(largeFaceListId: string, name: string, options: LargeFaceListCreateOptionalParams, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- name
-
string
User defined name, maximum length is 128.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
create(string, string, ServiceCallback<void>)
function create(largeFaceListId: string, name: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- name
-
string
User defined name, maximum length is 128.
- callback
-
ServiceCallback<void>
The callback
deleteFace(string, string, RequestOptionsBase)
Delete a face from a large face list by specified largeFaceListId and persistedFaceId.
Adding/deleting faces to/from a same large face list are processed sequentially and
to/from different large face lists are in parallel.
function deleteFace(largeFaceListId: string, persistedFaceId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteFace(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteFace(largeFaceListId: string, persistedFaceId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteFace(string, string, ServiceCallback<void>)
function deleteFace(largeFaceListId: string, persistedFaceId: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, RequestOptionsBase)
Delete a specified large face list.
function deleteMethod(largeFaceListId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(largeFaceListId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(largeFaceListId: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
-
ServiceCallback<void>
The callback
get(string, LargeFaceListGetOptionalParams)
Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel.
function get(largeFaceListId: string, options?: LargeFaceListGetOptionalParams): Promise<LargeFaceListGetResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- LargeFaceListGetOptionalParams
The optional parameters
Returns
Promise<LargeFaceListGetResponse>
Promise<Models.LargeFaceListGetResponse>
get(string, LargeFaceListGetOptionalParams, ServiceCallback<LargeFaceList>)
function get(largeFaceListId: string, options: LargeFaceListGetOptionalParams, callback: ServiceCallback<LargeFaceList>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- LargeFaceListGetOptionalParams
The optional parameters
- callback
The callback
get(string, ServiceCallback<LargeFaceList>)
function get(largeFaceListId: string, callback: ServiceCallback<LargeFaceList>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
The callback
getFace(string, string, RequestOptionsBase)
Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).
function getFace(largeFaceListId: string, persistedFaceId: string, options?: RequestOptionsBase): Promise<LargeFaceListGetFaceResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<LargeFaceListGetFaceResponse>
Promise<Models.LargeFaceListGetFaceResponse>
getFace(string, string, RequestOptionsBase, ServiceCallback<PersistedFace>)
function getFace(largeFaceListId: string, persistedFaceId: string, options: RequestOptionsBase, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getFace(string, string, ServiceCallback<PersistedFace>)
function getFace(largeFaceListId: string, persistedFaceId: string, callback: ServiceCallback<PersistedFace>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- callback
The callback
getTrainingStatus(string, RequestOptionsBase)
Retrieve the training status of a large face list (completed or ongoing).
function getTrainingStatus(largeFaceListId: string, options?: RequestOptionsBase): Promise<LargeFaceListGetTrainingStatusResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.LargeFaceListGetTrainingStatusResponse>
getTrainingStatus(string, RequestOptionsBase, ServiceCallback<TrainingStatus>)
function getTrainingStatus(largeFaceListId: string, options: RequestOptionsBase, callback: ServiceCallback<TrainingStatus>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getTrainingStatus(string, ServiceCallback<TrainingStatus>)
function getTrainingStatus(largeFaceListId: string, callback: ServiceCallback<TrainingStatus>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
The callback
list(LargeFaceListListOptionalParams)
List large face lists’ information of largeFaceListId, name, userData and recognitionModel.
To get face information inside largeFaceList use LargeFaceList Face -
Get
- Large face lists are stored in alphabetical order of largeFaceListId.
- "start" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
- "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000
entries can be returned in one call. To fetch more, you can specify "start" with the last
returned entry’s Id of the current call.
For example, total 5 large person lists: "list1", ..., "list5".
"start=&top=" will return all 5 lists.
"start=&top=2" will return "list1", "list2".
"start=list2&top=3" will return "list3", "list4", "list5".
function list(options?: LargeFaceListListOptionalParams): Promise<LargeFaceListListResponse>Parameters
- options
- LargeFaceListListOptionalParams
The optional parameters
Returns
Promise<LargeFaceListListResponse>
Promise<Models.LargeFaceListListResponse>
list(LargeFaceListListOptionalParams, ServiceCallback<LargeFaceList[]>)
function list(options: LargeFaceListListOptionalParams, callback: ServiceCallback<LargeFaceList[]>)Parameters
- options
- LargeFaceListListOptionalParams
The optional parameters
- callback
The callback
list(ServiceCallback<LargeFaceList[]>)
function list(callback: ServiceCallback<LargeFaceList[]>)Parameters
- callback
The callback
listFaces(string, LargeFaceListListFacesOptionalParams)
List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).
function listFaces(largeFaceListId: string, options?: LargeFaceListListFacesOptionalParams): Promise<LargeFaceListListFacesResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
The optional parameters
Returns
Promise<LargeFaceListListFacesResponse>
Promise<Models.LargeFaceListListFacesResponse>
listFaces(string, LargeFaceListListFacesOptionalParams, ServiceCallback<PersistedFace[]>)
function listFaces(largeFaceListId: string, options: LargeFaceListListFacesOptionalParams, callback: ServiceCallback<PersistedFace[]>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
The optional parameters
- callback
The callback
listFaces(string, ServiceCallback<PersistedFace[]>)
function listFaces(largeFaceListId: string, callback: ServiceCallback<PersistedFace[]>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
The callback
train(string, RequestOptionsBase)
Queue a large face list training task, the training task may not be started immediately.
function train(largeFaceListId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
train(string, RequestOptionsBase, ServiceCallback<void>)
function train(largeFaceListId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
train(string, ServiceCallback<void>)
function train(largeFaceListId: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
-
ServiceCallback<void>
The callback
update(string, LargeFaceListUpdateOptionalParams)
Update information of a large face list.
function update(largeFaceListId: string, options?: LargeFaceListUpdateOptionalParams): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, LargeFaceListUpdateOptionalParams, ServiceCallback<void>)
function update(largeFaceListId: string, options: LargeFaceListUpdateOptionalParams, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
update(string, ServiceCallback<void>)
function update(largeFaceListId: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- callback
-
ServiceCallback<void>
The callback
updateFace(string, string, LargeFaceListUpdateFaceOptionalParams)
Update a persisted face's userData field.
function updateFace(largeFaceListId: string, persistedFaceId: string, options?: LargeFaceListUpdateFaceOptionalParams): Promise<RestResponse>Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
updateFace(string, string, LargeFaceListUpdateFaceOptionalParams, ServiceCallback<void>)
function updateFace(largeFaceListId: string, persistedFaceId: string, options: LargeFaceListUpdateFaceOptionalParams, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
updateFace(string, string, ServiceCallback<void>)
function updateFace(largeFaceListId: string, persistedFaceId: string, callback: ServiceCallback<void>)Parameters
- largeFaceListId
-
string
Id referencing a particular large face list.
- persistedFaceId
-
string
Id referencing a particular persistedFaceId of an existing face.
- callback
-
ServiceCallback<void>
The callback