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<Rank>;
}

Properties

age?: number

detected age

annotations: Record<FaceLandmark, Point[]>

mesh keypoints combined into annotated results

box: Box

detected face box

boxRaw: Box

detected face box normalized to 0..1

boxScore: number

detection score

distance?: number

face distance from camera

embedding?: number[]

face descriptor

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

detected emotions

Type declaration

faceScore: number

mesh score

gender?: Gender

detected gender

genderScore?: number

gender detection score

id: number

face id

live?: number

face liveness result confidence

mesh: Point[]

detected face mesh

meshRaw: Point[]

detected face mesh normalized to 0..1

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

detected race

Type declaration

  • race: Race
  • score: number
real?: number

face anti-spoofing result confidence

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

Type declaration

  • angle: {
        pitch: number;
        roll: number;
        yaw: number;
    }
    • pitch: number
    • roll: number
    • yaw: number
  • gaze: {
        bearing: number;
        strength: number;
    }
    • bearing: number
    • strength: number
  • matrix: [number, number, number, number, number, number, number, number, number]
score: number

overall face score

size: [number, number]

detected face box size

tensor?: Tensor<Rank>

detected face as tensor that can be used in further pipelines