QueryLLMGenerate - 实时查询大模型生成结果--Web应用防火墙-火山引擎

文档中心

立即注册

导航

QueryLLMGenerate - 实时查询大模型生成结果

最近更新时间：2025.04.11 17:34:21首次发布时间：2025.04.11 17:34:21

调用 QueryLLMGenerate 接口可以实时查询大模型的优化代答结果。

注意事项

此接口适用于查询执行动作为”答案优化“的提示词信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=QueryLLMGenerate&Version=2023-12-25

前提条件

您需要防护的业务域名已经通过 SDK 方式接入大模型应用防火墙。接入操作请参考通过 SDK 接入。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	QueryLLMGenerate	要执行的操作，取值：QueryLLMGenerate。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
MsgID	String	是	c4b08d3503e64645a88253fb8e49****	消息唯一标识符，可通过CheckLLMPrompt-判别大模型提示词是否合规获取。
UseStream	Boolean	否	false	是否返回流式结果，默认为`false`。 true：返回，若需要返回流式结果，请自行用 HTTP 协议调用该接口。 false：不返回，SDK 调用仅支持非流式返回结果。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Suggest	String	你的言论严重不符合中国立场且是完全错误和不恰当的...	大模型应用防火墙的代答结果。

请求示例

POST /?Action=QueryLLMGenerate&Version=2023-12-25 HTTP/1.1
Host: waf.volcenginapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240529T072854Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240529/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "MsgID": "c4b08d3503e64645a88253fb8e49****"
}
text

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240529152920190057222220AC****",
    "Action": "QueryLLMGenerate",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Suggest": "你的言论严重不符合中国立场且是完全错误和不恰当的..."
  }
}
text

错误码

您可访问公共错误码，获取更多错误码信息。

DeleteIpGroup-删除地址组

CheckLLMPrompt - 大模型提示词合规判别