DetectImageFaces - Intelligent Media Management - Alibaba Cloud Documentation Center

Detects faces from an image, including face boundary information, attributes, and quality. The boundary information includes the distance from the y-coordinate of the vertex to the top edge (Top), distance from the x-coordinate of the vertex to the left edge (Left), height (Height), and width (Width). Face attributes include the age (Age), age standard deviation (AgeSD), gender (Gender), emotion (Emotion), mouth opening (Mouth), beard (Beard), hat wearing (Hat), mask wearing (Mask), glasses wearing (Glasses), head orientation (HeadPose), attractiveness (Attractive), and confidence levels for preceding attributes. Quality information includes the face quality score (FaceQuality) and face resolution (Sharpness).

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
For information about the image encoding formats supported by this operation, see Limits .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
imm:DetectImageFaces	none	*Project `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project.	immtest
SourceURI	string	No	The OSS URI of the image object. Specify the OSS URI in the oss://${Bucket}/${Object} format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object with the extension included.	oss://test-bucket/test-object.jpg
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see Use authorization chains to access resources of other entities.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6E93D6C9-5AC0-49F9-914D-E02678D3****
Faces	array	The faces.
Faces	Figure	The details of the face.

Examples

Sample success responses

JSONformat

{
  "RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****",
  "Faces": [
    {
      "FigureId": "868a9e74-cde5-4c7a-9013-28bb984****",
      "FigureConfidence": 1,
      "FigureClusterId": "Cluster-dbe72fec-b84c-4ab6-885b-3678e64****",
      "FigureClusterConfidence": 1,
      "FigureType": "face",
      "Age": 29,
      "AgeSD": 5,
      "Gender": "female",
      "GenderConfidence": 1,
      "Emotion": "happiness",
      "EmotionConfidence": 0.70784568786621,
      "FaceQuality": 0.960875928401947,
      "Boundary": {
        "Width": 200,
        "Height": 300,
        "Left": 10,
        "Top": 30,
        "Polygon": [
          {
            "X": 10,
            "Y": 10
          }
        ]
      },
      "Mouth": "close",
      "MouthConfidence": 1,
      "Beard": "none",
      "BeardConfidence": 1,
      "Hat": "none",
      "HatConfidence": 1,
      "Mask": "none",
      "MaskConfidence": 1,
      "Glasses": "none",
      "GlassesConfidence": 0.8,
      "Sharpness": 0.7,
      "Attractive": 0.96,
      "HeadPose": {
        "Pitch": 18.385589599609375,
        "Roll": 4.204030513763428,
        "Yaw": 2.4945924282073975
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-19	The Error code has changed	View Change Details