You need to enable JavaScript to run this app.
导航
大模型应用防火墙
  • 文档首页
    • /大模型应用防火墙/API 参考/CheckLLMPrompt - 判别大模型提示词是否合规
CheckLLMPrompt - 判别大模型提示词是否合规
最近更新时间：2025.04.07 16:19:40首次发布时间：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为1时，Content为内容字符串。
  • 当ContentType为2或3时，Content为资源 url。

ContentType

Integer

是

1

内容类型。

  • 1：文本
  • 2：音频
  • 3：图片

MsgClass

Integer

否

0

自定义场景类型，取值范围 0～99。

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：观察
  • 1：拦截
  • 8：答案优化
  • 9：放行

CustomMatches

Array of CheckLLMCustomMatch Object

--

自定义词库命中结果。

ErrCode

Integer

0

判别结果码：

  • 0：通过
  • -4005：拦截

ErrMsg

String

pass

判别结果文本：

  • pass：通过，对应判别结果码0。
  • 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：弱语义攻击
  • 隐私数据识别：
    • 40100：身份证号
    • 40200：护照号
    • 40300：往来港澳通行证号
    • 40400：银行卡号
    • 40500：电子邮箱
    • 40600：移动电话号码
    • 40700：地址

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：弱语义攻击
  • 隐私数据识别：
    • 40100：身份证号
    • 40200：护照号
    • 40300：往来港澳通行证号
    • 40400：银行卡号
    • 40500：电子邮箱
    • 40600：移动电话号码
    • 40700：地址

word

String

毒品

敏感词内容。

请求示例

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