API 文档

提交网页审核任务

最近更新时间:2021-12-21 14:39:36

功能描述

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

该接口支持情况如下:

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

费用说明

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

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

请求

请求示例

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>
  </Input>
  <Conf>
    <DetectType>Porn,Ads</DetectType>
    <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

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

节点名称(关键字) 父节点 描述 类型 是否必选
DetectType Request.Conf 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。 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 的内容:

节点名称(关键字) 父节点 描述 类型
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>

目录