Face AnalyticsAdmin Scope

Note: Ensure you have installed the required package to use this SDK method.

Zia Face Analytics performs facial detection in images, and analyzes the facial features to provide information such as the gender, age, and emotion of the detected faces. You must provide .jpg/.jpeg or .png files as the input.

The analyseFace() method accepts the input image as its argument. You can specify the analysis mode as basic, moderate, or advanced. You can also specify the attributes age, smile, or gender as true to detect or false to not detect. These values are optional. All attributes are detected and the advanced mode is processed by default.

The zia reference used in the code snippets below is the component instance created to perform these operations. The promise returned here is resolved to a JSON object.

copy
const fs = require('fs');
const result = await zia.analyseFace(fs.createReadStream('./face.png'), {
  mode: 'moderate', // set analysis mode
  age: true, // enable age detection
  emotion: true, // enable emotion detection
  gender: false // disable gender detection
});
console.log(result);

Example of Expected Response

A sample response that you will receive is shown below. The response returns the prediction of the enabled attributes, the coordinates and landmarks of facial features of each face, and the confidence score of each analysis.

copy
{
  "faces_count": 1,
  "faces": [{
    "co_ordinates": ["401", "193", "494", "313"],
    "emotion": {
      "confidence": {
        "smiling": "0.75",
        "not_smiling": "0.25"
      },
      "prediction": "smiling"
    },
    "gender": {},
    "confidence": 1,
    "id": "0",
    "landmarks": {
      "right_eye": [["467", "230"]],
      "nose": [["451", "264"]],
      "mouth_right": [["474", "278"]],
      "left_eye": [["426", "239"]],
      "mouth_left": [["434", "283"]]
    },
    "age": {
      "confidence": {
        "20-29": "0.73",
        "30-39": "0.08",
        "0-2": "0.0",
        "40-49": "0.0",
        "50-59": "0.0",
        ">70": "0.0",
        "60-69": "0.0",
        "10-19": "0.17",
        "3-9": "0.0"
      },
      "prediction": "20-29"
    }
  }]
}

Last Updated 2026-07-02 14:51:41 +0530 IST