API 文档

SDK 文档

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

简介

内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。

说明:

使用内容审核服务需拥有数据万象使用权限:

本文档提供关于文本审核的 API 概览和 SDK 示例代码。

API 操作描述
提交文本审核任务 用于提交一个文本审核任务
查询文本审核任务结果 用于查询指定的文本审核任务

提交文本审核任务

功能说明

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

方法原型

TextAuditingResponse createAuditingTextJobs(TextAuditingRequest request);

请求示例

//1.创建任务请求对象
TextAuditingRequest request = new TextAuditingRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-12500000008");
//2.1.1设置对象地址
//request.getInput().setObject("1.txt");
//2.1.2或直接设置请求内容,文本内容的Base64编码
request.getInput().setContent("Base64Str");
//2.2设置审核类型参数
request.getConf().setDetectType("all");
//2.3设置审核模板(可选)
//request.getConf().setBizType("aa3e9d84a6a079556b0109a935c*****");
//3.调用接口,获取任务响应对象
TextAuditingResponse response = client.createAuditingTextJobs(request);

参数说明

Request 中的具体数据描述如下:

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

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

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

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

节点名称(关键字) 父节点 描述 类型 是否必选
Object Request.Input 当前 COS 存储桶中的文本文件名称,例如在目录 test 中的文件 img.jpg,则文件名称为 test/img.jpg,文本文件仅支持UTF8编码和 GBK 编码的内容,且文件大小不得超过1MB。 String
Content Request.Input 当传入的内容为纯文本信息,需要先经过 base64 编码,文本编码前的原文长度不能超过10000个 utf8 编码字符。若超出长度限制,接口将会报错。 String
注意:

  • 不可同时输入 Object 和 Content。
  • 当选择 Object 时,审核结果为异步返回,可通过 查询文本审核任务结果 API 接口获取返回结果。
  • 当选择 Content 时,审核结果为同步返回,可通过 响应体 查看返回结果。
  • 目前仅支持中文、英文、阿拉伯数字的检测与审核。

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

节点名称(关键字) 父节点 描述 类型 是否必选
BizType Request.Conf 审核策略,不填写则使用默认策略。可在控制台进行配置,详情请参见 设置公共审核策略 String
DetectType Request.Conf 审核的场景类型,有效值:Porn(涉黄)、Ads(广告)、Illegal(违法)、Abuse(谩骂),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。 String
Callback Request.Conf 审核结果可以回调形式发送至您的回调地址,支持以http://或者https://开头的地址,例如:http://www.callback.com String

返回结果说明

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

查询文本审核任务

功能说明

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

方法原型

TextAuditingResponse describeAuditingTextJob(TextAuditingRequest request);

请求示例

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

参数说明

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

返回结果说明

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