Web 应用防火墙大模型内容审核接口

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

大模型请求内容和响应内容审核接口

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLLMContentSecCheck。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-nanjing, ap-shanghai 。
ServiceId	是	String	服务id,使用哪一套防护策略，就需要传哪一套服务id，模型会检测该服务id下的所有规则示例值：9000002887
Content	是	String	要审核的内容示例值：***
Type	是	Integer	流量类型，是入向流量还是出向流量，入向：1，出向：2；入向和出向必填示例值：1
InstanceId	是	String	实例id，必传示例值：waf_2l15cfe009ya8lg3
ChatId	否	String	对话的id 示例值：test-request-001
UserId	否	String	标识用户的id，限速使用，不填，则限速会不生效示例值：700002174132
TokenUsage	否	Integer	token使用量，不填，会采用默认的token计算方法，计算的是模型的消耗，因为该值时在出向方向上添加，即Type=2 示例值：10000

3. 输出参数

参数名称	类型	描述
Data	LLMDetectResult	检测结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 测试用例

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLLMContentSecCheck
<公共请求参数>

{
    "ServiceId": "9000002887",
    "Content": "***",
    "Type": 1,
    "InstanceId": "waf_2l15cfe009ya8lg3",
    "UserId": "700002174132",
    "TokenUsage": 10000
}

输出示例

{
    "Response": {
        "Data": {
            "Action": "deny",
            "KeyWordsResult": [
                {
                    "Id": "politics_high",
                    "Name": "涉政-高敏感"
                }
            ],
            "Payload": "风险类型:内置关键词库-涉政-高敏感,风险内容:胡海峰",
            "RuleId": "5100000000",
            "RuleName": "关键词库检测"
        },
        "RequestId": "badc7789-41d7-44b9-84e3-38efd8d833d8"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.LLMContentEmpty	Content为空
InvalidParameter.LLMInternalError	内部服务错误
InvalidParameter.LLMInvalidType	Type非法
InvalidParameter.LLMNoRules	大模型调用过程中，serviceid没有配置规则
InvalidParameter.LLMParseFailed	请求body解析失败
InvalidParameter.LLMRequestIdEmpty	RequestId为空
InvalidParameter.LLMServiceIdEmpty	ServiceId为空
InvalidParameter.LLMSwitchOff	大模型服务未开启开关

大模型内容审核接口

本页目录：