简介
内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
说明:使用内容审核服务需拥有数据万象使用权限:
- 主账号请 单击此处 进行角色授权。
- 子账号请参见 授权子账号接入数据万象服务 文档。
本文档提供关于网页审核的 API 概览和 SDK 示例代码。
注意:COS 小程序 SDK 版本需要大于等于 v1.1.1。
API | 操作描述 |
---|---|
提交网页审核任务 | 用于提交一个网页审核任务 |
查询网页审核任务结果 | 用于查询指定的网页审核任务 |
提交网页审核任务
功能说明
用于提交一个网页审核任务。
请求示例
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
function postWebpageAuditing() {
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
var url = 'https://' + host + '/webpage/auditing';
var body = COS.util.json2xml({
Request: {
Input: {
Url: 'https://cloud.tencent.com/', // 存在cos里的资源,审核结果异步返回,可以调用查询文本审核结果api查询
},
Conf: {
BizType: '',
DetectType: 'Porn,Ads',
}
}
});
cos.request({
Bucket: config.Bucket,
Region: config.Region,
Method: 'POST',
Url: url,
Key: '/webpage/auditing', /** 固定值,必须 */
ContentType: 'application/xml', /** 固定值,必须 */
Body: body
},
function(err, data){
console.log(err || data);
});
}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
---|---|---|---|---|
Request | 无 | 网页审核的具体配置项。 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
---|---|---|---|---|
Input | Request | 需要审核的网页信息。 | Container | 是 |
Conf | Request | 审核规则配置。 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
---|---|---|---|---|
Url | Request.Input | 网页文件的链接地址,例如 http://www.test.com 。 |
String | 是 |
DataId | Request.Input | 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 | String | 否 |
UserInfo | Request.Input | 用户业务字段。 | Container | 否 |
Container 节点 UserInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
---|---|---|---|---|
TokenId | Request.Input.UserInfo | 用户业务 TokenId,长度不超过128字节。 | String | 否 |
Nickname | Request.Input.UserInfo | 用户业务 Nickname,长度不超过128字节。 | String | 否 |
DeviceId | Request.Input.UserInfo | 用户业务 DeviceId,长度不超过128字节。 | String | 否 |
AppId | Request.Input.UserInfo | 用户业务 AppId,长度不超过128字节。 | String | 否 |
Room | Request.Input.UserInfo | 用户业务 Room,长度不超过128字节。 | String | 否 |
IP | Request.Input.UserInfo | 用户业务 IP,长度不超过128字节。 | String | 否 |
Type | Request.Input.UserInfo | 用户业务 Type,长度不超过128字节。 | String | 否 |
Container 类型 Conf 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
---|---|---|---|---|
DetectType | Request.Conf | 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。 | String | 是 |
Callback | Request.Conf | 回调地址,以 http:// 或者 https:// 开头的地址。 |
String | 否 |
ReturnHighlightHtml | Request.Conf | 指定是否需要高亮展示网页内的违规文本,查询及回调结果时会根据此参数决定是否返回高亮展示的 html 内容。取值为 true 或者 false,默认为 false。 | Boolean | 否 |
返回结果说明
详情请参见 提交网页审核任务。
查询网页审核任务结果
功能说明
用于查询网页审核任务执行情况和结果。
请求示例
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
function getWebpageAuditingResult() {
var jobId = 'shce868019aff611ecb1155254009a4xxx'; // jobId可以通过提交网页审核任务返回
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
var url = 'https://' + host + '/webpage/auditing/' + jobId;
cos.request({
Bucket: config.Bucket,
Region: config.Region,
Method: 'GET',
Key: '/webpage/auditing/' + jobId,
Url: url,
},
function(err, data){
console.log(err || data);
});
}
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
---|---|---|---|
jobId | 需要查询的任务 ID。 | String | 是 |
返回结果说明
详情请参见 查询网页审核任务结果。