DetectImageCropping - 通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域

更新时间:
复制为 MD 格式

通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imm:DetectImageCropping

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

请求参数

名称

类型

必填

描述

示例值

ProjectName

string

项目名称。

immtest

SourceURI

string

图片的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://imm-test/testcases/facetest.jpg

AspectRatios

string

裁剪比例列表。最多可设置 5 个比例,单个裁剪比例要求如下。

  • 比例必须为整数比例,取值范围为(0,20)。

  • 比例范围必须控制在[0.5,2]之间。

  • 不填写此参数时,默认按照["auto"]处理。

说明

以下情况会出现报错提示:
-设置的比例大于 5 个。
-传入的列表为空。
-比例不为整数,例如4.1:3
-比例范围小于 0.5 或大于 2。

["1:1"]

CredentialConfig CredentialConfig

如无特殊需求,请保持留空即可。

链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

InclusionHints

array

希望裁剪结果包含的物体的语义文本描述列表。每个元素为自由文本(如 "招牌"、"菜品")。

说明

InclusionHInts 参数使用限制:
-最多传入一个元素。
-仅在国内地域支持此参数。

["sign"]

string

希望裁剪结果包含的物体的语义文本描述

sign

返回参数

名称

类型

描述

示例值

object

图片裁剪结果。

Croppings

array

图片裁剪数组信息。

CroppingSuggestion

图片的裁剪详细信息。

RequestId

string

请求 ID。

91AC8C98-0F36-49D2-8290-742E24D*****

MatchedInclusionHints

array

裁剪框内包含的物体列表,与输入参数 InclusionHints 对应。如果没有包含任何物体,则为空。

string

裁剪框内包含的物体

sign

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情