DescribeFileModerationResult - 查询文档检测结果

更新时间:
复制为 MD 格式

文档审核结果

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-greenweb:DescribeFileModerationResult

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Service

string

文件检测增强版支持的服务

document_detection

ServiceParameters

string

审核服务需要的参数集,JSON 字符串格式。

  • taskId:必填,待检测对象的 URL,请确保该 URL 能通过公网访问到。

{\"taskId\":\"vi_f_hPgx9PFIQISdlfA888hOFG-1yJq8v\"}

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

6CF2815C-C8C7-4A01-B52E-FF6E24F53492

Code

integer

返回码。返回 200 代表成功。

200

Message

string

错误信息

OK

Data

object

返回数据。

DataId

string

数据 ID。

26769ada6e264e7ba9aa048241e12be9

Url

string

文件下载 URL 路径。

https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf

DocType

string

可选,文档类型

doc

PageResult

array<object>

检测结果列表

array<object>

结果内容

PageNum

integer

页码。

1

ImageUrl

string

图片地址

https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg

TextUrl

string

文本内容保存地址

https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt

ImageResult

array<object>

图片检测结果

array<object>

结果内容

Description

string

描述

这个是标题

Service

string

调用的服务

baselineCheck

Location

object

位置信息

X

integer

坐标点的 X 值。

11

Y

integer

坐标点的 Y 值。

22

W

integer

坐标点的 W 值。

33

H

integer

坐标点的 H 值。

44

LabelResult

array<object>

标签信息

object

标签信息

Label

string

标签

nonlabel

Confidence

number

分险分

25.0

Description

string

描述

这个是标题

RiskLevel

string

风险等级

high

TextResult

array<object>

文本审核结果。

object

结果内容

Description

string

描述

这是一个标题

Service

string

服务

chat_detection

Text

string

文本内容

吧啦吧啦

TextSegment

string

文本分段信息

[0,999]

Labels

string

标签的值。

porn

Descriptions

string

标签描述。

疑似广告内容

RiskWords

string

命中风险关键词

xxx

RiskTips

string

命中风险详情

xxx

RiskLevel

string

风险等级

high

PageSummary

object

汇总信息

PageSum

integer

总页数

1

ImageSummary

object

图片汇总信息

RiskLevel

string

风险等级

high

ImageLabels

array<object>

图片标签。

object

图片标签。

Label

string

标签。

contraband

LabelSum

integer

标签出现次数。

1

Description

string

标签描述

test

TextSummary

object

文本汇总信息

RiskLevel

string

风险等级

high

TextLabels

array<object>

文本标签。

object

文本标签。

Label

string

标签。

contraband

LabelSum

integer

标签出现次数。

1

Description

string

标签描述。

未检测出风险

RiskLevel

string

风险等级

high

AccountId

string

客户入参 AccountId

accountIdtest123

示例

正常返回示例

JSON格式

{
  "RequestId": "6CF2815C-C8C7-4A01-B52E-FF6E24F53492",
  "Code": 200,
  "Message": "OK",
  "Data": {
    "DataId": "26769ada6e264e7ba9aa048241e12be9",
    "Url": "https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf",
    "DocType": "doc",
    "PageResult": [
      {
        "PageNum": 1,
        "ImageUrl": "https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.jpg",
        "TextUrl": "https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.txt",
        "ImageResult": [
          {
            "Description": "这个是标题",
            "Service": "baselineCheck",
            "Location": {
              "X": 11,
              "Y": 22,
              "W": 33,
              "H": 44
            },
            "LabelResult": [
              {
                "Label": "nonlabel",
                "Confidence": 25,
                "Description": "这个是标题\n"
              }
            ],
            "RiskLevel": "high"
          }
        ],
        "TextResult": [
          {
            "Description": "这是一个标题",
            "Service": "chat_detection",
            "Text": "吧啦吧啦",
            "TextSegment": "[0,999]",
            "Labels": "porn",
            "Descriptions": "疑似广告内容",
            "RiskWords": "xxx",
            "RiskTips": "xxx",
            "RiskLevel": "high"
          }
        ]
      }
    ],
    "PageSummary": {
      "PageSum": 1,
      "ImageSummary": {
        "RiskLevel": "high",
        "ImageLabels": [
          {
            "Label": "contraband",
            "LabelSum": 1,
            "Description": "test"
          }
        ]
      },
      "TextSummary": {
        "RiskLevel": "high",
        "TextLabels": [
          {
            "Label": "contraband",
            "LabelSum": 1,
            "Description": "未检测出风险"
          }
        ]
      }
    },
    "RiskLevel": "high",
    "AccountId": "accountIdtest123"
  }
}

错误码

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

变更历史

更多信息,参考变更详情