简介
本文档提供关于图片审核的 API 概览和 SDK 示例代码。
注意
COS 小程序 SDK 版本需要大于等于 v1.1.1。
图片同步审核
功能说明
图片审核的存量扫描功能通过借助数据万象的持久化处理接口,实现对 COS 存量数据的涉黄、违法违规以及广告引导类图片的扫描。
使用示例
var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};function getImageAuditing() {cos.request({Bucket: config.Bucket,Region: config.Region,Method: 'GET',Key: '1.png', /* 存储桶内的图片文件,非必须,与detect-url二选一传递 */Query: {'ci-process': 'sensitive-content-recognition', /** 固定值,必须 */'biz-type': '', /** 审核类型,非必须 */'detect-url': '', /** 审核任意公网可访问的图片链接,非必须,与Key二选一传递 */'interval': 5, /** 审核 GIF 动图时,每隔 interval 帧截取一帧,非必须 */'max-frames': 5, /** 审核 GIF 动图时,最大截帧数,非必须 */'large-image-detect': '0', /** 是否需要压缩图片后再审核,非必须 */'dataid': '123', /** 自定义图片标识,非必须 */},},function(err, data){console.log(err || data);});}
参数说明
Query 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
biz-type | Query | String | 否 | |
detect-url | Query | 您可以通过填写 detect-url 审核任意公网可访问的图片链接。不填写 detect-url 时,后台会默认审核 ObjectKey 。填写 detect-url 时,后台会审核 detect-url 链接,无需再填写 ObjectKey 、detect-url 。示例:http://www.example.com/abc.jpg。 | String | 否 |
interval | Query | 审核 GIF 动图时,可使用该参数进行截帧配置,代表截帧的间隔。例如值设为5,则表示从第1帧开始截取,每隔5帧截取一帧,默认值5。 | Int | 否 |
max-frames | Query | 针对 GIF 动图审核的最大截帧数量,需大于0。例如值设为5,则表示最大截取5帧,默认值为5。 | Int | 否 |
large-image-detect | Query | 对于超过大小限制的图片是否进行压缩后再审核,取值为:0(不压缩),1(压缩)。默认为0。 注意:压缩最大支持32M的图片,且会收取压缩费用。 | String | 否 |
dataid | Query | 图片标识,该字段在结果中返回原始内容,长度限制为512字节。 | String | 否 |
返回结果说明
图片批量审核
功能说明
图片批量审核接口为同步请求方式,您可以通过本接口对多个图片文件进行内容审核。该接口属于 POST 请求。
请求示例
var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};function postImagesAuditing() {var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';var url = 'https://' + host + '/image/auditing';var body = COS.util.json2xml({Request: {Input: [{Object: '1.png', /* 需要审核的图片,存储桶里的路径 */}, {Object: 'a/6.png', /* 需要审核的图片,存储桶里的路径 */}],Conf: {BizType: '', /* 不填写代表默认策略 */}}});cos.request({Bucket: config.Bucket,Region: config.Region,Method: 'POST',Url: url,Key: '/image/auditing', /** 固定值,必须 */ContentType: 'application/xml', /** 固定值,必须 */Body: body},function(err, data){console.log(err || data);});}
参数说明
request的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 图片批量审核的具体配置项。 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Input | Request | 需要审核的内容,如有多个图片,请传入多个 Input 结构。 | Container Array | 是 |
Conf | Request | 审核规则配置。 | Container | 是 |
Container 类型 Input 的具体数据描述如下,使用其中一种:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 存储在 COS 存储桶中的图片文件名称,例如在目录 test 中的文件 image.jpg,则文件名称为 test/image.jpg。Content,Object 和 Url 只能选择其中一种。 | String | 否 |
Url | Request.Input | 图片文件的链接地址,例如 http://a-1250000.cos.ap-shanghai.myqcloud.com/image.jpg 。Content,Object 和 Url 只能选择其中一种。 | String | 否 |
Content | Request.Input | 图片文件的内容,需要先经过 base64 编码。Content,Object 和 Url 只能选择其中一种,传入多个时仅一个生效,按 Content,Object, Url 顺序。 | String | 否 |
Interval | Request.Input | 截帧频率,GIF 图检测专用,默认值为5,表示从第一帧(包含)开始每隔5帧截取一帧。 | Int | 否 |
MaxFrames | Request.Input | 最大截帧数量,GIF 图检测专用,默认值为5,表示只截取 GIF 的5帧图片进行审核,必须大于0。 | Int | 否 |
DataId | Request.Input | 图片标识,该字段在结果中返回原始内容,长度限制为512字节。 | String | 否 |
Container 类型 Conf 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
BizType | Request.Conf | String | 否 |
注意
通过 Object 进行审核为内网操作,不会产生额外的外网流量。
通过 Url 进行审核,会产生图片所在源站对应的外网流量。