CheckLLMPrompt - 大模型提示词合规判别--Web应用防火墙-火山引擎

文档中心

立即注册

导航

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

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

调用 CheckLLMPrompt 接口可以判别输入的提示词是否合规。大模型应用防火墙会检测并分析提示词内容，根据设定的防护策略采取不同的执行动作。

请求说明

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

前提条件

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
Content	String	是	hello	提示词内容。当`ContentType`为`1`时，`Content`为内容字符串。当`ContentType`为`2`或`3`时，`Content`为资源 url。
ContentType	Integer	是	1	内容类型。 1：文本 2：音频 3：图片
MsgClass	Integer	否	0	自定义场景类型，取值范围 0～99。
Host	String	是	example.com	接入点域名。该域名由 SDK 方式接入时，大模型安全防火墙自动生成，获取方式可参考通过 SDK 接入。
Region	String	是	cn-beijing	大模型应用防火墙所在地域，参考 Region 列表。

返回参数

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

参数	类型	示例值	描述
MsgID	String	19de789baf324b4480e25c9616aa**** \| --- \| --- \|	消息唯一标识符。
Decision	Object	--	大模型判别结果。

请求示例

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

{
  "Content": "你好",
  "ContentType": "1",
  "Host": "example.com",
  "Region": "cn-beijing"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240626153935068167155004D0****",
    "Action": "CheckLLMPrompt",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "MsgID": "2a477be8839445e5834ae92362b0****",
    "Decision": {
      "Action": 9,
      "CustomMatches": [],
      "ErrCode": 0,
      "ErrMsg": "pass",
      "Labels": [],
      "matches": []
    }
  }
}

错误码

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