FaceListOperations.CreateWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken) Method

Definition

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 System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync (string faceListId, string name = default, string userData = default, string recognitionModel = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.CreateWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
Public Function CreateWithHttpMessagesAsync (faceListId As String, Optional name As String = Nothing, Optional userData As String = Nothing, Optional recognitionModel As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

faceListId
System.String

Id referencing a particular face list.

name
System.String

User defined name, maximum length is 128.

userData
System.String

User specified data. Length should not exceed 16KB.

recognitionModel
System.String

Possible values include: 'recognition_01', 'recognition_02'

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

Headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<HttpOperationResponse>

Implements

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

System.ArgumentNullException

Thrown when a required parameter is null

Applies to