FaceMatch Interface

This is the metadata structure of the bounding box coordinates, reliability (the bounding box contains a face), face ID,
etc. returned by the searchFaces(), listFaces() methods, etc.
Instance Properties
Name Description
faceId: string A unique identifier assigned to the face.
boundingBox: BoundingBox Bounding box of the face.
  • width: Width of the bounding box as a ratio of the overall image width.
  • height: Height of the bounding box as a ratio of the overall image height.
  • left: Left coordinate of the bounding box as a ratio of overall image width.
  • top: Top coordinate of the bounding box as a ratio of overall image height.
externalImageId?: string Identifier that you assign to all the faces in the input image.
similarity?: number Confidence in the match of this face with the input face.
Valid Range: Minimum value of 0. Maximum value of 100.