Sign in

v5

latestSwagger 2.02026-07-136680294.1 KB

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

Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity.

Find similar has two working modes, "matchPerson" and "matchFace". "matchPerson" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. "matchFace" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces.

The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array.

post/findsimilars

Request body

faceIdstring uuid required

Universally Unique Identifier

maxNumOfCandidatesReturnedinteger

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

mode'matchPerson' | 'matchFace'

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

faceIdsAzureCoreUuid[] required

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.

Response

A successful call returns an array of the most similar faces represented in faceId if the input parameter is faceIds or persistedFaceId if the input parameter is faceListId or largeFaceListId.

confidencenumber float required

Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1].

faceIdstring uuid

Universally Unique Identifier

persistedFaceIdstring uuid

Universally Unique Identifier