FaceClient.FindSimilar Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

Azure.AI.Vision.Face v1.0.0-beta.2

Overloads

FindSimilar(RequestContent, RequestContext)

[Protocol Method] Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.

FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)

Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.

FindSimilar(RequestContent, RequestContext)

Source:

FaceClient.cs

[Protocol Method] Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response FindSimilar (Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member FindSimilar : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.FindSimilar : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function FindSimilar (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call FindSimilar and parse the result.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceClient client = new FaceClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    faceId = "c5c24a82-6845-4031-9d5d-978df9175426",
    maxNumOfCandidatesReturned = 3,
    mode = "matchPerson",
    faceIds = new object[]
    {
        "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
        "be386ab3-af91-4104-9e6d-4dae4c9fddb7"
    },
});
Response response = client.FindSimilar(content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].GetProperty("confidence").ToString());

FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)

Source:

FaceClient.cs

Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.FaceFindSimilarResult>> FindSimilar (Guid faceId, System.Collections.Generic.IEnumerable<Guid> faceIds, int? maxNumOfCandidatesReturned = default, Azure.AI.Vision.Face.FindSimilarMatchMode? mode = default, System.Threading.CancellationToken cancellationToken = default);

abstract member FindSimilar : Guid * seq<Guid> * Nullable<int> * Nullable<Azure.AI.Vision.Face.FindSimilarMatchMode> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.FaceFindSimilarResult>>
override this.FindSimilar : Guid * seq<Guid> * Nullable<int> * Nullable<Azure.AI.Vision.Face.FindSimilarMatchMode> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.FaceFindSimilarResult>>

Public Overridable Function FindSimilar (faceId As Guid, faceIds As IEnumerable(Of Guid), Optional maxNumOfCandidatesReturned As Nullable(Of Integer) = Nothing, Optional mode As Nullable(Of FindSimilarMatchMode) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of FaceFindSimilarResult))

Parameters

faceId

Guid

faceId of the query face. User needs to call "Detect" first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call.

faceIds

IEnumerable<Guid>

An array of candidate faceIds. All of them are created by "Detect" and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000.

maxNumOfCandidatesReturned

Nullable<Int32>

The number of top similar faces returned. The valid range is [1, 1000]. Default value is 20.

mode

Nullable<FindSimilarMatchMode>

Similar face searching mode. It can be 'matchPerson' or 'matchFace'. Default value is 'matchPerson'.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<FaceFindSimilarResult>>

Exceptions

ArgumentNullException

faceIds is null.

Examples

This sample shows how to call FindSimilar.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
FaceClient client = new FaceClient(endpoint, credential);

Response<IReadOnlyList<FaceFindSimilarResult>> response = client.FindSimilar(Guid.Parse("c5c24a82-6845-4031-9d5d-978df9175426"), new Guid[] { Guid.Parse("015839fb-fbd9-4f79-ace9-7675fc2f1dd9"), Guid.Parse("be386ab3-af91-4104-9e6d-4dae4c9fddb7") });

Remarks

Please refer to https://learn.microsoft.com/rest/api/face/face-recognition-operations/find-similar for more details.