Image cropping suggestions

Image clipping information

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

• Image location: oss://test-bucket/test-object.jpg

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

• Image:

  

Sample request

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

Sample response

{
  "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 provides suggestions on image cropping based on the sample response.

Sample code

The following sample code provides an example on how to use IMM SDK for Python to crop images:

# -*- 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 client with an AccessKey ID & 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 domain name 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 for an Alibaba Cloud account has permissions on all API operations. For security, we recommend that you use a Resource Access Management (RAM) user to make API calls or for routine O&M.
        # Do not hard-code your AccessKey ID and AccessKey secret in your project code. If you do, your AccessKey pair may be leaked, which compromises the security of all your resources.
        # This example shows how to read an AccessKey pair from environment variables to verify identity for 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:
            # When you run the copied code, print the return value of the API operation.
            client.detect_image_cropping_with_options(detect_image_cropping_request, runtime)
        except Exception as error:
            # If an error occurs, print the error message.
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        # An AccessKey pair for an Alibaba Cloud account has permissions on all API operations. For security, we recommend that you use a RAM user to make API calls or for routine O&M.
        # Do not hard-code your AccessKey ID and AccessKey secret in your project code. If you do, your AccessKey pair may be leaked, which compromises the security of all your resources.
        # This example shows how to read an AccessKey pair from environment variables to verify identity for 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:
            # When you run the copied code, print the return value of the API operation.
            await client.detect_image_cropping_with_options_async(detect_image_cropping_request, runtime)
        except Exception as error:
            # If an error occurs, print the error message.
            UtilClient.assert_as_string(error.message)


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