FaceListOperations Class

Definition

FaceListOperations operations.

public class FaceListOperations : Microsoft.Azure.CognitiveServices.Vision.Face.IFaceListOperations, Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient>
type FaceListOperations = class
    interface IServiceOperations<FaceClient>
    interface IFaceListOperations
Public Class FaceListOperations
Implements IFaceListOperations, IServiceOperations(Of FaceClient)
Inheritance
FaceListOperations
Implements

Constructors

FaceListOperations(FaceClient)

Initializes a new instance of the FaceListOperations class.

Properties

Client

Gets a reference to the FaceClient

Methods

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

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

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

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

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 face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription. <br /> Face list is a list of faces, up to 1,000 faces, and used by Face - Find Similar. <br /> After creation, user should use FaceList - Add Face to import the faces. Faces are stored on server until FaceList - 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 /> Please consider LargeFaceList when the face number is large. It can support up to 1,000,000 faces. 'recognitionModel' should be specified to associate with this 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 face list will use the recognition model that's already associated with the collection. Existing face features in a 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 face list (given by a persistedFaceId and a faceListId). Persisted image related to the face will also be deleted.

DeleteWithHttpMessagesAsync(String, Dictionary<String,List<String>>, CancellationToken)

Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.

GetWithHttpMessagesAsync(String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.

ListWithHttpMessagesAsync(Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

List face lists’ faceListId, name, userData and recognitionModel. <br /> To get face information inside faceList use FaceList - Get

UpdateWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Update information of a face list.

Extension Methods

AddFaceFromStreamAsync(IFaceListOperations, String, Stream, String, IList<Int32>, String, CancellationToken)
AddFaceFromStreamAsync(IFaceListOperations, String, Stream, String, IList<Int32>, CancellationToken)

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

AddFaceFromUrlAsync(IFaceListOperations, String, String, String, IList<Int32>, String, CancellationToken)
AddFaceFromUrlAsync(IFaceListOperations, String, String, String, IList<Int32>, CancellationToken)

Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire.

CreateAsync(IFaceListOperations, String, String, String, String, CancellationToken)

Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription. <br /> Face list is a list of faces, up to 1,000 faces, and used by Face - Find Similar. <br /> After creation, user should use FaceList - Add Face to import the faces. Faces are stored on server until FaceList - 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 /> Please consider LargeFaceList when the face number is large. It can support up to 1,000,000 faces. 'recognitionModel' should be specified to associate with this 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 face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.

DeleteAsync(IFaceListOperations, String, CancellationToken)

Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.

DeleteFaceAsync(IFaceListOperations, String, Guid, CancellationToken)

Delete an existing face from a face list (given by a persistedFaceId and a faceListId). Persisted image related to the face will also be deleted.

GetAsync(IFaceListOperations, String, Nullable<Boolean>, CancellationToken)

Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.

ListAsync(IFaceListOperations, Nullable<Boolean>, CancellationToken)

List face lists’ faceListId, name, userData and recognitionModel. <br /> To get face information inside faceList use FaceList - Get

UpdateAsync(IFaceListOperations, String, String, String, CancellationToken)

Update information of a face list.

Applies to