DescribeImageResultExt - 图片辅助信息获取接口

更新时间:
复制为 MD 格式

图片审核增强版辅助信息API用于获取图片审核增强版API接口识别的更多辅助信息,包含图片文字识别结果、自定义图库命中信息等。

接口说明

本接口需要配合图片审核增强版 API 使用,在调用图片审核增强版 API 接口之后,可以调用本接口,获取更多的接口检测信息。此接口免费。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-greenweb:DescribeImageResultExt

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ReqId

string

图片审核增强版 API 返回的 requestId 字段

638EDDC65C82AB39319A9F60

InfoType

string

需要获取的信息内容,多个值使用英文逗号隔开,取值:

  • customImage:自定义图库命中信息

  • textInImage:图片中文字信息

customImage,textInImage

建议调用图片审核增强版接口 5 秒钟之后查询,辅助信息存储最长时间为 30 天,建议您需要时及时获取辅助信息,并做好日志存储。

返回参数

名称

类型

描述

示例值

object

返回对象。

RequestId

string

请求 ID。

6CF2815C-C8C7-4A01-B52E-FF6E24F53492

Code

integer

状态码。

200

Msg

string

请求信息的响应信息。

success

Data

object

返回数据。

CustomImage

array

自定义图库命中信息列表。

object

自定义图库命中信息。

ImageId

string

图片 ID。

123456

LibName

string

图库名。

图库123

LibId

string

图库 ID。

123456

TextInImage

object

返回命中的图片中文字信息。

OcrDatas

array

返回识别到的图片中的文字信息。

string

文字信息。

abcd

RiskWords

array

命中风险关键词

string

文字信息。

abcd

CustomTexts

array

当命中自定义文本库时,返回自定义库 ID、自定义库名称和自定义词。

object

LibId

string

自定义库 ID

123456

LibName

string

自定义库名称。

自定义库1

KeyWords

string

自定义词,多个词用逗号分隔。

自定义词1,自定义词2

PublicFigure

array

人物信息列表。

object

人物信息。

FigureId

string

人物 ID。

yzazhzou

示例

正常返回示例

JSON格式

{
  "RequestId": "6CF2815C-C8C7-4A01-B52E-FF6E24F53492",
  "Code": 200,
  "Msg": "success",
  "Data": {
    "CustomImage": [
      {
        "ImageId": "123456",
        "LibName": "图库123",
        "LibId": "123456"
      }
    ],
    "TextInImage": {
      "OcrDatas": [
        "abcd"
      ],
      "RiskWords": [
        "abcd"
      ],
      "CustomTexts": [
        {
          "LibId": "123456",
          "LibName": "自定义库1",
          "KeyWords": "自定义词1,自定义词2"
        }
      ]
    },
    "PublicFigure": [
      {
        "FigureId": "yzazhzou"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情