CheckLLMPrompt - 检查用户提示词是否合规--大模型应用防火墙-火山引擎

文档中心

立即注册

导航

CheckLLMPrompt - 检查用户提示词是否合规

最近更新时间：2025.09.16 23:14:46首次发布时间：2025.03.28 19:07:12

调用 CheckLLMPrompt 接口可以判别用户输入的提示词是否合规。大模型应用防火墙会检测并分析提示词内容，根据设定的防护策略返回命中结果和执行动作。

前提条件

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

请求说明

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

请求参数

参数	类型	是否必填	示例值	描述
Action	String	是	CheckLLMPrompt	要执行的操作，取值：CheckLLMPrompt。
Version	String	是	2023-12-25	API 的版本，取值：2023-12-25。
Content	String	是	你好	送检的提示词内容，内容类型为文本。
ContentType	Integer	是	1	内容类型。当前版本仅支持检测文本内容，输入 1 即可。
MsgClass	Integer	否	0	场景类型，当前默认为标准类型，填入 0 即可。
Host	String	是	fd****.access.omni-shield.volces.com	接入点域名。该域名由 SDK 方式接入时，大模型安全防火墙自动生成，获取方式可参考通过 SDK 接入。
Region	String	是	cn-beijing	大模型应用防火墙所在地域，参考Region 列表。

响应参数

参数	类型	示例值	描述
MsgID	String	19de789baf324b4480e25c9616aa****	消息唯一标识符，可用于查询消息代答结果。
Decision	Object of Decision	--	大模型判别结果。

Decision

参数	类型	示例值	描述
Action	Integer	1	执行动作： `-1`：任何策略都未命中，对应判别结果码`0`。 `0`：观察，对应判别结果码`-4004`。 `1`：拦截，对应判别结果码`-4005`。 `8`：答案优化，对应判别结果码`-4005`。 `9`：命中了正向词库规则，内容被放行，对应判别结果码`0`。
CustomMatches	Array of CheckLLMCustomMatch Object	--	命中的自定义词库内容，若未命中则为空。
ErrCode	Integer	0	判别结果码： `0`：通过，请求将被放行。 `-4004`：观察，请求将被放行，但您可以在攻击详情中查看规则命中信息，包括被攻击域名、命中规则、攻击类型、发生时间等。 `-4005`：拦截，请求将被阻止，您可以在攻击详情中查看规则命中信息，包括被攻击域名、命中规则、攻击类型、发生时间等。
ErrMsg	String	pass	判别结果文本： `pass`：通过，对应判别结果码`0`。 `observe`：观察，对应判别结果码`-4004`。 `block`：拦截，对应判别结果码`-4005`。
`Labels`	Array of Strings	10100	命中的检测分类标签信息。对应不同防护策略类型下的检测分类标签，可用于进一步区分和处理不同类型的违规提示词。如果命中多个标签则返回多个值。模型滥用防护策略： 10100：涉敏 1 10200：侮辱&歧视 10300：色情 10400：涉敏2 10500：商业违法违规 10600：欺诈 10700：赌博 10800：毒品提示词攻击防护策略： 20100：指令劫持 20200：角色扮演 20300：反向诱导 20400：进入开发者模式 20500：越狱攻击 20600：对抗后缀攻击 20700：随机噪声攻击 20800：弱语义攻击算力消耗攻击防护策略： 30101 敏感数据防护策略： 40100：身份证号 40200：护照号 40300：往来港澳通行证号 40400：银行卡号 40500：电子邮箱 40600：移动电话号码 40700：固定电话号码 40800：地址通用话题控制策略： 50200
Matches	Array of CheckLLMMatch Object	--	命中的敏感词及每个敏感词对应的检测分类标签。当且仅当命中预置词库或自定义词库时返回对应内容。如果未命中词库，但被判别模型判定为敏感信息，则该参数为空。

CheckLLMCustomMatch

参数	类型	示例值	描述
Word	String	恶意	命中的自定义词库内容。

CheckLLMMatch

参数	类型	示例值	描述
Label	String	40100	该敏感词内容对应的检测分类标签：模型滥用防护策略： 10100：涉敏 1 10200：侮辱&歧视 10300：色情 10400：涉敏2 10500：商业违法违规 10600：欺诈 10700：赌博 10800：毒品提示词攻击防护策略： 20100：指令劫持 20200：角色扮演 20300：反向诱导 20400：进入开发者模式 20500：越狱攻击 20600：对抗后缀攻击 20700：随机噪声攻击 20800：弱语义攻击算力消耗攻击防护策略： 30101 敏感数据防护策略： 40100：身份证号 40200：护照号 40300：往来港澳通行证号 40400：银行卡号 40500：电子邮箱 40600：移动电话号码 40700：固定电话号码 40800：地址通用话题控制策略： 50200
Word	String	毒品	敏感词内容。

参数

类型

示例值

描述

Label

String

40100

该敏感词内容对应的检测分类标签：

模型滥用防护策略：
- 10100：涉敏 1
- 10200：侮辱&歧视
- 10300：色情
- 10400：涉敏2
- 10500：商业违法违规
- 10600：欺诈
- 10700：赌博
- 10800：毒品
提示词攻击防护策略：
- 20100：指令劫持
- 20200：角色扮演
- 20300：反向诱导
- 20400：进入开发者模式
- 20500：越狱攻击
- 20600：对抗后缀攻击
- 20700：随机噪声攻击
- 20800：弱语义攻击
算力消耗攻击防护策略：
- 30101
敏感数据防护策略：
- 40100：身份证号
- 40200：护照号
- 40300：往来港澳通行证号
- 40400：银行卡号
- 40500：电子邮箱
- 40600：移动电话号码
- 40700：固定电话号码
- 40800：地址
通用话题控制策略：
- 50200

Word

String

毒品

敏感词内容。

请求示例

通过（pass）

拦截（block)

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": "fd****.access.omni-shield.volces.com",
  "Region": "cn-beijing"
}

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": "fd****.access.omni-shield.volces.com",
  "Region": "cn-beijing"
}

返回示例

通过（pass）

拦截（block)

{
  "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": []
    }
  }
}

{
  "ResponseMetadata": {
    "RequestId": "20240626153935068167155004D0****",
    "Action": "CheckLLMPrompt",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "MsgID": "deda07897703474196e497e98ac4****",
    "Decision": {
      "Action": 8,
      "CustomMatches": [
        {
          "word": "恶意"
        }
      ],
      "ErrCode": -4005,
      "ErrMsg": "block",
      "Labels": [
        "20100",
        "20200",
        "20300"
      ],
      "Matches": []
    }
  }
}