IPersonGroupOperations Interface

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Vision.Face

Assembly:

Microsoft.Azure.CognitiveServices.Vision.Face.dll

Package:

Microsoft.Azure.CognitiveServices.Vision.Face v2.8.0-preview.3

Source:

IPersonGroupOperations.cs

PersonGroupOperations operations.

public interface IPersonGroupOperations

type IPersonGroupOperations = interface

Public Interface IPersonGroupOperations

Derived

Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations

Methods

CreateWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken)	Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel. <br /> A person group is the container of the uploaded person data, including face images and face recognition features. <br /> After creation, use PersonGroup Person - Create to add persons into the group, and then call PersonGroup - Train to get this group ready for Face - Identify. <br /> The person's face, image, and userData will be stored on server until PersonGroup Person - Delete or PersonGroup - Delete is called. <br /> Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons. S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons. to handle larger scale face identification problem, please consider using LargePersonGroup. <br /> 'recognitionModel' should be specified to associate with this 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 person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.
DeleteWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)	Delete an existing person group. Persisted face features of all people in the person group will also be deleted.
GetTrainingStatusWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)	Retrieve the training status of a person group (completed or ongoing).
GetWithHttpMessagesAsync(String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)	Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person List](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395241).
ListWithHttpMessagesAsync(String, Nullable<Int32>, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)	List person groups’s personGroupId, name, userData and recognitionModel.<br /> Person groups are stored in alphabetical order of personGroupId. "start" parameter (string, optional) is a user-provided personGroupId 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 retuned entry’s Id of the current call. <br /> For example, total 5 person groups: "group1", ..., "group5". <br /> "start=&top=" will return all 5 groups. <br /> "start=&top=2" will return "group1", "group2". <br /> "start=group2&top=3" will return "group3", "group4", "group5".
TrainWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)	Queue a person group training task, the training task may not be started immediately.
UpdateWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)	Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated.

Extension Methods

CreateAsync(IPersonGroupOperations, String, String, String, String, CancellationToken)	Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel. <br /> A person group is the container of the uploaded person data, including face images and face recognition features. <br /> After creation, use PersonGroup Person - Create to add persons into the group, and then call PersonGroup - Train to get this group ready for Face - Identify. <br /> The person's face, image, and userData will be stored on server until PersonGroup Person - Delete or PersonGroup - Delete is called. <br /> Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons. S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons. to handle larger scale face identification problem, please consider using LargePersonGroup. <br /> 'recognitionModel' should be specified to associate with this 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 person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.
DeleteAsync(IPersonGroupOperations, String, CancellationToken)	Delete an existing person group. Persisted face features of all people in the person group will also be deleted.
GetAsync(IPersonGroupOperations, String, Nullable<Boolean>, CancellationToken)	Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use PersonGroup Person - List.
GetTrainingStatusAsync(IPersonGroupOperations, String, CancellationToken)	Retrieve the training status of a person group (completed or ongoing).
ListAsync(IPersonGroupOperations, String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	List person groups’s personGroupId, name, userData and recognitionModel.<br /> Person groups are stored in alphabetical order of personGroupId. "start" parameter (string, optional) is a user-provided personGroupId 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 retuned entry’s Id of the current call. <br /> For example, total 5 person groups: "group1", ..., "group5". <br /> "start=&top=" will return all 5 groups. <br /> "start=&top=2" will return "group1", "group2". <br /> "start=group2&top=3" will return "group3", "group4", "group5".
TrainAsync(IPersonGroupOperations, String, CancellationToken)	Queue a person group training task, the training task may not be started immediately.
UpdateAsync(IPersonGroupOperations, String, String, String, CancellationToken)	Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated.