Help Center/ Face Recognition Service/ API Reference/ APIs/ Facial Resource Management/ Adding a Face
Updated on 2024-06-12 GMT+08:00
View PDF
Share

Adding a Face

Function

This API is used to add faces to a facial image library. All detected faces in the input facial image will be added to the library.

Prerequisites:

Ensure that you have enabled FRS. For detailed operations, see Applying for FRS.

Restrictions:
  • Only images in JPG, PNG, JPEG, or BMP format can be recognized.
  • Use standard JSON format in the body of the application/json request.
  • Do not use carriage return characters in Base64 code.
  • The system does not save images of users.
  • The image size must be less than 8 MB. If the image is too large, the latency is long and the image information volume is small. It is recommended that the image size be less than 1 MB.
  • The image resolution must be less than 4,096 x 2,160. The face resolution in an image must be greater than 80 x 80. It is recommended that the face resolution be greater than 120 x 120.
  • To ensure the recognition effect, facial images need to meet the following requirements:
    1. The illumination should be greater than 200 lux and there is no light reflection or shadow caused by strong light.
    2. The overall image is clear without obvious motion blur and the face in it is not blocked.
    3. The side face angle does not exceed 30°, and the tilt angle and horizontal angle do not exceed 15°. The face in an image must be a vertically placed front face.
  • For details about other restrictions, see Restrictions and Limitations.
Suggestions:
  • A larger image does not significantly improve the recognition algorithm precision but will cause a long latency. Therefore, you are advised to upload an image smaller than 1 MB. Generally, 500 KB is enough.
  • It is recommended that the size of an image stored on OBS be less than 1 MB.
  • It is recommended that the face resolution in an image be greater than 120 x 120.

URI

POST /v2/{project_id}/face-sets/{face_set_name}/faces

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining the Project ID/Account Name/AK/SK.

face_set_name

Yes

String

Name of a facial image library.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

During API authentication using a token, the token is added to requests to obtain permissions for calling the API. The value of X-Subject-Token in the response header is the obtained token.

Content-Type

Yes

String

MIME type of the request body. The value is application/json.
Table 3 Request body parameters

Parameter

Type

Mandatory

Description

image_url

String

Either image_url, image_file, or image_base64 is mandatory.

Image URL. Currently, only the URL of an OBS bucket on Huawei Cloud is supported and FRS must have the permission to read data in the OBS bucket. For details about how to enable the read permission, see Service Authorization.

image_file

File

Either image_file, image_url, or image_base64 is mandatory.

Local image file, whose size cannot exceed 8 MB. It is recommended that the image size be less than 1 MB. The request format is Multipart.

image_base64

String

Either image_base64, image_file, or image_url is mandatory.
Image data (Base64-encoded). The value must meet the following requirements:
  • The image size after Base64 encoding cannot exceed 8 MB. It is recommended that the image size be less than 1 MB.
  • The image is in JPG, JPEG, BMP, or PNG format.

external_image_id

String

No

External image ID specified by the user. It is bound to the current image. If the user does not provide one, it is generated by the system.

The ID contains 1 to 36 characters, including letters, digits, hyphens (-), and underscores (_). Other special characters are not allowed.

external_fields

Object

No

Custom data

You need to define this field when creating a facial image library so that you can use custom fields to add faces. For details, see Customized Fields.

single

boolean

No

Whether to add the largest face in the image to the library. The options are as follows:

  • true: Only the largest face in the facial image is added to the library.
  • false (default value): true: All faces in the image are added to the library.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

face_set_id

String

ID of the facial image library. This parameter is not included when the API fails to be called.

face_set_name

String

Name of the facial image library. This parameter is not included when the API fails to be called.

faces

Array of FaceSetFace objects

Face structure in the facial image library. For details, see FaceSetFace. This parameter is not included when the API fails to be called.
Table 5 FaceSetFace

Parameter

Type

Description

bounding_box

BoundingBox object

Position of a face in an image. For details about the BoundingBox structure, see BoundingBox.

external_fields

Object

Additional field a user customizes

external_image_id

String

ID of the external image to which a face belongs

face_id

String

Face ID, which is a unique ID generated by the system
Table 6 BoundingBox

Parameter

Type

Description

width

Integer

Width of a rectangle

top_left_y

Integer

Vertical coordinate of the upper-left corner of a rectangle

top_left_x

Integer

Horizontal coordinate of the upper-left corner of a rectangle

height

Integer

Height of a rectangle

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code when calling the API failed. This parameter is not included when the API is successfully called.

error_msg

String

Error message returned after the API fails to be called. This parameter is not included when the API is successfully called.

Example Requests

For details about how to obtain the value of X-Auth-Token, see Authentication.

  • Example request (Method 1: Use a Base64-encoded image.) 
    POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

Request Body:
{
  "image_base64": "/9j/4AAQSkZJRgABAgEASABIAAD",
  "external_image_id": "imageID",
  "external_fields": {
     "timestamp": 12,
     "id": "home"
  }
}
  • Example request (Method 2: Use an image file.) 
    POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces
Request Header:
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

Request Body:
image_file: File (image file)
external_image_id: imageID
external_fields: {"timestamp" : 12,"id" : "home"}
  • Example request (Method 3: Use the image URL.) 
    POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...

Request Body:
{
  "image_url":"/BucketName/ObjectName",
  "external_image_id":"imageID",
  "external_fields" : {
     "timestamp": 12,
     "id": "home"
  } 
}

Example Responses

Status code: 200

Response example (successful request) 
{
  "face_set_id": "T785tx1N",
  "face_set_name": "showFaceSet",
  "faces": [
    {
      "bounding_box": {
        "width": 63,
        "top_left_y": 100,
        "top_left_x": 221,
        "height": 63
      },
      "external_image_id": "Xr0phyap",
      "external_fields" : {
        "timestamp": 12,
        "id": "home"
      },
      "face_id": "JLa9hYLl"
    }
  ]
}

Status code: 400

Example response (failed request) 
{
  "error_code": "FRS.0404",
  "error_msg": "Detect no face, can not add it to face set."
}

Status Code

For details about the status code, see Status Codes.

Error Code

For details about the error code, see Error Codes.