ILargeFaceListOperations.CreateWithHttpMessagesAsync Method

Definition

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.
public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync (string largeFaceListId, string name, 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>
Public Function CreateWithHttpMessagesAsync (largeFaceListId As String, name As String, 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

largeFaceListId
String

Id referencing a particular large 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'

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to