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

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeQClawContentSecCheck。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou 。
ServiceId	是	String	服务id,使用哪一套防护策略，就需要传哪一套服务id，模型会检测该服务id下的所有规则示例值：sdfsfs
Content	否	ApiGuardContent	要审核的内容
UserId	否	String	标识用户的id，限速使用，不填，则限速会不生效示例值：sd
SessionId	否	String	会话id 示例值：sdf
ToolName	否	String	工具名称示例值：exec
ToolArgs	否	String	工具执行的参数示例值：rm -rf

3. 输出参数

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

4. 示例

示例1 审核测试用例

高危命令

输入示例

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

{
    "ServiceId": "sdfsfs",
    "Content": {
        "Prompt": "rm -rf / ***"
    },
    "UserId": "sd",
    "SessionId": "sdf"
}

输出示例

{
    "Response": {
        "Data": {
            "Risks": [
                {
                    "RiskType": "tool_call",
                    "RuleId": "gtc-baseline-001",
                    "RuleName": "高危系统命令工具阻断",
                    "Score": 0.99
                }
            ]
        },
        "RequestId": "f4a85fb0-28a8-43f0-a5ac-e0a1232346cb"
    }
}

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.LLMParseFailed	请求body解析失败

Qclaw大模型内容审核接口

本页目录：