FaceListOperationsExtensions.CreateAsync Method

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:

FaceListOperationsExtensions.cs

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.

public static System.Threading.Tasks.Task CreateAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.IFaceListOperations operations, string faceListId, string name, string userData = default, string recognitionModel = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAsync : Microsoft.Azure.CognitiveServices.Vision.Face.IFaceListOperations * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function CreateAsync (operations As IFaceListOperations, faceListId As String, name As String, Optional userData As String = Nothing, Optional recognitionModel As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations

IFaceListOperations

The operations group for this extension method.

faceListId

String

Id referencing a particular face list.

name

String

User defined name, maximum length is 128.

userData

String

User specified data. Length should not exceed 16KB.

recognitionModel

String

Possible values include: 'recognition_01', 'recognition_02'

cancellationToken

CancellationToken

The cancellation token.

Returns

Task