简介
本文档提供关于文本审核接口的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
提交文本文件审核任务 | 用于进行文本文件审核,为异步请求方式 | |
提交文本内容审核任务 | 用于进行文本内容的直接审核,请求方式为同步请求 | |
查询文本审核任务结果 | 用于查询文本审核任务结果 |
SDK API 参考
提交文本审核任务
功能说明
用于提交文本审核任务。
示例代码
// 存储桶名称,格式为 BucketName-APPIDString bucket = "examplebucket-1250000000";// 需要审核的对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"String cosPath = "dir1/exampleobject.txt";//需要审核的文本的链接地址String url = "https://myqcloud.com/%205text.txt";//需要审核的文本内容, 当传入的内容为纯文本信息,需要先经过 base64 编码,文本编码前的原文长度不能超过10000个 utf8 编码字符。若超出长度限制,接口将会报错。String content = Base64.encodeToString("测试文本".getBytes(Charset.forName("UTF-8")), Base64.NO_WRAP);PostTextAuditRequest request = new PostTextAuditRequest(bucket);// 以下cosPath、url、content选择一种即可request.setObject(cosPath);request.setUrl(url);request.setContent(content);//设置原始内容,长度限制为512字节,该字段会在响应中原样返回request.setDataId("DataId");//回调地址,以http://或者https://开头的地址。request.setCallback("https://github.com");//回调内容的结构,有效值:Simple(回调内容包含基本信息)、Detail(回调内容包含详细信息)。默认为 Simple。request.setCallbackVersion("Detail");// CIService 是 CosXmlService 的子类,初始化方法和 CosXmlService 一致ciService.postTextAuditAsync(request, new CosXmlResultListener() {@Overridepublic void onSuccess(CosXmlRequest request, CosXmlResult cosResult) {// result 提交文本审核任务的结果// 详细字段请查看api文档或者SDK源码// 当通过request.setContent(content)进行文本内容的直接审核时,对应api接口为 https://cloud.tencent.com/document/product/436/56289// 当通过request.setObject(cosPath)或request.setUrl(url)进行文本文件的异步审核时,对应api接口为 https://cloud.tencent.com/document/product/436/88136// 通过文本文件的异步审核时,需要通过下方”查询文本审核任务结果“接口查询详细的审核结果TextAuditResult result = (TextAuditResult) cosResult;}@Overridepublic void onFail(CosXmlRequest request, CosXmlClientException clientException, CosXmlServiceException serviceException) {if (clientException != null) {clientException.printStackTrace();} else {serviceException.printStackTrace();}}});
说明
查询文本审核任务结果
功能说明
用于查询文本审核任务结果。
注意
COS Android SDK 版本需要大于等于 v5.8.7。
示例代码
// 存储桶名称,格式为 BucketName-APPIDString bucket = "examplebucket-1250000000";// 审核任务的 IDString jobId = "iab1ca9fc8a3ed11ea834c525400863904";GetTextAuditRequest request = new GetTextAuditRequest(bucket, jobId);// CIService 是 CosXmlService 的子类,初始化方法和 CosXmlService 一致ciService.getTextAuditAsync(request, new CosXmlResultListener() {@Overridepublic void onSuccess(CosXmlRequest request, CosXmlResult cosResult) {// result 查询文本审核任务的结果// 详细字段请查看api文档或者SDK源码TextAuditResult result = (TextAuditResult) cosResult;}@Overridepublic void onFail(CosXmlRequest request, CosXmlClientException clientException, CosXmlServiceException serviceException) {if (clientException != null) {clientException.printStackTrace();} else {serviceException.printStackTrace();}}});
说明