Web 应用防火墙大模型安全流式代答接口

1. 接口描述

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

大模型安全代答生成接口。当用户输入命中内容安全风险检测规则时，调用本接口由大模型实时生成安全合规的替代回答。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GenerateLLMSecAnswer。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-nanjing, ap-shanghai 。
Message	是	SSEClientMessage	消息结构体内容
MsgID	是	String	消息id，传入要回答的MsgID ，用于匹配自定义回答模板，最终可得到优化的代答结果示例值：test-001

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。

4. 示例

示例1 流式响应测试用例

输入示例

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

{
    "Message": {
        "Role": "user",
        "Content": "你能干些什么",
        "ContentType": 1
    },
    "MsgID": "test-001"
}

输出示例

流式响应输出格式：
data: {"index":1,"success":true,"data":"您好"}

data: {"index":2,"success":true,"data":"！"}

data: {"index":3,"success":true,"data":"我"}

data: {"index":4,"success":true,"data":"是一款"}

data: {"index":5,"success":true,"data":"人工智能"}

data: {"index":6,"success":true,"data":"助手"}

data: {"index":7,"success":true,"data":"，"}

data: {"index":8,"success":true,"data":"名为"}

data: {"index":9,"success":true,"data":"腾讯"}

data: {"index":10,"success":true,"data":"元宝"}

data: {"index":11,"success":true,"data":"。"}

data: {"index":12,"success":true,"data":"我可以"}

data: {"index":13,"success":true,"data":"回答"}

data: {"index":14,"success":true,"data":"您"}

data: {"index":15,"success":true,"data":"的问题"}

data: {"index":16,"success":true,"data":"、"}

data: {"index":17,"success":true,"data":"提供"}

data: {"index":18,"success":true,"data":"信息"}

data: {"index":19,"success":true,"data":"和建议"}

data: {"index":20,"success":true,"data":"，"}

data: {"index":21,"success":true,"data":"甚至"}

data: {"index":22,"success":true,"data":"进行"}

data: {"index":23,"success":true,"data":"简单的"}

data: {"index":24,"success":true,"data":"对话"}

data: {"index":25,"success":true,"data":"。"}

data: {"index":26,"success":true,"data":"我的"}

data: {"index":27,"success":true,"data":"目的是"}

data: {"index":28,"success":true,"data":"为您提供"}

data: {"index":29,"success":true,"data":"帮助"}

data: {"index":30,"success":true,"data":"和支持"}

data: {"index":31,"success":true,"data":"。"}

data: {"index":32,"success":true,"data":"有什么"}

data: {"index":33,"success":true,"data":"可以"}

data: {"index":34,"success":true,"data":"帮"}

data: {"index":35,"success":true,"data":"您的"}

data: {"index":36,"success":true,"data":"吗"}

data: {"index":37,"success":true,"data":"？"}

data: {"index":38,"success":true,"end":true}

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 CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

大模型安全流式代答接口

本页目录：