Image cropping suggestions

Sample input

• Intelligent Media Management (IMM) project name: test-project

• Object Storage Service (OSS) storage address of the source image: oss://test-bucket/test-object.jpg

• Cropping ratios: 1:1, 16:9, and auto (automatically set)

• Sample image:

  

Sample request

The following sample request specifies the project, the source image, and the cropping ratios:

{
    "ProjectName": "test-project",
    "SourceURI": "oss://test-bucket/test-object.jpg",
    "AspectRatios": "[\"1:1\",\"16:9\",\"auto\"]"
}

Sample response

The following response is returned:

{
  "RequestId": "AFD39290-659F-5474-AFF5-5640CB140405",
  "Croppings": [
    {
      "AspectRatio": "1:1",
      "Confidence": 0.481,
      "Boundary": {
        "Left": 14,
        "Top": 39,
        "Height": 200,
        "Width": 200
      }
    },
    {
      "AspectRatio": "16:9",
      "Confidence": 0.748,
      "Boundary": {
        "Left": 24,
        "Top": 39,
        "Height": 200,
        "Width": 355
      }
    },
    {
      "AspectRatio": "auto",
      "Confidence": 0.844,
      "Boundary": {
        "Left": 18,
        "Top": 13,
        "Height": 250,
        "Width": 366
      }
    }
  ]
}

Cropping suggestions

The following table describes the cropping frame that the sample response returns for each cropping ratio. The Confidence field carries the aesthetic score of the frame. The X coordinate and the Y coordinate specify the cropping start point, with the upper-left corner of the image as the origin.

Sample code

The following sample code shows how to obtain image cropping suggestions by using IMM SDK for Python.

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
import os
from typing import List

from alibabacloud_imm20200930.client import Client as imm20200930Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_imm20200930 import models as imm_20200930_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client(
        access_key_id: str,
        access_key_secret: str,
    ) -> imm20200930Client:
        """
        Initialize the account client with an AccessKey ID and an AccessKey secret.
        @param access_key_id:
        @param access_key_secret:
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config(
            access_key_id=access_key_id,
            access_key_secret=access_key_secret
        )
        # Specify the IMM endpoint that you want to access.
        config.endpoint = f'imm.cn-beijing.aliyuncs.com'
        return imm20200930Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        # An AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to make API calls or perform routine O&M.
        # Do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account may be compromised.
        # In this example, the AccessKey pair is read from environment variables to authenticate API access. For more information about how to configure environment variables, see https://help.aliyun.com/document_detail/2361894.html.
        imm_access_key_id = os.getenv("AccessKeyId")
        imm_access_key_secret = os.getenv("AccessKeySecret")
        # Initialize the client.
        client = Sample.create_client(imm_access_key_id, imm_access_key_secret)
        detect_image_cropping_request = imm_20200930_models.DetectImageCroppingRequest(
            project_name='test-project',
            source_uri='oss://test-bucket/test-object.jpg',
            aspect_ratios='["1:1","16:9","auto"]'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # If you copy and run the code, print the response of the API operation as needed.
            client.detect_image_cropping_with_options(detect_image_cropping_request, runtime)
        except Exception as error:
            # Print the error message as needed.
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        # An AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to make API calls or perform routine O&M.
        # Do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account may be compromised.
        # In this example, the AccessKey pair is read from environment variables to authenticate API access. For more information about how to configure environment variables, see https://help.aliyun.com/document_detail/2361894.html.
        imm_access_key_id = os.getenv("AccessKeyId")
        imm_access_key_secret = os.getenv("AccessKeySecret")
        # Initialize the client.
        client = Sample.create_client(imm_access_key_id, imm_access_key_secret)
        detect_image_cropping_request = imm_20200930_models.DetectImageCroppingRequest(
            project_name='test-project',
            source_uri='oss://test-bucket/test-object.jpg',
            aspect_ratios='["1:1","16:9","auto"]'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # If you copy and run the code, print the response of the API operation as needed.
            await client.detect_image_cropping_with_options_async(detect_image_cropping_request, runtime)
        except Exception as error:
            # Print the error message as needed.
            UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])