文本审核

最近更新时间:2024-08-02 15:39:01

我的收藏

简介

内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
说明:
使用内容审核服务需拥有数据万象使用权限:
主账号请 单击此处 进行角色授权。
子账号请参见 授权子账号接入数据万象服务 文档。
本文档提供关于文本审核的 API 概览和 SDK 示例代码。
注意:
COS Node.js SDK 版本需要大于等于 v2.11.2。
API
操作描述
用于进行一次文本内容审核
用于提交一个文本文件审核任务
用于查询指定的文本审核任务

文本内容审核

功能说明

用于进行一次文本内容审核,会同步返回审核结果。

请求示例

// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/8629
function postTextContentAuditing() {
const config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', // 存储桶,必须
Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须
};
const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
const key = 'text/auditing'; // 固定值,必须
const url = `https://${host}/${key}`;
const body = COS.util.json2xml({
Request: {
Input: {
// 使用 COS.util.encodeBase64 方法需要sdk版本至少为1.4.19
Content: COS.util.encodeBase64('hello'), /* 需要审核的文本内容 */
},
Conf: {
BizType: '',
}
}
});
cos.request({
Method: 'POST', // 固定值,必须
Url: url, // 请求的url,必须
Key: key, // 固定值,必须
ContentType: 'application/xml', // 固定值,必须
Body: body // 请求体参数,必须
},
function(err, data){
if (err) {
// 处理请求失败
console.log(err);
} else {
// 处理请求成功
console.log(data.Response);
}
});
}
postTextContentAuditing();

参数说明

cos.request 方法参数说明:
参数名称
描述
类型
是否必选
Method
请求方法,固定值
String
Url
请求 url,固定值
String
Key
固定值
String
ContentType
固定值
String
Body
请求体详情请参见 文本内容审核
Container

回调函数说明

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

相关链接

提交文本文件审核任务

功能说明

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

请求示例

// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/8629
function postTextAuditing() {
const config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', // 存储桶,必须
Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须
};
const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
const key = 'text/auditing'; // 固定值,必须
const url = `https://${host}/${key}`;
const body = COS.util.json2xml({
Request: {
Input: {
// Url与Object二选一传入
Object: 'test.txt', // 文件存储在cos的路径,支持传入中文,比如:中文.txt
// Url: `www.test.com/${encodeURIComponent('中文.txt')}`, // 文本文件url 注意中文路径需要encode
},
Conf: {
BizType: '',
}
}
});
cos.request({
Method: 'POST', // 固定值,必须
Url: url, // 请求的url,必须
Key: key, // 固定值,必须
ContentType: 'application/xml', // 固定值,必须
Body: body // 请求体参数,必须
},
function(err, data){
if (err) {
// 处理请求失败
console.log(err);
} else {
// 处理请求成功
console.log(data.Response);
}
});
}
postTextAuditing();

参数说明

cos.request 方法参数说明:
参数名称
描述
类型
是否必选
Method
请求方法,固定值
String
Url
请求 url,固定值
String
Key
固定值
String
ContentType
固定值
String
Body
请求体详情请参见 文本文件审核
Container

回调函数说明

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

相关链接

查询文本审核任务

功能说明

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

请求示例

// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/8629
function getTextAuditingResult() {
const config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', // 存储桶,必须
Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须
};
const jobId = 'st8d88c664aff511ecb23352540078cxxx'; // jobId 可以通过提交文本审核任务返回(Input传入Object)
const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
const key = `text/auditing/${jobId}`; // 固定值,必须
const url = `https://${host}/${key}`; + jobId;
cos.request({
Method: 'GET', // 固定值,必须
Url: url, // 请求的url,必须
Key: key, // 固定值,必须
},
function(err, data){
if (err) {
// 处理请求失败
console.log(err);
} else {
// 处理请求成功
console.log(data.Response);
}
});
}
getTextAuditingResult();

参数说明

cos.request 方法参数说明:
参数名称
描述
类型
是否必选
Method
请求方法,固定值
String
Url
请求 url,固定值
String
Key
固定值:text/auditing/要查询的jobId
String
参数名称
描述
类型
是否必选
jobId
需要查询的任务 ID
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

相关链接