简介
本文档提供关于异常图片检测的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
API | 操作描述 |
检测图片中是否隐含其他类型的可疑文件 | |
提交一个异常图片检测任务 |
异常图片检测同步请求
功能说明
ImageInspect 接口可检测图片中是否隐含其他类型的可疑文件。
使用示例
function imageInspectSync() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const ObjectKey = "test.jpg";const key = `${ObjectKey}`; // ObjectKey:{ObjectKey};const host = `${config.Bucket}.cos.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// ;是否必传:是"ci-process": "ImageInspect",},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}imageInspectSync()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Key | {ObjectKey} | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
ci-process | 数据万象处理能力,异常图片检测固定为 ImageInspect | String | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
- Response | Object |
相关链接
API 文档
功能指南
提交任务
功能说明
提交一个异常图片检测任务。
使用示例
function createImageInspectJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `jobs` //const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 创建任务的 Tag:ImageInspect;是否必传:是Tag: "ImageInspect",// 待操作的文件信息;是否必传:是Input: {// 文件路径;是否必传:是Object: "test.jpg",},// 操作规则;是否必传:否Operation: {// 透传用户信息,可打印的 ASCII 码,长度不超过1024;是否必传:否UserData: "",// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否JobLevel: "0",// 该任务的参数;是否必传:否ImageInspect: {// 是否开启识别到图片异常后自动对图片进行如移动到其他目录、设置为私有权限、删除等动作。取值:true/false,默认为false;是否必传:否AutoProcess: "",// 指定检测到异常图片后的处理动作BackupObject:将图片移动 abnormal_images_backup下,该目录由后台自动创建SwitchObjectToPrivate:将图片权限设置为私有DeleteObject:删除图片默认值:BackupObject当 AutoProcess 为 true 时,该参数生效;是否必传:否ProcessType: "",},},// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式;是否必传:否CallBackFormat: "",// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型;是否必传:否CallBackType: "Url",// 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调;是否必传:否CallBack: "",}});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}createImageInspectJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Key | 固定值:jobs | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南