简介
本文档提供文档审核相关的 API 概览以及 SDK 示例代码。
注意
API | 操作描述 |
用于提交一个文档审核任务。 | |
用来查询指定的文档审核任务。 |
提交文档审核任务
功能说明
本接口用于提交一个文档审核任务。文档审核功能为异步任务方式，您可以通过提交文档审核任务来审核您的文档文件，然后通过查询文档审核任务接口查询审核结果。
示例代码
"""测试 CI 文档文件内容审核的接口"""# 先创建 cos client# 识别 cos 上的文档response = client.ci_auditing_document_submit(Bucket=bucket_name,Url='https://www.test.com/sss.docx',Type='docx',)print response
参数说明
调用 ci_auditing_document_submit 函数，具体请求参数如下：
参数名称 | 描述 | 类型 | 是否必选 |
Bucket | 存储桶名称。 | String | 是 |
Key | 对象文件名，例如 picture.jpg。 | String | 否 |
Url | 支持直接使用非 COS 上的文档 url 进行审核。 | String | 否 |
Type | 指定文档文件的类型，如未指定则默认以文件的后缀为类型。如果文件没有后缀，该字段必须指定，否则会审核失败。例如：doc、docx、ppt、pptx 等。 | String | 否 |
Callback | 回调地址，以 http:// 或者 https:// 开头的地址。 | String | 否 |
CallbackType | 回调片段类型，有效值：1（回调全部分页）、2（回调违规分页）。默认为 1。 | Int | 否 |
BizType | 表示审核策略的唯一标识，您可以通过控制台上的审核策略页面，配置您希望审核的场景，如涉黄、广告、违法违规等，配置指引： 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时，此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时，将自动使用默认的审核策略。 | String | 否 |
UserInfo | Dict | 否 | |
DataId | 该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 | String | 否 |
Freeze | Dict | 否 |
注意：
参数Key 和 Url 只能选择其中一种。
当Key 和 Url同时传入时，仅处理Key参数内容。
返回参数说明
查询文档审核任务结果
功能说明
本接口用于主动查询指定的文档审核任务结果。文档审核功能为异步任务方式，您可以通过提交文档审核任务来审核您的文档文件，然后通过查询文档审核任务接口查询审核结果。
示例代码
"""测试 CI 查询审核任务结果的接口"""# 先创建 cos client# 查询审核的结果response = client.ci_auditing_document_query(Bucket='bucket',JobID='v11122zxxxazzz')print response
参数说明
调用 ci_auditing_document_query 函数，具体请求参数如下：
参数名称 | 描述 | 类型 | 是否必选 |
Bucket | 存储桶名称。 | String | 是 |
JobID | 任务 ID。 | String | 是 |
