LargePersonGroupOperations class
Class representing a LargePersonGroupOperations.
Constructors
| Large |
Create a LargePersonGroupOperations. |
Methods
| create(string, string, Large |
Create a new large person group with user-specified largePersonGroupId, name, an optional
userData and recognitionModel.
Large person group quota:
|
| create(string, string, Large |
|
| create(string, string, Service |
|
| delete |
Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted. |
| delete |
|
| delete |
|
| get(string, Large |
Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use LargePersonGroup Person - List instead to retrieve person information under the large person group. |
| get(string, Large |
|
| get(string, Service |
|
| get |
Retrieve the training status of a large person group (completed or ongoing). |
| get |
|
| get |
|
| list(Large |
List all existing large person groups’ largePersonGroupId, name, userData and
recognitionModel.
|
| list(Large |
|
| list(Service |
|
| train(string, Request |
Queue a large person group training task, the training task may not be started immediately. |
| train(string, Request |
|
| train(string, Service |
|
| update(string, Large |
Update an existing large person group's display name and userData. The properties which does not appear in request body will not be updated. |
| update(string, Large |
|
| update(string, Service |
Constructor Details
LargePersonGroupOperations(FaceClientContext)
Create a LargePersonGroupOperations.
new LargePersonGroupOperations(client: FaceClientContext)Parameters
- client
- FaceClientContext
Reference to the service client.
Method Details
create(string, string, LargePersonGroupCreateOptionalParams)
Create a new large person group with user-specified largePersonGroupId, name, an optional
userData and recognitionModel.
A large person group is the container of the uploaded person data, including face
recognition feature, and up to 1,000,000
people.
After creation, use LargePersonGroup Person -
Create to add person
into the group, and call LargePersonGroup -
Train to get this group
ready for Face - Identify.
No image will be stored. Only the person's extracted face features and userData will be
stored on server until LargePersonGroup Person -
Delete or
LargePersonGroup - Delete
is called.
'recognitionModel' should be specified to associate with this large person group. 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 person group will use the recognition model that's already associated with the collection.
Existing face features in a large person group can't be updated to features extracted by another
version of recognition model. Please refer to Specify a face recognition
model.
Large person group quota:
- Free-tier subscription quota: 1,000 large person groups.
- S0-tier subscription quota: 1,000,000 large person groups.
function create(largePersonGroupId: string, name: string, options?: LargePersonGroupCreateOptionalParams): Promise<RestResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- name
-
string
User defined name, maximum length is 128.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
create(string, string, LargePersonGroupCreateOptionalParams, ServiceCallback<void>)
function create(largePersonGroupId: string, name: string, options: LargePersonGroupCreateOptionalParams, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- name
-
string
User defined name, maximum length is 128.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
create(string, string, ServiceCallback<void>)
function create(largePersonGroupId: string, name: string, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- name
-
string
User defined name, maximum length is 128.
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, RequestOptionsBase)
Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted.
function deleteMethod(largePersonGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(largePersonGroupId: string, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- callback
-
ServiceCallback<void>
The callback
get(string, LargePersonGroupGetOptionalParams)
Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use LargePersonGroup Person - List instead to retrieve person information under the large person group.
function get(largePersonGroupId: string, options?: LargePersonGroupGetOptionalParams): Promise<LargePersonGroupGetResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
The optional parameters
Returns
Promise<LargePersonGroupGetResponse>
Promise<Models.LargePersonGroupGetResponse>
get(string, LargePersonGroupGetOptionalParams, ServiceCallback<LargePersonGroup>)
function get(largePersonGroupId: string, options: LargePersonGroupGetOptionalParams, callback: ServiceCallback<LargePersonGroup>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
The optional parameters
- callback
The callback
get(string, ServiceCallback<LargePersonGroup>)
function get(largePersonGroupId: string, callback: ServiceCallback<LargePersonGroup>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- callback
The callback
getTrainingStatus(string, RequestOptionsBase)
Retrieve the training status of a large person group (completed or ongoing).
function getTrainingStatus(largePersonGroupId: string, options?: RequestOptionsBase): Promise<LargePersonGroupGetTrainingStatusResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.LargePersonGroupGetTrainingStatusResponse>
getTrainingStatus(string, RequestOptionsBase, ServiceCallback<TrainingStatus>)
function getTrainingStatus(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<TrainingStatus>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getTrainingStatus(string, ServiceCallback<TrainingStatus>)
function getTrainingStatus(largePersonGroupId: string, callback: ServiceCallback<TrainingStatus>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- callback
The callback
list(LargePersonGroupListOptionalParams)
List all existing large person groups’ largePersonGroupId, name, userData and
recognitionModel.
- Large person groups are stored in alphabetical order of largePersonGroupId.
- "start" parameter (string, optional) is a user-provided largePersonGroupId 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 groups: "group1", ..., "group5".
"start=&top=" will return all 5 groups.
"start=&top=2" will return "group1", "group2".
"start=group2&top=3" will return "group3", "group4", "group5".
function list(options?: LargePersonGroupListOptionalParams): Promise<LargePersonGroupListResponse>Parameters
The optional parameters
Returns
Promise<LargePersonGroupListResponse>
Promise<Models.LargePersonGroupListResponse>
list(LargePersonGroupListOptionalParams, ServiceCallback<LargePersonGroup[]>)
function list(options: LargePersonGroupListOptionalParams, callback: ServiceCallback<LargePersonGroup[]>)Parameters
The optional parameters
- callback
The callback
list(ServiceCallback<LargePersonGroup[]>)
function list(callback: ServiceCallback<LargePersonGroup[]>)Parameters
- callback
The callback
train(string, RequestOptionsBase)
Queue a large person group training task, the training task may not be started immediately.
function train(largePersonGroupId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
train(string, RequestOptionsBase, ServiceCallback<void>)
function train(largePersonGroupId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
train(string, ServiceCallback<void>)
function train(largePersonGroupId: string, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- callback
-
ServiceCallback<void>
The callback
update(string, LargePersonGroupUpdateOptionalParams)
Update an existing large person group's display name and userData. The properties which does not appear in request body will not be updated.
function update(largePersonGroupId: string, options?: LargePersonGroupUpdateOptionalParams): Promise<RestResponse>Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, LargePersonGroupUpdateOptionalParams, ServiceCallback<void>)
function update(largePersonGroupId: string, options: LargePersonGroupUpdateOptionalParams, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
update(string, ServiceCallback<void>)
function update(largePersonGroupId: string, callback: ServiceCallback<void>)Parameters
- largePersonGroupId
-
string
Id referencing a particular large person group.
- callback
-
ServiceCallback<void>
The callback