文本审核

最近更新时间:2023-09-26 19:41:23

我的收藏

简介

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

文本审核

功能说明

本接口可用于进行文本内容的直接审核,请求方式为同步请求,可直接通过接口返回结果获取文本内容审核结果。也可用于提交一个文本文件审核任务,请求方式为异步请求,可以通过查询文本审核任务接口查询文本文件审核结果

方法原型

def ci_auditing_text_submit(self, Bucket, Key=None, DetectType=None, Content=None,
Callback=None, BizType=None, Url=None, UserInfo=None, DataId=None, **kwargs):

请求示例一:文本内容审核

def ci_auditing_text_submit():
# 用户自定义业务字段
user_info = {
'TokenId': '123456', # 一般用于表示账号信息,长度不超过128字节
'Nickname': '测试', # 一般用于表示昵称信息,长度不超过128字节
'DeviceId': '腾讯云', # 一般用于表示设备信息,长度不超过128字节
'AppId': '12500000', # 一般用于表示 App 的唯一标识,长度不超过128字节
'Room': '1', # 一般用于表示房间号信息,长度不超过128字节
'IP': '127.0.0.1', # 一般用于表示 IP 地址信息,长度不超过128字节
'Type': '测试', # 一般用于表示业务类型,长度不超过128字节
'ReceiveTokenId': '789123', # 一般用于表示接收消息的用户账号,长度不超过128字节
'Gender': '男', # 一般用于表示性别信息,长度不超过128字节
'Level': '100', # 一般用于表示等级信息,长度不超过128字节
'Role': '测试人员', # 一般用于表示角色信息,长度不超过128字节
}
response = client.ci_auditing_text_submit(
Bucket=bucket_name, # 桶名称
Content='123456test'.encode("utf-8"), # 需要审核的文本内容
BizType='', # 表示审核策略的唯一标识
UserInfo=user_info, # 用户自定义业务字段
DataId='456456456', # 待审核的数据进行唯一业务标识
)
print(response)

请求示例二:提交文本文件审核任务

def ci_auditing_text_submit():
# 用户自定义业务字段
user_info = {
'TokenId': '123456', # 一般用于表示账号信息,长度不超过128字节
'Nickname': '测试', # 一般用于表示昵称信息,长度不超过128字节
'DeviceId': '腾讯云', # 一般用于表示设备信息,长度不超过128字节
'AppId': '12500000', # 一般用于表示 App 的唯一标识,长度不超过128字节
'Room': '1', # 一般用于表示房间号信息,长度不超过128字节
'IP': '127.0.0.1', # 一般用于表示 IP 地址信息,长度不超过128字节
'Type': '测试', # 一般用于表示业务类型,长度不超过128字节
'ReceiveTokenId': '789123', # 一般用于表示接收消息的用户账号,长度不超过128字节
'Gender': '男', # 一般用于表示性别信息,长度不超过128字节
'Level': '100', # 一般用于表示等级信息,长度不超过128字节
'Role': '测试人员', # 一般用于表示角色信息,长度不超过128字节
}
# 对cos文本文件进行审核
response = client.ci_auditing_text_submit(
Bucket=bucket_name, # 桶名称
Key='shenhe1.txt', # 对象文件名
BizType='', # 表示审核策略的唯一标识
UserInfo=user_info, # 用户自定义业务字段
DataId='456456456', # 待审核的数据进行唯一业务标识
)
print(response)
# 对url进行审核
response = client.ci_auditing_text_submit(
Bucket=bucket_name, # 桶名称
Url='https://www.test.com/test.txt', # 文本文件的完整链接
BizType='', # 表示审核策略的唯一标识
UserInfo=user_info, # 用户自定义业务字段
DataId='456456456', # 待审核的数据进行唯一业务标识
)
print(response)

参数说明

调用 ci_auditing_text_submit 函数,具体请求参数如下:
注意:
不可同时输入 Key/Url 和 Content。
当选择 Key、Url 时,审核结果为异步返回,且当两者都传入时,仅会对Url传入内容进行处理。可通过 查询文本审核任务结果 API 接口获取返回结果。
当选择 Content 时,审核结果为同步返回,可通过 响应体 查看审核结果。
目前仅支持中文、英文、阿拉伯数字的检测与审核。
参数名称
描述
类型
是否必选
Bucket
存储桶名称。
String
Key
对象文件名,例如 picture.jpg。
String
Url
文本文件的完整链接,例如:https://www.test.com/test.txt
String
BizType
表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等,配置指引: 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时,将自动使用默认的审核策略。
String
Content
当传入的内容为纯文本信息,原文长度不能超过10000个 utf8 编码字符。若超出长度限制,接口将会报错。
String
Callback
用户自定义回调地址,以 http:// 或者 https:// 开头的地址。
String
CallbackVersion
回调内容的结构,有效值:Simple(回调内容包含基本信息)、Detail(回调内容包含详细信息)。默认为 Simple。
String
CallbackType
回调片段类型,有效值:1(回调全部文本片段)、2(回调违规文本片段)。默认为 1。
Int
UserInfo
用户自定义业务字段。可传入的参数请参考 提交文本审核任务 的 UserInfo 字段。
Dict
DataId
该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
String
Freeze
可通过该字段,设置根据审核结果给出的不同分值,对文本文件进行自动冻结,仅当 input 中审核的文本为 object 时有效。可传入的参数请参考 提交文本审核任务 的 Freeze 字段。
Dict

返回参数说明

调用 ci_auditing_text_submit 函数,会把 api 里面的 xml 返回转换成 dict,具体返回参数说明:当进行文本内容审核时,参见 文本内容审核响应体;当进行文本文件审核时,参见文本文件审核响应体

查询文本文件审核任务结果

功能说明

本接口用于主动查询指定的文本文件审核任务结果。文本文件审核功能为异步任务方式,您可以通过提交文本文件审核任务来审核您的文本文件,然后通过查询文本文件审核任务接口查询审核结果。

示例代码

def ci_auditing_text_query():
response = client.ci_auditing_text_query(
Bucket=bucket_name, # 桶名称
JobID='st6a7d90fe311711eeaxxxxxxxx', # 需要查询的文本文件审核任务ID
)
print(response)

参数说明

调用 ci_auditing_text_query 函数,具体请求参数如下:
参数名称
描述
类型
是否必选
Bucket
存储桶名称。
String
JobID
任务 ID。
String

返回参数说明

调用 ci_auditing_text_query 函数,会把 api 里面的 xml 返回转换成 dict,具体返回参数可参见 查询文本审核任务结果 文档。