Class ComparedFacesPair

Represents a result of the ComparedFace attempt to compare input images.

Index

Accessors

error first score second similarity

Accessors

error

get error(): MatchFacesException | null
The error describes a failed pair comparison and contains MatchFacesErrorCode codes.

Returns MatchFacesException | null
- Defined in match_faces/compared_faces_pair.d.ts:33

first

get first(): ComparedFace
The first face in the comparison pair.

Returns ComparedFace
- Defined in match_faces/compared_faces_pair.d.ts:11

score

get score(): number
The raw value returned by the service without applying any thresholds or comparison rules. The value shows the degree of similarity of compared faces, the lower - the more similar, and vice versa less similar. The score is used in conjunction with the input image imageType to evaluate similarity.

Returns number
- Defined in match_faces/compared_faces_pair.d.ts:28

second

get second(): ComparedFace
The second face in the comparison pair.

Returns ComparedFace
- Defined in match_faces/compared_faces_pair.d.ts:16

similarity

get similarity(): number
Similarity of the faces pair. Floating point value from 0 to 1.

Returns number
- Defined in match_faces/compared_faces_pair.d.ts:21