控制台指南

最佳实践

开发者指南

数据湖存储

API 文档

SDK 文档

文档捉虫大赛火热进行中,好礼多多> HOT

简介

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

说明:

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

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

注意:

COS Javascript SDK 版本需要大于等于 v1.3.1。

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

提交文本审核任务

功能说明

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

请求示例

function postTextAuditing() {
  var config = {
    // 需要替换成您自己的存储桶信息
    Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
  };
  var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
  var url = 'https://' + host + '/text/auditing';
  var body = COS.util.json2xml({
    Request: {
      Input: {
        Object: 'hello.txt', /* 需要审核的文本文件,存储桶里的路径 */
      },
      Conf: {
        BizType: '',
        DetectType: 'Porn',
      }
    }
  });
  cos.request({
      Bucket: config.Bucket,
      Region: config.Region,
      Method: 'POST',
      Url: url,
      Key: '/text/auditing', /** 固定值,必须 */
      ContentType: 'application/xml', /** 固定值,必须 */
      Body: body
  },
  function(err, data){
      console.log(err || data);
  });
}
postTextAuditing();

参数说明

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 时,审核结果为同步返回,可通过查看响应体 TextAuditingResponse 获取返回结果。
  • 目前仅支持中文、英文、阿拉伯数字的检测与审核。

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

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

返回结果说明

详情请参见 提交文本审核任务

查询文本审核任务

功能说明

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

请求示例

function getTextAuditingResult() {
  var config = {
    // 需要替换成您自己的存储桶信息
    Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
  };
  var jobId = 'st8d88c664aff511ecb23352540078cxxx'; // jobId可以通过提交文本审核任务返回(Input传入Object)
  var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
  var url = 'https://' + host + '/text/auditing/' + jobId;
  cos.request({
      Bucket: config.Bucket,
      Region: config.Region,
      Method: 'GET',
      Key: '/text/auditing/' + jobId,
      Url: url,
  },
  function(err, data){
      console.log(err || data);
  });
}
getTextAuditingResult();

参数说明

参数名称 描述 类型 是否必选
jobId 需要查询的任务 ID String

返回结果说明

详情请参见 查询文本审核任务结果

目录