控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

功能描述

本接口用于提交一个网页审核任务。网页审核功能为异步任务方式,您可以通过提交网页审核任务审核您的网页文件,然后通过 查询网页审核任务接口网页审核回调 查询审核结果。

该接口支持情况如下:

  • 支持对网页文件进行自动检测,从 OCR 文本识别、物体检测(实体、广告台标、二维码等)、图像识别几个维度,通过深度学习技术,识别网页中的违规内容。
  • 支持识别多种违规场景,包括:色情、违法、广告等场景。

费用说明

网页的审核分为网页画面审核网页文字审核,其中:

  • 网页画面审核:通过爬取网页内图片的方式,将爬取的多张图片进行审核,审核费用与图片审核一致。
  • 网页文本审核:将网页内的文本分离出来进行文本审核,审核费用与文本审核一致。
  • 每个审核场景单独计费,例如您选择审核涉黄、广告两种场景,则审核1个网页计2次审核费用。
  • 调用接口会产生 图片审核费用文本审核费用COS 请求费用

推荐使用 SDK

对象存储 SDK 提供了完整的 Demo、自动集成、计算签名等能力。您可通过 SDK 方便快捷地调用接口。点此查看 SDK 文档

请求

请求示例

POST /webpage/auditing HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>

说明:

  • Authorization: Auth String(详情请参见 请求签名 文档)。
  • 通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体:

<Request>
  <Input>
    <Url></Url>
        <DataId></DataId>
        <UserInfo></UserInfo>
  </Input>
  <Conf>
    <Biztype></Biztype>
    <Callback></Callback>
    <ReturnHighlightHtml>true</ReturnHighlightHtml>
  </Conf>
</Request>

具体的数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Request 网页审核的具体配置项。 Container

Container 类型 Request 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Input Request 需要审核的网页信息。 Container
Conf Request 审核规则配置。 Container

Container 类型 Input 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Url Request.Input 网页文件的链接地址,例如 http://www.test.com String
DataId Request.Input 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 String
UserInfo Request.Input 用户业务字段。 Container

Container 节点 UserInfo 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
TokenId Request.Input.UserInfo 一般用于表示账号信息,长度不超过128字节。 String
Nickname Request.Input.UserInfo 一般用于表示昵称信息,长度不超过128字节。 String
DeviceId Request.Input.UserInfo 一般用于表示设备信息,长度不超过128字节。 String
AppId Request.Input.UserInfo 一般用于表示 App 的唯一标识,长度不超过128字节。 String
Room Request.Input.UserInfo 一般用于表示房间号信息,长度不超过128字节。 String
IP Request.Input.UserInfo 一般用于表示 IP 地址信息,长度不超过128字节。 String
Type Request.Input.UserInfo 一般用于表示业务类型,长度不超过128字节。 String
ReceiveTokenId Request.Input.UserInfo 一般用于表示接收消息的用户账号,长度不超过128字节。 String
Gender Request.Input.UserInfo 一般用于表示性别信息,长度不超过128字节。 String
Level Request.Input.UserInfo 一般用于表示等级信息,长度不超过128字节。 String
Role Request.Input.UserInfo 一般用于表示角色信息,长度不超过128字节。 String

Container 类型 Conf 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
BizType Request.Conf 表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等。您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时,将自动使用默认的审核策略。 String
DetectType Request.Conf (该参数后续不再维护,请使用BizType参数)审核的场景类型,有效值:Porn(涉黄)、Ads(广告)等,可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。如您有更多场景的审核需要,请使用 BizType 参数。 String
Callback Request.Conf 回调地址,以http://或者https://开头的地址。 String
ReturnHighlightHtml Request.Conf 指定是否需要高亮展示网页内的违规文本,查询及回调结果时会根据此参数决定是否返回高亮展示的 html 内容。取值为 true 或者 false,默认为 false。 Boolean

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

<Response>
    <JobsDetail>
      <JobId></JobId>
      <State></State>
      <CreationTime></CreationTime>
    </JobsDetail>
</Response>

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型
Response 网页审核返回的具体响应内容。 Container

Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
JobsDetail Response 网页审核任务的详细信息。 Container

Container 节点 JobsDetail 的内容:

节点名称(关键字) 父节点 描述 类型
DataId Response.JobsDetail 请求中添加的 DataId 字段。 String
JobId Response.JobsDetail 本次网页审核任务的 ID。 String
State Response.JobsDetail 网页审核任务的状态,值为 Submitted(已提交审核)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个 String
CreationTime Response.JobsDetail 网页审核任务的创建时间。 String

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /webpage/auditing HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
  <Input>
    <Url>http://test.com</Url>
  </Input>
  <Conf>
    <ReturnHighlightHtml>true</ReturnHighlightHtml>
    <DetectType>Porn,Ads</DetectType>
  </Conf>
</Request>

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <CreationTime>2021-11-09T09:55:53+08:00</CreationTime>
        <JobId>sh2c1260a4410011eca1f1525400276c76</JobId>
        <State>Submitted</State>
        <Url>http://test.com</Url>
    </JobsDetail>
    <RequestId>NjE4OWQ1Mjlf*****MzQ0OF85</RequestId>
</Response>

目录