DetectImageCropping - Intelligent Media Management - Alibaba Cloud Documentation Center

Detects the cropping area that produces the optimal visual effect based on a given image ratio by using AI model capabilities.

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:DetectImageCropping	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 URI of the Object Storage Service (OSS) bucket in which you store the image. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the image file that has an extension.	oss://imm-test/testcases/facetest.jpg
AspectRatios	string	No	The cropping ratios. You can specify up to five cropping ratios. Take note of the following requirements: The ratio must be an integer between 0 and 20. The ratio must range from 0.5 to 2. If you leave this parameter empty, the default processing logic is `["auto"]`. Note Errors are reported in one of the following cases: You specify more than five cropping ratios. You pass an empty list to the system. You specify a ratio that is not an integer, such as `4.1:3`. The ratio is beyond the range of 0.5 to 2.	["1:1"]
CredentialConfig	CredentialConfig	No	If you do not have special requirements, leave this parameter empty. The authorization chain. This parameter is optional. For more information, see Use authorization chains to access resources of other entities.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Croppings	array	The image croppings.
Croppings	CroppingSuggestion	The image cropping.
RequestId	string	The request ID.	91AC8C98-0F36-49D2-8290-742E24D*****

Examples

Sample success responses

JSONformat

{
  "Croppings": [
    {
      "AspectRatio": "2:3",
      "Confidence": 0.7079545259475708,
      "Boundary": {
        "Width": 200,
        "Height": 300,
        "Left": 10,
        "Top": 30,
        "Polygon": [
          {
            "X": 10,
            "Y": 10
          }
        ]
      }
    }
  ],
  "RequestId": "91AC8C98-0F36-49D2-8290-742E24D*****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history