FaceOperationsExtensions.GroupAsync 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:

FaceOperationsExtensions.cs

Divide candidate faces into groups based on face similarity.<br />

• The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result.
• MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.
• Group API needs at least 2 candidate faces and 1000 at most. We suggest to try Face - Verify when you only have 2 candidate faces.
• The 'recognitionModel' associated with the query faces' faceIds should be the same.

C#

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.GroupResult> GroupAsync(this Microsoft.Azure.CognitiveServices.Vision.Face.IFaceOperations operations, System.Collections.Generic.IList<Guid> faceIds, System.Threading.CancellationToken cancellationToken = default);

Parameters

operations

IFaceOperations

The operations group for this extension method.

faceIds

IList<Guid>

Array of candidate faceId created by Face - Detect. The maximum is 1000 faces

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<GroupResult>

Applies to