SimilarFace interface

Package:

@azure/cognitiveservices-face

Response body for find similar face operation.

Properties

confidence	Similarity confidence of the candidate face. The higher confidence, the more similar. Range between [0,1].
faceId	FaceId of candidate face when find by faceIds. faceId is created by Face - Detect and will expire at the time specified by faceIdTimeToLive after the detection call
persistedFaceId	PersistedFaceId of candidate face when find by faceListId. persistedFaceId in face list is persisted and will not expire. As showed in below response

Property Details

confidence

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

confidence: number

Property Value

number

faceId

FaceId of candidate face when find by faceIds. faceId is created by Face - Detect and will expire at the time specified by faceIdTimeToLive after the detection call

faceId?: string

Property Value

string

persistedFaceId

PersistedFaceId of candidate face when find by faceListId. persistedFaceId in face list is persisted and will not expire. As showed in below response

persistedFaceId?: string

Property Value

string