文档审核

最近更新时间:2023-09-08 18:17:03

我的收藏

简介

内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
说明
使用内容审核服务需拥有数据万象使用权限:
主账号请 单击此处 进行角色授权。
子账号请参见 授权子账号接入数据万象服务 文档。
本文档提供关于文档审核的 API 概览和 SDK 示例代码。
API
操作描述
用于提交一个文档审核任务
用于查询指定的文档审核任务

提交文档审核任务

功能说明

用于提交一个文档审核任务。

方法原型

DocumentAuditingResponse createAuditingDocumentJobs(DocumentAuditingRequest request);

请求示例

//1.创建任务请求对象
DocumentAuditingRequest request = new DocumentAuditingRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
//2.1.1设置对象地址
// request.getInput().setObject("1.txt");
//2.1.2或直接设置文档地址
request.getInput().setUrl("https://markjrzhang-1251704708.cos.ap-chongqing.myqcloud.com/%E9%97%AE%E9%A2%98%E6%B1%87%E6%80%BB.pptx");
//2.2设置审核类型参数
request.getConf().setDetectType("all");
//3.调用接口,获取任务响应对象
DocumentAuditingResponse response = client.createAuditingDocumentJobs(request);

参数说明

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
Callback
Request.Conf
审核结果可以回调形式发送至您的回调地址,支持以 http:// 或者 https:// 开头的地址,例如:http://www.callback.com
String

返回结果说明

成功:成功则返回 DocumentAuditingResponse 文档审核任务结果对象。
失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

查询文档审核任务

功能说明

用于查询文档审核任务执行情况和结果。

方法原型

DocumentAuditingResponse describeAuditingJob(DocumentAuditingRequest request);

请求示例

//1.创建任务请求对象
DocumentAuditingRequest request = new DocumentAuditingRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setJobId("sdd5d1cc630fdc11ecb3fa5254009******");
//3.调用接口,获取任务响应对象
DocumentAuditingResponse response = client.describeAuditingDocumentJob(request);

参数说明

参数名称
描述
类型
是否必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
jobId
需要查询的任务 ID
String

返回结果说明

成功: 返回 DocumentAuditingResponse 审核任务结果对象。
失败: 发生错误(例如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理