大模型应用防火墙
大模型应用防火墙
- 文档首页
大模型应用防火墙SDK 参考幻觉内容检测
复制全文
下载 pdf幻觉内容检测
文档反馈
问问助手您可以基于大模型应用防火墙 SDK 调用接口对文本内容进行幻觉检测，以识别大模型回答是否存在缺少依据或与指定信息不一致。
本文提供 Python、Java、Go、PHP 示例，示例中构造了一个存在事实冲突的演示场景：
- 用户问题：火星有几颗天然卫星？
- 参考资料：火星有两颗天然卫星。
- 模型回答：火星有三颗卫星。
工作原理
幻觉检测请求包含以下三类内容：
内容 | 请求位置 | role | 作用 |
内容 | 请求位置 | role | 作用 |
模型回答 | message | assistant | 需要检测的内容 |
用户问题 | history | user | 说明模型回答所对应的问题 |
参考资料 | history | tool | 作为判断回答是否有依据、是否与资料一致的基准 |
对于参考资料，还需要设置 tool_call_id，用于标识该内容来自工具调用或 RAG 检索结果。
注意
幻觉检测判断的是模型回答与本次请求中所提供参考资料之间的一致性。参考资料不完整、不准确或与用户问题无关时，检测结果也可能受到影响。
前提条件
- 购买幻觉检测扩展服务。
- 在幻觉检测模块中创建规则，并确认规则已启用，详情参见配置幻觉内容防护策略。
- 参考SDK 安装和初始化完成依赖安装和初始化配置。
SDK 版本
语言 | 最低版本 | 源代码 |
语言 | 最低版本 | 源代码 |
Python | 5.0.29 | |
Java | 2.0.7 | |
Go | 1.2.30 | |
PHP | 1.0.114 |
调用接口
无代理服务
Python
Go
Java
PHP
from volcenginesdkllmshield import *
def main():
# ------------------------------------------------------------------
# 1. 连接参数（以下为示例占位符，请替换为自己的真实值）
# ------------------------------------------------------------------
appid = "YOUR_APPID" # 资产 ID，在控制台新建后获取
myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" # 根据大模型应用防火墙实例所在地域替换相应的地域信息
region = "cn-beijing" # 大模型应用防火墙实例所在地域
TIMEOUT = 50 # 超时时间（秒）
# 火山引擎账号 Access Key / Secret Key（请勿提交到公开仓库）
ak = "YOUR_AK"
sk = "YOUR_SK"
# ------------------------------------------------------------------
# 2. 构造请求
# message: 待检测的「模型输出回答」（role 固定为 assistant）
# history: 上下文，必须包含：
# - user : 用户原始问题
# - tool : RAG 返回的真实参考资料（幻觉判定的对照基准）
# ------------------------------------------------------------------
try:
client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
request = ModerateV2Request(
scene=appid,
message=MessageV2(
role="assistant",
content="根据参考资料，火星有三颗卫星",
content_type=1,
),
history=[
MessageV2(
role="user",
content="根据参考资料，火星有几颗天然卫星？",
),
MessageV2(
role="tool",
tool_call_id="rag",
content_type=1,
content="火星有两颗天然卫星，分别是福波斯和戴摩斯",
),
],
)
# ------------------------------------------------------------------
# 3. 发起审核并打印结果
# ------------------------------------------------------------------
response = client.Moderate(request)
print("=== 请求报文 ===")
print(request.model_dump_json(by_alias=True, indent=2))
print("\n=== 审核结果 ===")
print(response.model_dump_json(by_alias=True, indent=2))
except Exception as e:
print(f"请求失败: {e}")
if __name__ == "__main__":
main()
package main
import (
"fmt"
"time"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
)
func main() {
var response *llmshield.ModerateV2Response
var err error
myUrl := "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" // 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak := "YOUR AK" // 火山账号的 AK
sk := "YOUR SK" // 火山账号的 SK
appid := "YOUR APPID" // 资产的 AppId，可在控制台获取
region := "cn-beijing" // 大模型应用防火墙实例所在地域
timeout := time.Second * 60 // 超时时间
client := llmshield.New(myUrl, ak, sk, region, timeout) // 创建客户端实例
request := llmshield.ModerateV2Request{
Message: nil,
Scene: appid, // 资产的 AppId
}
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
request.Message = &llmshield.MessageV2{
Content: "根据参考资料，火星有三颗卫星",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "assistant", // 检测的内容来源，该场景下固定为 assistant-模型响应内容
}
// 设置上下文：用户原始问题
request.History = append(request.History, &llmshield.MessageV2{
Content: "根据参考资料，火星有几颗天然卫星？",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // 上下文内容来源，该场景下固定为 user-用户提示词
})
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
ragToolCallID := "rag"
request.History = append(request.History, &llmshield.MessageV2{
Content: "火星有两颗天然卫星，分别是福波斯和戴摩斯",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "tool", // tool-工具调用结果（参考资料）
ToolCallID: &ragToolCallID, // 工具调用 ID，标识该条为 RAG 结果
})
if client == nil {
fmt.Printf("Failed to create client instance\n")
return
}
response, err = client.Moderate(&request)
if err != nil {
fmt.Printf("Error occurred while checking LLM response: %v\n", err)
}
if response == nil {
fmt.Println("Received empty result")
}
fmt.Printf("Received result: %s\n", response.String())
}
import com.volcengine.llmshield.*;
public class 幻觉 {
public static void main(String[] args) {
String myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com"; // 根据大模型应用防火墙实例所在地域替换相应的地域信息
String ak = "YOUR_AK"; // 火山账号的 AK
String sk = "YOUR_SK"; // 火山账号的 SK
String region = "cn-beijing"; // 大模型应用防火墙实例所在地域
String myAppID = "YOUR_APPID"; // 资产的 AppId，可在控制台获取
long timeout = 50000; // 超时时间，单位毫秒
ApiClient client = ApiClient.New(myUrl, ak, sk, region, timeout);
ModerateV2Request request = new ModerateV2Request();
request.setScene(myAppID);
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
MessageV2 message = new MessageV2();
message.setContent("根据参考资料，火星有三颗卫星");
message.setRole("assistant"); // 检测的内容来源，该场景下固定为 assistant-模型响应内容
message.setContentType(ContentTypeV2.TEXT);
request.setMessage(message);
// 设置上下文：用户原始问题
MessageV2 message1 = new MessageV2();
message1.setContent("根据参考资料，火星有几颗天然卫星？");
message1.setRole("user"); // 上下文内容来源，该场景下固定为 user-用户提示词
message1.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message1);
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
MessageV2 message2 = new MessageV2();
message2.setContent("火星有两颗天然卫星，分别是福波斯和戴摩斯");
message2.setRole("tool"); // tool-工具调用结果（参考资料）
message2.setToolCallID("rag"); // 工具调用 ID，标识该条为 RAG 结果
message2.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message2);
try {
// 调用 Moderate 接口进行检查
ModerateV2Response response = client.Moderate(request);
if (response != null) {
System.out.println("response: " + response);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
<?php
require __DIR__ . "/vendor/autoload.php";
use Volcengine\LLMShield\Api\LLMShieldApi;
use Volcengine\LLMShield\Model;
// 配置信息
$myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com"; // 根据大模型应用防火墙实例所在地域替换相应的地域信息
$ak = "YOUR AK"; // 火山账号的 AK
$sk = "YOUR SK"; // 火山账号的 SK
$appid = "YOUR APPID"; // 资产的 AppId，可在控制台获取
$region = "cn-beijing"; // 大模型应用防火墙实例所在地域
$timeout = 60; // 超时时间（秒）
$service = "llmshield"; // 服务名称
$client = new LLMShieldApi($myUrl, $ak, $sk, $appid, $region, $timeout, $service);
$request = new Model\ModerateV2Request();
$request->Scene = $appid;
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
$request->Message = new Model\MessageV2();
$request->Message->Role = "assistant"; // 检测的内容来源，该场景下固定为 assistant-模型响应内容
$request->Message->Content = "根据参考资料，火星有三颗卫星";
$request->Message->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文：用户原始问题
$request->History = [];
$request->History[] = new Model\MessageV2();
$request->History[0]->Role = "user"; // 上下文内容来源，该场景下固定为 user-用户提示词
$request->History[0]->Content = "根据参考资料，火星有几颗天然卫星？";
$request->History[0]->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
$request->History[] = new Model\MessageV2();
$request->History[1]->Role = "tool"; // tool-工具调用结果（参考资料）
$request->History[1]->ToolCallID = "rag"; // 工具调用 ID，标识该条为 RAG 结果
$request->History[1]->Content = "火星有两颗天然卫星，分别是福波斯和戴摩斯";
$request->History[1]->ContentType = Model\ContentTypeV2::TEXT;
$client->Moderate($request)->then(function ($resp) {
echo json_encode($resp[0], JSON_UNESCAPED_UNICODE) . "\n";
echo $resp[1] . "\n";
echo json_encode($resp[2], JSON_UNESCAPED_UNICODE) . "\n";
})->wait();
有代理服务
Python
Go
Java
PHP
from volcenginesdkllmshield import *
def main():
myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" # 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak = "YOUR AK" # 火山账号的 AK
sk = "YOUR SK" # 火山账号的 SK
appid = "YOUR APPID" # 资产的 AppId，可在控制台资产管理页面获取
region = "cn-beijing" # 大模型应用防火墙实例所在地域
TIMEOUT = 50 # 超时时间（秒）
# 设置代理服务字典，格式为 {"协议": "代理地址"}
proxy_dict = {
"http": "http://10.37.**.**:8888",
"https": "http://10.37.**.**:8888"
}
try:
# 发送请求并获取响应
client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
# 设置代理地址
client.SetProxy(proxy_dict)
# 设置最大连接数，例如 100
client.SetConnMax(100)
# 构造请求 —— 幻觉检测：模型回答 vs RAG 参考资料
request = ModerateV2Request(
scene = appid, # 资产的 AppId
message = MessageV2(
role = "assistant", # 固定：要检测的是【模型输出回答】
content = "根据参考资料，火星有三颗卫星", # 模型回答（与参考资料矛盾，将被检测为幻觉）
content_type = 1
),
history = [
# 用户问题
MessageV2(
role = "user",
content = "根据参考资料，火星有几颗天然卫星？",
content_type = 1
),
# RAG 真实参考资料（幻觉检测的对照基准，关键！）
MessageV2(
role = "tool",
tool_call_id = "rag",
content_type = 1,
content = "火星有两颗天然卫星，分别是福波斯和戴摩斯"
)
]
)
response = client.Moderate(request)
# 使用 pydantic 的内置序列化方法
print("审核结果（JSON格式）:")
print(response.model_dump_json(by_alias=True, indent=2)) # pydantic 模型直接转 JSON
except Exception as e:
print(f"请求失败: {e}")
if __name__ == "__main__":
main()
package main
import (
"fmt"
"time"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
)
func main() {
myUrl := "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" // 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak := "YOUR AK" // 火山账号的 AK
sk := "YOUR SK" // 火山账号的 SK
appid := "YOUR APPID" // 资产的 AppId，可在控制台获取
region := "cn-beijing" // 大模型应用防火墙实例所在地域
timeout := time.Second * 60 // 超时时间
proxyAddr := "http://10.37.**.**:8888" // 代理地址
connMax := 100 // 最大连接数
// NewAdvanced: 支持代理与最大连接数的高级客户端构造方法
client := llmshield.NewAdvanced(myUrl, ak, sk, region, timeout, proxyAddr, connMax)
if client == nil {
fmt.Println("Failed to create client instance")
return
}
request := &llmshield.ModerateV2Request{
Message: nil,
Scene: appid,
}
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
request.Message = &llmshield.MessageV2{
Content: "根据参考资料，火星有三颗卫星",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "assistant", // 检测的内容来源：该场景下固定为 assistant - 模型响应内容
}
// 设置上下文：用户原始问题
request.History = []*llmshield.MessageV2{
{
Content: "根据参考资料，火星有几颗天然卫星？",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // user - 用户问题
},
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
{
Content: "火星有两颗天然卫星，分别是福波斯和戴摩斯",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "tool", // tool - 工具调用结果（参考资料）
ToolCallID: "rag", // 工具调用 ID，标识该条为 RAG 结果
},
}
response, err := client.Moderate(request)
if err != nil {
fmt.Printf("Error occurred while checking LLM response: %v\n", err)
return
}
if response == nil {
fmt.Println("Received empty result")
return
}
fmt.Printf("Received result: %s\n", response.String())
}
import com.volcengine.llmshield.*;
public class 有代理幻觉检测 {
public static void main(String[] args) {
String myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com"; // 根据大模型应用防火墙实例所在地域替换相应的地域信息
String ak = "YOUR AK"; // 火山账号的 AK
String sk = "YOUR SK"; // 火山账号的 SK
String appid = "YOUR APPID"; // 资产的 AppId，可在控制台获取
String region = "cn-beijing"; // 大模型应用防火墙实例所在地域
long timeout = 50000; // 超时时间（毫秒）
String proxyAddr = "http://10.37.**.**:8888"; // 代理地址
int connMax = 100; // 最大连接数
try {
// New 的 7 参数重载：支持代理地址与最大连接数
ApiClient client = ApiClient.New(myUrl, ak, sk, region, timeout, proxyAddr, connMax);
ModerateV2Request request = new ModerateV2Request();
request.setScene(appid);
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
MessageV2 message = new MessageV2();
message.setContent("根据参考资料，火星有三颗卫星");
message.setRole("assistant"); // 检测的内容来源，该场景下固定为 assistant-模型响应内容
message.setContentType(ContentTypeV2.TEXT);
request.setMessage(message);
// 设置上下文：用户原始问题
MessageV2 message1 = new MessageV2();
message1.setContent("根据参考资料，火星有几颗天然卫星？");
message1.setRole("user"); // 上下文内容来源，该场景下固定为 user-用户提示词
message1.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message1);
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
MessageV2 message2 = new MessageV2();
message2.setContent("火星有两颗天然卫星，分别是福波斯和戴摩斯");
message2.setRole("tool"); // tool-工具调用结果（参考资料）
message2.setToolCallID("rag"); // 工具调用 ID，标识该条为 RAG 结果
message2.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message2);
ModerateV2Response response = client.Moderate(request);
if (response != null) {
System.out.println("response: " + response);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
<?php
require __DIR__ . "/vendor/autoload.php";
use Volcengine\LLMShield\Api\LLMShieldApi;
use Volcengine\LLMShield\Model;
// 配置信息
$myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com"; // 根据大模型应用防火墙实例所在地域替换相应的地域信息
$ak = "YOUR AK"; // 火山账号的 AK
$sk = "YOUR SK"; // 火山账号的 SK
$appid = "YOUR APPID"; // 资产的 AppId，可在控制台获取
$region = "cn-beijing"; // 大模型应用防火墙实例所在地域
$timeout = 60; // 超时时间（秒）
$service = "llmshield"; // 服务名称
$proxy = "http://10.37.**.**:8888"; // 代理地址
// $proxy 传入代理地址，SDK 内部会将其转化为 GuzzleHttp 的 proxy 配置
$client = new LLMShieldApi($myUrl, $ak, $sk, $appid, $region, $timeout, $service, $proxy);
$request = new Model\ModerateV2Request();
$request->Scene = $appid;
// 设置检测内容（模型回答，用于判断是否与参考资料矛盾）
$request->Message = new Model\MessageV2();
$request->Message->Role = "assistant"; // 检测的内容来源，该场景下固定为 assistant-模型响应内容
$request->Message->Content = "根据参考资料，火星有三颗卫星";
$request->Message->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文：用户原始问题
$request->History = [];
$request->History[] = new Model\MessageV2();
$request->History[0]->Role = "user"; // 上下文内容来源，该场景下固定为 user-用户提示词
$request->History[0]->Content = "根据参考资料，火星有几颗天然卫星？";
$request->History[0]->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文：RAG 真实参考资料（幻觉检测的对照基准，关键！）
$request->History[] = new Model\MessageV2();
$request->History[1]->Role = "tool"; // tool-工具调用结果（参考资料）
$request->History[1]->ToolCallID = "rag"; // 工具调用 ID，标识该条为 RAG 结果
$request->History[1]->Content = "火星有两颗天然卫星，分别是福波斯和戴摩斯";
$request->History[1]->ContentType = Model\ContentTypeV2::TEXT;
$client->Moderate($request)->then(function ($resp) {
echo json_encode($resp[0], JSON_UNESCAPED_UNICODE) . "\n";
echo $resp[1] . "\n";
echo json_encode($resp[2], JSON_UNESCAPED_UNICODE) . "\n";
})->wait();
最近更新时间：2026.06.29 11:21:19
这个页面对您有帮助吗？
有用
有用
无用
无用