GetImageCroppingSuggestions - 获取图片裁剪建议(裁剪框位置)

获取图片裁剪建议。

接口说明

  • 此接口已不再维护,建议使用新版(2020-09-30 版本)接口 DetectImageCropping 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

  • 此接口不依赖媒体集。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:GetImageCroppingSuggestions
*全部资源
*

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immimagetest
ImageUristring

图片的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

oss://imm-test/testcases/imagecroppingtest.jpg
AspectRatiosstring

裁剪比例列表,仅支持整数比例。

["1:1","2:3"]

返回参数

名称类型描述示例值
object
RequestIdstring

当次请求的 Request ID。

EA153782-13A5-44EE-835A-90A14FC51352
ImageUristring

图片的 OSS URI。

oss://imm-test/testcases/imagecroppingtest.jpg
CroppingSuggestionsarray<object>

图片的裁剪建议。

CroppingSuggestionsobject
Scorefloat

该裁剪方案的美学分数,分数越高表示该方案效果越好,取值范围为 0~1。

0.6979608535766602
CroppingBoundaryobject

裁剪框信息。

Topinteger

顶点 Y 坐标,距离顶端距离。单位为 px。

77
Widthinteger

裁剪框宽度。单位为 px。

500
Heightinteger

裁剪框高度。单位为 px。

500
Leftinteger

顶点 X 坐标,距离左端距离。单位为 px。

0
AspectRatiostring

图片裁剪比例。

1:1

示例

正常返回示例

JSON格式

{
  "RequestId": "EA153782-13A5-44EE-835A-90A14FC51352",
  "ImageUri": "oss://imm-test/testcases/imagecroppingtest.jpg",
  "CroppingSuggestions": [
    {
      "Score": 0.6979608535766602,
      "CroppingBoundary": {
        "Top": 77,
        "Width": 500,
        "Height": 500,
        "Left": 0
      },
      "AspectRatio": "1:1"
    }
  ]
}

错误码

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