1. 接口描述
接口请求域名: tms.tencentcloudapi.com 。
本接口(Text Moderation)用于提交文本内容进行智能审核任务。使用前请您使用腾讯云主账号登录控制台 开通文本内容安全服务 并调整好对应的业务配置。
接口使用说明
- 前往“内容安全控制台-文本内容安全”开启使用文本内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含3000条文本识别额度,有效期为15天。
- 该接口为收费接口,计费方式敬请参见 腾讯云文本内容安全定价。
接口功能说明:
- 支持对文本文件进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规文本内容;
- 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景;
- 支持根据不同的业务场景配置自定义的审核策略,可在控制台文本内容安全-策略管理中配置;
- 支持用户自定义配置词库黑白名单,打击自定义识别类型的违规文本(目前仅支持黑名单配置);
- 支持在审核文本内容时同时关联账号或设备信息,可识别违规风险账号或设备。
接口调用说明:
- 文本内容大小支持:文本原文长度不能超过unicode编码长度10000个字符;
- 文本审核语言支持:目前支持中文、英文、阿拉伯数字的检测;
- 默认接口请求频率限制:1000次/秒,超过该频率限制则接口会报错。
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:TextModeration。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Content | 是 | String | 该字段表示待检测对象的文本内容,文本需要按utf-8格式编码,长度不能超过10000个字符(按unicode编码计算),并进行 Base64加密 示例值:5L2g5aW9 |
BizType | 否 | String | 该字段表示策略的具体编号,用于接口调度,在内容安全控制台中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。 备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype 示例值:182600012300002017 |
DataId | 否 | String | 该字段表示您为待检测对象分配的数据ID,传入后可方便您对文件进行标识和管理。 取值:由英文字母(大小写均可)、数字及四个特殊符号(_,-,@,#)组成,长度不超过64个字符 示例值:a61237dd-c2a0-43e7-a3da-d27022d39ba7 |
User | 否 | User | 该字段表示待检测对象对应的用户相关信息,传入后可便于甄别相应违规风险用户 |
Device | 否 | Device | 该字段表示待检测对象对应的设备相关信息,传入后可便于甄别相应违规风险设备 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BizType | String | 该字段用于返回请求参数中的BizType参数 示例值:182600012300002017 |
Label | String | 该字段用于返回检测结果(DetailResults)中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Abuse:谩骂,Ad:广告;以及其他令人反感、不安全或不适宜的内容类型 示例值:Ad |
Suggestion | String | 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Block:建议屏蔽,Review :建议人工复审,Pass:建议通过 示例值:Block |
Keywords | Array of String | 该字段用于返回当前标签(Label)下被检测文本命中的关键词信息,用于标注文本违规的具体原因(如:加我微信)。该参数可能会有多个返回值,代表命中的多个关键词;如返回值为空且Score不为空,则代表识别结果所对应的恶意标签(Label)是来自于语义模型判断的返回值 注意:此字段可能返回 null,表示取不到有效值。 |
Score | Integer | 该字段用于返回当前标签(Label)下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表文本越有可能属于当前返回的标签;如:色情 99,则表明该文本非常有可能属于色情内容;色情 0,则表明该文本不属于色情内容 示例值:99 |
DetailResults | Array of DetailResults | 该字段用于返回基于文本风险库审核的详细结果,返回值信息可参阅对应数据结构(DetailResults)的详细描述 注意:此字段可能返回 null,表示取不到有效值。 |
RiskDetails | Array of RiskDetails | 该字段用于返回文本检测中存在违规风险的账号检测结果,主要包括违规风险类别和风险等级信息,具体内容可参阅对应数据结构(RiskDetails)的详细描述 注意:此字段可能返回 null,表示取不到有效值。 |
Extra | String | 该字段用于返回根据您的需求配置的额外附加信息(Extra),如未配置则默认返回值为空。 备注:不同客户或Biztype下返回信息不同,如需配置该字段请提交工单咨询或联系售后专员处理 注意:此字段可能返回 null,表示取不到有效值。 |
DataId | String | 该字段用于返回检测对象对应请求参数中的DataId,与输入的DataId字段中的内容对应 注意:此字段可能返回 null,表示取不到有效值。 示例值:a61237dd-c2a0-43e7-a3da-d27022d39ba7 |
SubLabel | String | 该字段用于返回当前标签(Label)下的二级标签。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Contact |
ContextText | String | 该字段用于返回上下文关联文本 注意:此字段可能返回 null,表示取不到有效值。 |
SentimentAnalysis | SentimentAnalysis | 情感分析结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 文本内容安全
输入示例
POST / HTTP/1.1
Host: tms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TextModeration
<公共请求参数>
{
"Content": "5Yqg5oiR5aW95Y+LIOe7meS9oOS8mOaDoOWIuA==",
"BizType": "test"
}
输出示例
{
"Response": {
"RequestId": "123",
"BizType": "test",
"Label": "Ad",
"SubLabel": "",
"Suggestion": "Block",
"Keywords": [
"优惠券"
],
"Score": 100,
"DataId": "CSFb_MJRV5piaczW",
"DetailResults": [
{
"Label": "Polity",
"SubLabel": "",
"Suggestion": "Pass",
"Keywords": [],
"Score": 0,
"LibType": 0,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": []
},
{
"Label": "Ad",
"SubLabel": "",
"Suggestion": "Block",
"Keywords": [
"优惠券"
],
"Score": 100,
"LibType": 2,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": [
{
"Type": "Keyword",
"Keyword": "优惠券",
"LibName": "default_1_0_1256309736_100004528167",
"Positions": [
{
"Start": 7,
"End": 10
}
]
}
]
},
{
"Label": "Abuse",
"SubLabel": "",
"Suggestion": "Pass",
"Keywords": [],
"Score": 0,
"LibType": 0,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": []
},
{
"Label": "Illegal",
"SubLabel": "",
"Suggestion": "Pass",
"Keywords": [],
"Score": 0,
"LibType": 0,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": []
},
{
"Label": "Terror",
"SubLabel": "",
"Suggestion": "Pass",
"Keywords": [],
"Score": 0,
"LibType": 0,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": []
},
{
"Label": "Porn",
"SubLabel": "",
"Suggestion": "Pass",
"Keywords": [],
"Score": 2,
"LibType": 0,
"LibId": "",
"LibName": "",
"Tags": null,
"HitInfos": []
}
],
"RiskDetails": null,
"Extra": "",
"ContextText": "",
"SentimentAnalysis": {}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ErrTextTimeOut | 请求超时。 |
InvalidParameter.ErrAction | 错误的action。 |
InvalidParameter.ErrTextContentLen | 请求的文本长度过长。 |
InvalidParameter.ErrTextContentType | 文本类型错误,需要base64的文本。 |
InvalidParameter.ParameterError | InvalidParameter.ParameterError |
InvalidParameterValue.ErrFileContent | FileContent不可用,传入的Base64编码无法转换成标准utf8内容。 |
InvalidParameterValue.ErrTextContentLen | 请求的文本长度超过限制。 |
InvalidParameterValue.ErrTextContentType | 请求的文本格式错误(需要base64编码格式的文本)。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |