LargePersonGroupPerson class

Class representing a LargePersonGroupPerson.

Constructors

LargePersonGroupPerson(FaceClientContext)

Create a LargePersonGroupPerson.

Methods

addFaceFromStream(string, string, msRest.HttpRequestBody, LargePersonGroupPersonAddFaceFromStreamOptionalParams, ServiceCallback<PersistedFace>)
addFaceFromStream(string, string, msRest.HttpRequestBody, Models.LargePersonGroupPersonAddFaceFromStreamOptionalParams)

Add a face to a person into a large 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 LargePersonGroup PersonFace - Delete, LargePersonGroup Person - Delete or LargePersonGroup - 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.
  • 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.
  • 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.
addFaceFromStream(string, string, msRest.HttpRequestBody, ServiceCallback<PersistedFace>)
addFaceFromUrl(string, string, string, LargePersonGroupPersonAddFaceFromUrlOptionalParams, ServiceCallback<PersistedFace>)
addFaceFromUrl(string, string, string, Models.LargePersonGroupPersonAddFaceFromUrlOptionalParams)

Add a face to a person into a large 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 LargePersonGroup PersonFace - Delete, LargePersonGroup Person - Delete or LargePersonGroup - 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.
  • 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.
  • 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
addFaceFromUrl(string, string, string, ServiceCallback<PersistedFace>)
create(string, LargePersonGroupPersonCreateOptionalParams, ServiceCallback<Person>)
create(string, Models.LargePersonGroupPersonCreateOptionalParams)

Create a new person in a specified large person group.

create(string, ServiceCallback<Person>)
deleteFace(string, string, string, msRest.RequestOptionsBase)

Delete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId.
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.

deleteFace(string, string, string, RequestOptionsBase, ServiceCallback<void>)
deleteFace(string, string, string, ServiceCallback<void>)
deleteMethod(string, string, msRest.RequestOptionsBase)

Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, ServiceCallback<void>)
get(string, string, msRest.RequestOptionsBase)

Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature.

get(string, string, RequestOptionsBase, ServiceCallback<Person>)
get(string, string, ServiceCallback<Person>)
getFace(string, string, string, msRest.RequestOptionsBase)

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId).

getFace(string, string, string, RequestOptionsBase, ServiceCallback<PersistedFace>)
getFace(string, string, string, ServiceCallback<PersistedFace>)
list(string, LargePersonGroupPersonListOptionalParams, ServiceCallback<Person[]>)
list(string, Models.LargePersonGroupPersonListOptionalParams)

List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

list(string, ServiceCallback<Person[]>)
update(string, string, LargePersonGroupPersonUpdateOptionalParams, ServiceCallback<void>)
update(string, string, Models.LargePersonGroupPersonUpdateOptionalParams)

Update name or userData of a person.

update(string, string, ServiceCallback<void>)
updateFace(string, string, string, LargePersonGroupPersonUpdateFaceOptionalParams, ServiceCallback<void>)
updateFace(string, string, string, Models.LargePersonGroupPersonUpdateFaceOptionalParams)

Update a person persisted face's userData field.

updateFace(string, string, string, ServiceCallback<void>)

Constructor Details

LargePersonGroupPerson(FaceClientContext)

Create a LargePersonGroupPerson.

new LargePersonGroupPerson(client: FaceClientContext)

Parameters

client
FaceClientContext

Reference to the service client.

Method Details

addFaceFromStream(string, string, msRest.HttpRequestBody, LargePersonGroupPersonAddFaceFromStreamOptionalParams, ServiceCallback<PersistedFace>)

function addFaceFromStream(largePersonGroupId: string, personId: string, image: msRest.HttpRequestBody, options: LargePersonGroupPersonAddFaceFromStreamOptionalParams, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

image
msRest.HttpRequestBody

An image stream.

callback

ServiceCallback<PersistedFace>

The callback

addFaceFromStream(string, string, msRest.HttpRequestBody, Models.LargePersonGroupPersonAddFaceFromStreamOptionalParams)

Add a face to a person into a large 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 LargePersonGroup PersonFace - Delete, LargePersonGroup Person - Delete or LargePersonGroup - 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.
  • 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.
  • 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.
function addFaceFromStream(largePersonGroupId: string, personId: string, image: msRest.HttpRequestBody, options?: Models.LargePersonGroupPersonAddFaceFromStreamOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

image
msRest.HttpRequestBody

An image stream.

options
Models.LargePersonGroupPersonAddFaceFromStreamOptionalParams

Returns

Promise<Models.LargePersonGroupPersonAddFaceFromStreamResponse>

Promise<Models.LargePersonGroupPersonAddFaceFromStreamResponse>

addFaceFromStream(string, string, msRest.HttpRequestBody, ServiceCallback<PersistedFace>)

function addFaceFromStream(largePersonGroupId: string, personId: string, image: msRest.HttpRequestBody, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

image
msRest.HttpRequestBody

An image stream.

callback

ServiceCallback<PersistedFace>

The callback

addFaceFromUrl(string, string, string, LargePersonGroupPersonAddFaceFromUrlOptionalParams, ServiceCallback<PersistedFace>)

function addFaceFromUrl(largePersonGroupId: string, personId: string, url: string, options: LargePersonGroupPersonAddFaceFromUrlOptionalParams, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

url

string

Publicly reachable URL of an image

options
LargePersonGroupPersonAddFaceFromUrlOptionalParams

The optional parameters

callback

ServiceCallback<PersistedFace>

The callback

addFaceFromUrl(string, string, string, Models.LargePersonGroupPersonAddFaceFromUrlOptionalParams)

Add a face to a person into a large 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 LargePersonGroup PersonFace - Delete, LargePersonGroup Person - Delete or LargePersonGroup - 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.
  • 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.
  • 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
function addFaceFromUrl(largePersonGroupId: string, personId: string, url: string, options?: Models.LargePersonGroupPersonAddFaceFromUrlOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

url

string

Publicly reachable URL of an image

options
Models.LargePersonGroupPersonAddFaceFromUrlOptionalParams

Returns

Promise<Models.LargePersonGroupPersonAddFaceFromUrlResponse>

Promise<Models.LargePersonGroupPersonAddFaceFromUrlResponse>

addFaceFromUrl(string, string, string, ServiceCallback<PersistedFace>)

function addFaceFromUrl(largePersonGroupId: string, personId: string, url: string, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

url

string

Publicly reachable URL of an image

callback

ServiceCallback<PersistedFace>

The callback

create(string, LargePersonGroupPersonCreateOptionalParams, ServiceCallback<Person>)

function create(largePersonGroupId: string, options: LargePersonGroupPersonCreateOptionalParams, callback: ServiceCallback<Person>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

options
LargePersonGroupPersonCreateOptionalParams

The optional parameters

callback

ServiceCallback<Person>

The callback

create(string, Models.LargePersonGroupPersonCreateOptionalParams)

Create a new person in a specified large person group.

function create(largePersonGroupId: string, options?: Models.LargePersonGroupPersonCreateOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

options
Models.LargePersonGroupPersonCreateOptionalParams

Returns

Promise<Models.LargePersonGroupPersonCreateResponse>

Promise<Models.LargePersonGroupPersonCreateResponse>

create(string, ServiceCallback<Person>)

function create(largePersonGroupId: string, callback: ServiceCallback<Person>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

callback

ServiceCallback<Person>

The callback

deleteFace(string, string, string, msRest.RequestOptionsBase)

Delete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId.
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.

function deleteFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options?: msRest.RequestOptionsBase)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteFace(string, string, string, RequestOptionsBase, ServiceCallback<void>)

function deleteFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteFace(string, string, string, ServiceCallback<void>)

function deleteFace(largePersonGroupId: string, personId: string, persistedFaceId: string, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, msRest.RequestOptionsBase)

Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.

function deleteMethod(largePersonGroupId: string, personId: string, options?: msRest.RequestOptionsBase)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(largePersonGroupId: string, personId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, ServiceCallback<void>)

function deleteMethod(largePersonGroupId: string, personId: string, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

callback

ServiceCallback<void>

The callback

get(string, string, msRest.RequestOptionsBase)

Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature.

function get(largePersonGroupId: string, personId: string, options?: msRest.RequestOptionsBase)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options
msRest.RequestOptionsBase

Returns

Promise<Models.LargePersonGroupPersonGetResponse>

Promise<Models.LargePersonGroupPersonGetResponse>

get(string, string, RequestOptionsBase, ServiceCallback<Person>)

function get(largePersonGroupId: string, personId: string, options: RequestOptionsBase, callback: ServiceCallback<Person>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<Person>

The callback

get(string, string, ServiceCallback<Person>)

function get(largePersonGroupId: string, personId: string, callback: ServiceCallback<Person>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

callback

ServiceCallback<Person>

The callback

getFace(string, string, string, msRest.RequestOptionsBase)

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId).

function getFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options?: msRest.RequestOptionsBase)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options
msRest.RequestOptionsBase

Returns

Promise<Models.LargePersonGroupPersonGetFaceResponse>

Promise<Models.LargePersonGroupPersonGetFaceResponse>

getFace(string, string, string, RequestOptionsBase, ServiceCallback<PersistedFace>)

function getFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options: RequestOptionsBase, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<PersistedFace>

The callback

getFace(string, string, string, ServiceCallback<PersistedFace>)

function getFace(largePersonGroupId: string, personId: string, persistedFaceId: string, callback: ServiceCallback<PersistedFace>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

callback

ServiceCallback<PersistedFace>

The callback

list(string, LargePersonGroupPersonListOptionalParams, ServiceCallback<Person[]>)

function list(largePersonGroupId: string, options: LargePersonGroupPersonListOptionalParams, callback: ServiceCallback<Person[]>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

options
LargePersonGroupPersonListOptionalParams

The optional parameters

callback

ServiceCallback<Person[]>

The callback

list(string, Models.LargePersonGroupPersonListOptionalParams)

List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

function list(largePersonGroupId: string, options?: Models.LargePersonGroupPersonListOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

options
Models.LargePersonGroupPersonListOptionalParams

Returns

Promise<Models.LargePersonGroupPersonListResponse>

Promise<Models.LargePersonGroupPersonListResponse>

list(string, ServiceCallback<Person[]>)

function list(largePersonGroupId: string, callback: ServiceCallback<Person[]>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

callback

ServiceCallback<Person[]>

The callback

update(string, string, LargePersonGroupPersonUpdateOptionalParams, ServiceCallback<void>)

function update(largePersonGroupId: string, personId: string, options: LargePersonGroupPersonUpdateOptionalParams, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options
LargePersonGroupPersonUpdateOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

update(string, string, Models.LargePersonGroupPersonUpdateOptionalParams)

Update name or userData of a person.

function update(largePersonGroupId: string, personId: string, options?: Models.LargePersonGroupPersonUpdateOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

options
Models.LargePersonGroupPersonUpdateOptionalParams

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

update(string, string, ServiceCallback<void>)

function update(largePersonGroupId: string, personId: string, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

callback

ServiceCallback<void>

The callback

updateFace(string, string, string, LargePersonGroupPersonUpdateFaceOptionalParams, ServiceCallback<void>)

function updateFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options: LargePersonGroupPersonUpdateFaceOptionalParams, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options
LargePersonGroupPersonUpdateFaceOptionalParams

The optional parameters

callback

ServiceCallback<void>

The callback

updateFace(string, string, string, Models.LargePersonGroupPersonUpdateFaceOptionalParams)

Update a person persisted face's userData field.

function updateFace(largePersonGroupId: string, personId: string, persistedFaceId: string, options?: Models.LargePersonGroupPersonUpdateFaceOptionalParams)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

options
Models.LargePersonGroupPersonUpdateFaceOptionalParams

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

updateFace(string, string, string, ServiceCallback<void>)

function updateFace(largePersonGroupId: string, personId: string, persistedFaceId: string, callback: ServiceCallback<void>)

Parameters

largePersonGroupId

string

Id referencing a particular large person group.

personId

string

Id referencing a particular person.

persistedFaceId

string

Id referencing a particular persistedFaceId of an existing face.

callback

ServiceCallback<void>

The callback