ILargeFaceListOperations Interface

  • Reference

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:
ILargeFaceListOperations.cs

LargeFaceListOperations operations.

public interface ILargeFaceListOperations
type ILargeFaceListOperations = interface
Public Interface ILargeFaceListOperations
Derived

Methods

AddFaceFromStreamWithHttpMessagesAsync(String, Stream, String, IList<Int32>, String, Dictionary<String,List<String>>, CancellationToken)
AddFaceFromUrlWithHttpMessagesAsync(String, String, String, IList<Int32>, String, Dictionary<String,List<String>>, CancellationToken)
CreateWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken)

Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel. <br /> Large face list is a list of faces, up to 1,000,000 faces, and used by Face - Find Similar. <br /> After creation, user should use LargeFaceList Face - Add to import the faces and LargeFaceList - Train to make it ready for Face - FindSimilar. Faces are stored on server until LargeFaceList - Delete is called. <br /> 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. <br />

  • Free-tier subscription quota: 64 large face lists.
  • S0-tier subscription quota: 1,000,000 large face lists. <br /> '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.
DeleteFaceWithHttpMessagesAsync(String, Guid, Dictionary<String,List<String>>, CancellationToken)

Delete an existing face from a large face list (given by a persistedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.
DeleteWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)

Delete an existing large face list according to faceListId. Persisted face images in the large face list will also be deleted.
GetFaceWithHttpMessagesAsync(String, Guid, Dictionary<String,List<String>>, CancellationToken)

Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).
GetTrainingStatusWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)

Retrieve the training status of a large face list (completed or ongoing).
GetWithHttpMessagesAsync(String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel.
ListFacesWithHttpMessagesAsync(String, String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)

List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).
ListWithHttpMessagesAsync(Nullable<Boolean>, String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)
TrainWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)

Queue a large face list training task, the training task may not be started immediately.
UpdateFaceWithHttpMessagesAsync(String, Guid, String, Dictionary<String,List<String>>, CancellationToken)

Update a persisted face's userData field.
UpdateWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Update information of a large face list.

Extension Methods

AddFaceFromStreamAsync(ILargeFaceListOperations, String, Stream, String, IList<Int32>, String, CancellationToken)
AddFaceFromUrlAsync(ILargeFaceListOperations, String, String, String, IList<Int32>, String, CancellationToken)
CreateAsync(ILargeFaceListOperations, String, String, String, String, CancellationToken)

Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel. <br /> Large face list is a list of faces, up to 1,000,000 faces, and used by Face - Find Similar. <br /> After creation, user should use LargeFaceList Face - Add to import the faces and LargeFaceList - Train to make it ready for Face - FindSimilar. Faces are stored on server until LargeFaceList - Delete is called. <br /> 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. <br />

  • Free-tier subscription quota: 64 large face lists.
  • S0-tier subscription quota: 1,000,000 large face lists. <br /> '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.
DeleteAsync(ILargeFaceListOperations, String, CancellationToken)

Delete an existing large face list according to faceListId. Persisted face images in the large face list will also be deleted.
DeleteFaceAsync(ILargeFaceListOperations, String, Guid, CancellationToken)

Delete an existing face from a large face list (given by a persistedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.
GetAsync(ILargeFaceListOperations, String, Nullable<Boolean>, CancellationToken)

Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel.
GetFaceAsync(ILargeFaceListOperations, String, Guid, CancellationToken)

Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).
GetTrainingStatusAsync(ILargeFaceListOperations, String, CancellationToken)

Retrieve the training status of a large face list (completed or ongoing).
ListAsync(ILargeFaceListOperations, Nullable<Boolean>, String, Nullable<Int32>, CancellationToken)
ListFacesAsync(ILargeFaceListOperations, String, String, Nullable<Int32>, CancellationToken)

List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).
TrainAsync(ILargeFaceListOperations, String, CancellationToken)

Queue a large face list training task, the training task may not be started immediately.
UpdateAsync(ILargeFaceListOperations, String, String, String, CancellationToken)

Update information of a large face list.
UpdateFaceAsync(ILargeFaceListOperations, String, Guid, String, CancellationToken)

Update a persisted face's userData field.

Applies to