功能描述
本接口用于提交一个文档审核任务,可审核您的文档文件是否存在敏感违规信息。文档审核结合了对象存储(Cloud Object Storage,COS)文档预览功能,通过预先将文档转成图片,结合图片内容审核、图片 OCR 审核等方式,进行文档审核。
说明
目前支持的输入文件类型包含如下格式:
演示文件:pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm。
文字文件:doc、dot、wps、wpt、docx、dotx、docm、dotm。
表格文件:xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。
其他格式文件:pdf。
表格文件,一张表可能分割为多页转换,生成多张图片。
输入文件大小限制在200MB之内。
输入文件页数限制在5000页之内。
请求
请求示例
POST /document/auditing HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
说明
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Input><Url></Url><Type></Type></Input><Conf><DetectType></DetectType><Callback></Callback><BizType></BizType></Conf></Request>
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 文档审核的具体配置项 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Input | Request | 需要审核的内容 | Container | 是 |
Conf | Request | 审核规则配置 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Url | Request.Input | 文档文件的链接地址,例如 http://www.example.com/doctest.doc | String | 是 |
Type | Request.Input | 指定文档文件的类型,如未指定则默认以文件的后缀为类型。 如果文件没有后缀,该字段必须指定,否则会审核失败。例如:doc、docx、ppt、pptx 等 | String | 否 |
Container 类型 Conf 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
BizType | Request.Conf | 审核策略,不填写则使用默认策略。可在控制台进行配置,详情请参见 设置审核策略 | String | 否 |
DetectType | Request.Conf | 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads | String | 否 |
Callback | Request.Conf | 审核结果可以回调形式发送至您的回调地址,支持以 http:// 或者 https:// 开头的地址,例如:http://www.callback.com | String | 否 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Request><JobsDetail><JobId></JobId><State></State><CreationTime></CreationTime></JobsDetail></Request>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
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 /document/auditing HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Input><Url>http://www.example.com/doctest.doc</Url><Type></Type></Input><Conf><DetectType>Porn,Ads</DetectType><Callback></Callback><BizType>b81d45f94b91a683255e9a9506f4****</BizType></Conf></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><JobId>vab1ca9fc8a3ed11ea834c52540086****</JobId><State>Submitted</State><CreationTime>2019-07-07T12:12:12+0800</CreationTime></JobsDetail></Response>