Share via


ILargePersonGroupOperations.CreateWithHttpMessagesAsync Method

Definition

Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel. <br /> A large person group is the container of the uploaded person data, including face images and face recognition feature, and up to 1,000,000 people. <br /> After creation, use LargePersonGroup Person - Create to add person into the group, and call LargePersonGroup - Train to get this group ready for Face - Identify. <br /> The person face, image, and userData will be stored on server until LargePersonGroup Person - Delete or LargePersonGroup - Delete is called. <br />

  • Free-tier subscription quota: 1,000 large person groups.
  • S0-tier subscription quota: 1,000,000 large person groups. <br /> 'recognitionModel' should be specified to associate with this large person group. 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 person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.
public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync (string largePersonGroupId, 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 (largePersonGroupId 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

largePersonGroupId
String

Id referencing a particular large person group.

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