Interface FaceResult

Face results

  • Combined results of face detector, face mesh, age, gender, emotion, embedding, iris models
  • Some values may be null if specific model is not enabled
interface FaceResult {
    age?: number;
    annotations: Record<FaceLandmark, Point[]>;
    box: Box;
    boxRaw: Box;
    boxScore: number;
    distance?: number;
    embedding?: number[];
    emotion?: { emotion: Emotion; score: number }[];
    faceScore: number;
    gender?: Gender;
    genderScore?: number;
    id: number;
    live?: number;
    mesh: Point[];
    meshRaw: Point[];
    race?: { race: Race; score: number }[];
    real?: number;
    rotation?:
        | null
        | {
            angle: { pitch: number; roll: number; yaw: number };
            gaze: { bearing: number; strength: number };
            matrix: [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ];
        };
    score: number;
    size: [number, number];
    tensor?: Tensor;
}

Properties

age? annotations box boxRaw boxScore distance? embedding? emotion? faceScore gender? genderScore? id live? mesh meshRaw race? real? rotation? score size tensor?

Properties

Optionalage

age?: number

detected age

annotations

annotations: Record<FaceLandmark, Point[]>

mesh keypoints combined into annotated results

box

box: Box

detected face box

boxRaw

boxRaw: Box

detected face box normalized to 0..1

boxScore

boxScore: number

detection score

Optionaldistance

distance?: number

face distance from camera

Optionalembedding

embedding?: number[]

face descriptor

Optionalemotion

emotion?: { emotion: Emotion; score: number }[]

detected emotions

faceScore

faceScore: number

mesh score

Optionalgender

gender?: Gender

detected gender

OptionalgenderScore

genderScore?: number

gender detection score

id

id: number

face id

Optionallive

live?: number

face liveness result confidence

mesh

mesh: Point[]

detected face mesh

meshRaw

meshRaw: Point[]

detected face mesh normalized to 0..1

Optionalrace

race?: { race: Race; score: number }[]

detected race

Optionalreal

real?: number

face anti-spoofing result confidence

Optionalrotation

rotation?:
    | null
    | {
        angle: { pitch: number; roll: number; yaw: number };
        gaze: { bearing: number; strength: number };
        matrix: [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ];
    }

face rotation details

score

score: number

overall face score

size

size: [number, number]

detected face box size

Optionaltensor

tensor?: Tensor

detected face as tensor that can be used in further pipelines

Settings

Member Visibility

On This Page

Properties