1. 接口描述
接口请求域名: tms.tencentcloudapi.com 。
天御文本内容安全定制标签文本审核接口为定制接口,会按照客户定制标签输出审核结果,如需使用请联系商务经理或在线客服咨询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModerateText。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Content | 是 | String | 该字段表示待检测对象的文本内容,文本需要按utf-8格式编码,长度不能超过10000个字符(按unicode编码计算),并进行 Base64加密 |
BizType | 否 | String | 该字段表示策略的具体编号,用于接口调度,在内容安全控制台中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype |
DataId | 否 | String | 该字段表示您为待检测对象分配的数据ID,传入后可方便您对文件进行标识和管理。 取值:由英文字母(大小写均可)、数字及四个特殊符号(_,-,@,#)组成,长度不超过64个字符 |
User | 否 | User | 该字段表示待检测对象对应的用户相关信息,传入后可便于甄别相应违规风险用户 |
Device | 否 | Device | 该字段表示待检测对象对应的设备相关信息,传入后可便于甄别相应违规风险设备 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataId | String | 该字段用于返回检测对象对应请求参数中的DataId,与输入的DataId字段中的内容对应 |
BizType | String | 该字段用于返回请求参数中的BizType参数 |
Suggestion | String | 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Block:建议屏蔽,Review :建议人工复审,Pass:建议通过 |
Label | LabelGrade | 命中标签,可参阅对应数据结构(LabelGrade)的详细描述 |
TcLabelCodes | Array of String | 命中标签对应腾讯侧定义的标签 |
Keywords | Array of String | 该字段用于返回当前标签(Label)下被检测文本命中的关键词信息,用于标注文本违规的具体原因(如:加我微信)。该参数可能会有多个返回值,代表命中的多个关键词;如返回值为空且Score不为空,则代表识别结果所对应的恶意标签(Label)是来自于语义模型判断的返回值 |
ModerationDetails | Array of ModerationDetail | 该字段用于返回文本审核的详细结果,返回值信息可参阅对应数据结构(ModerationDetail)的详细描述 |
Score | Integer | 该字段用于返回审核结果置信度,使用百分制。分数越高表示结果可信度越高。 示例值:90 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 客制标签文本内容审核
用于客户自有标签体系的内容审核,审核结果会以客户定义的标签体系输出结果
输入示例
POST / HTTP/1.1
Host: tms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModerateText
<公共请求参数>
{
"Content": "5Yqg5oiR5aW95Y+LIOe7meS9oOS8mOaDoOWIuA==",
"BizType": "test"
}
输出示例
{
"Response": {
"RequestId": "123",
"DataId": "123",
"BizType": "test",
"Label": {
"Code": "20003001001",
"Grade1": "广告",
"Grade2": "电商广告",
"Grade3": "拍拍网"
},
"TcLabelCodes": [
"20001001001",
"20001001002",
"20001001003"
],
"Suggestion": "Block",
"Keywords": [
"优惠券"
],
"ModerationDetails": [
{
"Label": {
"Code": "20003001001",
"Grade1": "广告",
"Grade2": "电商广告",
"Grade3": "拍拍网"
},
"TcLabelCodes": [
"20001001001",
"20001001002",
"20001001003"
],
"LibResults": [
{
"Keyword": "123",
"Positions": [
{
"Start": 1,
"End": 3
}
],
"LibId": "",
"LibName": "",
"LibType": 0
}
],
"ModelResults": [
{
"Content": "123",
"Positions": [
{
"Start": 1,
"End": 3
}
]
}
],
"Suggestion": "Block",
"Score": 80
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。