find_similars

Creates, updates, deletes, gets or lists a find_similars resource.

Overview

Name	find_similars
Type	Resource
Id	azure.ai_vision_face.find_similars

Fields

The following fields are returned by SELECT queries:

find_similar

Name	Datatype	Description
confidence	number	Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1]. Required.
faceId	string	faceId of candidate face when find by faceIds. faceId is created by "Detect" and will expire 24 hours after the detection call.
persistedFaceId	string	persistedFaceId of candidate face when find by faceListId or largeFaceListId. persistedFaceId in face list/large face list is persisted and will not expire.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
find_similar	select	endpoint, api_version		Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Please refer to https://learn.microsoft.com/rest/api/face/face-recognition-operations/find-similar for more details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_version	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client apiVersion parameter. (default: )
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

SELECT examples

find_similar

Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Please refer to https://learn.microsoft.com/rest/api/face/face-recognition-operations/find-similar for more details.

SELECT
confidence,
faceId,
persistedFaceId
FROM azure.ai_vision_face.find_similars
WHERE endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
;