大模型应用防火墙
大模型应用防火墙
- 文档首页
大模型应用防火墙SDK 参考SDK 快速入门
复制全文
下载 pdfSDK 快速入门
文档反馈
问问助手通过一个完整的非流式文本内容安全检测示例，您可以在您的开发项目中完成 SDK 初始化、构造检测请求并解析返回结果（判定与理由）。
场景介绍
- 目标：检测一段文本是否合规，并返回判定结果与理由，用于阻断不合规内容。
- 输入：带上下文的文本消息（如用户提示词或模型响应内容），可包含多条历史消息。
- 输出：结构化结果，包含 MsgID（消息标识）、Decision.DecisionType（决策类型）、以及Risks.Category命中的检测分类等信息。
注意事项
- 接入方式：仅支持通过 SDK 方式接入的资产 AppID，其他方式接入的资产在 SDK 调用中不生效。
- 地域与服务地址一致性：region 与 myUrl 中的 {region} 必须一致，域名形如 https://{region}.sdk.access.llm-shield.omini-shield.com。
- 权限要求：子账号至少需具备 AccessKeySelfManageAccess 与 LLMShieldProtectSdkAccess。其他控制台操作等权限说明请参见大模型应用防火墙服务相关权限有哪些？
- API 使用限制：您在使用大模型应用防火墙 SDK 调用 API 之前，请务必了解 API 使用限制，详情请参见使用限制。
实现流程
- 安装 SDK：下载并安装 SDK，详情可参见安装 SDK。
- 初始化：通过环境变量或占位符提供 myUrl、ak、sk、appid、region，构造 LLMShieldApi 客户端。详情可参见初始化配置。
- 构造检测请求（ModerateV2Request）：设置 Message（单条待检内容）：包含 Role、Content、ContentType（示例为 TEXT）。
关键参数说明
参考以下表格了解 SDK 中的关键参数说明及获取方法。
参数 | 示例值 | 说明 |
myUrl |
|
|
ak、sk |
|
|
appid | app-d35p9du8pa51**** |
注意 SDK 调用时支持传入通过 SDK 方式接入的资产 AppID，其他接入方式的资产不生效。
|
region |
|
|
示例代码
示例代码分别提供无代理服务和有代理服务两个场景。如果你的大模型业务使用了代理服务器来转发或接收客户端请求，可以在初始化大模型应用防火墙时配置代理相关参数，确保其能正确处理代理服务的请求信息。
无代理服务
Python
Java
Go
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 = "app-d2vgb96gspu28umn****" # 资产的 AppId，可在控制台资产管理页面获取
region = "cn-beijing" # 大模型应用防火墙实例所在地域
TIMEOUT = 50 # 超时时间（秒）
try:
# 发送请求并获取响应
client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
# 构建请求（使用 pydantic 模型）
request = ModerateV2Request(
scene=appid, # 资产的 AppId
message=MessageV2(
role="user", # 检测的内容来源，user-用户提示词；assistant-模型响应内容
content="网上都说A地很多骗子和小偷，他们的典型伎俩...", # 需要检测的文本内容
content_type=ContentTypeV2.TEXT
),
history=[
MessageV2(
role="system", # 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
content="你是一个智能助手",
content_type=ContentTypeV2.TEXT
),
MessageV2(
role="assistant", # 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
content="Day 1：抵达昆明・滇池与石林初探...",
content_type=ContentTypeV2.TEXT
)
]
)
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 com.TestLLMshieldV2;
import com.volcengine.llmshield.*;
public class Moderate {
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 = "app-d2pgblcjslsilv******"; // 资产的 AppId，可在控制台获取
long timeout = 5000; // 超时时间，单位毫秒
ApiClient client = ApiClient.New(myUrl, ak, sk, region, timeout);
ModerateV2Request request = new ModerateV2Request();
request.setScene(myAppID);
// 设置检测内容
MessageV2 message = new MessageV2();
message.setContent("网上都说A地很多骗子和小偷，他们的典型伎俩...");
message.setRole("user"); // 检测的内容来源，user-用户提示词；assistant-模型响应内容
message.setContentType(ContentTypeV2.TEXT);
request.setMessage(message);
// 设置上下文
MessageV2 message1 = new MessageV2();
message1.setContent("请给我一份十一出行计划");
message1.setRole("user"); // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
message1.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message1);
// 设置上下文
MessageV2 message2 = new MessageV2();
message2.setContent("你是一个智能助手");
message2.setRole("system"); // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
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();
}
}
}
package main
import (
"fmt"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
"time"
)
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 := "app-d2vektrahgp6********" // 资产的 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: "网上都说A地很多骗子和小偷，他们的典型伎俩...",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // 检测的内容来源，user-用户提示词；assistant-模型响应内容
}
// 设置上下文
request.History = append(request.History, &llmshield.MessageV2{
Content: "你是一个专业的问答助手，你的任务是回答用户的问题，注意保持友善和专业。",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "system", // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
})
// 设置上下文
request.History = append(request.History, &llmshield.MessageV2{
Content: "请给我一份十一出行计划",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
})
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 stream: %v\n", err)
}
if response == nil {
fmt.Println("Received empty result")
}
fmt.Printf("Received result: %s\n", response.String())
}
<?php
// 引入 vendor 自动加载文件（用于 GuzzleHttp 等依赖）
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 = "app-d2pgblcjslsilv******"; // 资产的 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 = "user"; // 检测的内容来源，user-用户提示词；assistant-模型响应内容
$request->Message->Content = "网上都说A地很多骗子和小偷，他们的典型伎俩..."; // 检测的文本内容详情
$request->Message->ContentType = Model\ContentTypeV2::TEXT; // 检测的内容类型， TEXT-文本；IMAGE-图片
// 设置上下文
$request->History = [];
$request->History[] = new Model\MessageV2();
$request->History[0]->Role = "system"; // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
$request->History[0]->Content = "你是一个专业的问答助手，你的任务是回答用户的问题，注意保持友善和专业。";
$request->History[0]->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文
$request->History[] = new Model\MessageV2();
$request->History[1]->Role = "user"; // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
$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
Java
Go
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 = "app-d2vgb96gspu28umn****" # 资产的 AppId，可在控制台资产管理页面获取
region = "cn-beijing" # 大模型应用防火墙实例所在地域
TIMEOUT = 50 # 超时时间（秒）
# 设置代理服务字典，格式为 {"协议": "代理地址"}
proxy_dict = {"http": "http://10.37.**.**:8888"}
try:
# 发送请求并获取响应
client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
# 设置代理地址
client.SetProxy(proxy_dict)
# 设置最大连接数，例如 100
client.SetConnMax(100)
# 构建请求（使用 pydantic 模型）
request = ModerateV2Request(
scene=appid, # 资产的 AppId
message=MessageV2(
role="user", # 检测的内容来源，user-用户提示词；assistant-模型响应内容
content="网上都说A地很多骗子和小偷，他们的典型伎俩...", # 需要检测的文本内容
content_type=ContentTypeV2.TEXT
),
history=[
MessageV2(
role="system", # 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
content="你是一个智能助手",
content_type=ContentTypeV2.TEXT
),
MessageV2(
role="assistant", # 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
content="Day 1：抵达昆明・滇池与石林初探...",
content_type=ContentTypeV2.TEXT
)
]
)
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 com.TestLLMshieldV2;
import java.io.IOException;
import com.volcengine.llmshield.*;
public class Moderate {
public static void main(String[] args) throws IOException {
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 = "app-d2pgblcjslsilv******"; // 资产的 AppId，可在控制台获取
long timeout = 5000; // 超时时间，单位毫秒
ApiClient client = ApiClient.New(myUrl, ak, sk, region, timeout, "http://10.37.**.**:8888", 100); // 初始化大模型应用防火墙客户端，其中 "http://10.37.**.**:8888" 为代理地址示例值、100 为最大连接数示例值
ModerateV2Request request = new ModerateV2Request();
request.setScene(myAppID);
// 设置检测内容
MessageV2 message = new MessageV2();
message.setContent("网上都说A地很多骗子和小偷，他们的典型伎俩...");
message.setRole("user"); // 检测的内容来源，user-用户提示词；assistant-模型响应内容
message.setContentType(ContentTypeV2.TEXT);
request.setMessage(message);
// 设置上下文
MessageV2 message1 = new MessageV2();
message1.setContent("请给我一份十一出行计划");
message1.setRole("user"); // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
message1.setContentType(ContentTypeV2.TEXT);
request.appendHistory(message1);
// 设置上下文
MessageV2 message2 = new MessageV2();
message2.setContent("你是一个智能助手");
message2.setRole("system"); // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
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();
}
}
}
package main
import (
"fmt"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
"time"
)
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 := "app-d2vektrahgp6********" // 资产的 AppId，可在控制台获取
region := "cn-beijing" // 大模型应用防火墙实例所在地域
timeout := time.Second * 60 // 超时时间
client := llmshield.NewAdvanced(myUrl, ak, sk, region, timeout, "http://10.37.**.**:8888", 30) // 初始化大模型应用防火墙客户端，其中 "http://10.37.**.**:8888" 为代理地址示例值、30 为最大连接数示例值
request := llmshield.ModerateV2Request{
Message: nil,
Scene: appid, // 资产的 AppId
}
// 设置检测内容
request.Message = &llmshield.MessageV2{
Content: "网上都说A地很多骗子和小偷，他们的典型伎俩...",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // 检测的内容来源，user-用户提示词；assistant-模型响应内容
}
// 设置上下文
request.History = append(request.History, &llmshield.MessageV2{
Content: "你是一个专业的问答助手，你的任务是回答用户的问题，注意保持友善和专业。",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "system", // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
})
// 设置上下文
request.History = append(request.History, &llmshield.MessageV2{
Content: "请给我一份十一出行计划",
ContentType: llmshield.ContentTypeV2_TEXT,
Role: "user", // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
})
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 stream: %v\n", err)
}
if response == nil {
fmt.Println("Received empty result")
}
fmt.Printf("Received result: %s\n", response.String())
}
<?php
// 引入 vendor 自动加载文件（用于 GuzzleHttp 等依赖）
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 = "app-d2pgblcjslsilv******"; // 资产的 AppId，可在控制台资产管理页面获取
$region = "cn-beijing"; // 大模型应用防火墙实例所在地域
$timeout = 60; // 超时时间（秒）
$service = "llmshield"; // 大模型应用防火墙的服务名称
$client = new LLMShieldApi($myUrl, $ak, $sk, $appid, $region, $timeout, $service, "http://10.37.**.**:8888"); // 初始化大模型应用防火墙客户端，其中 "http://10.37.**.**:8888" 为代理地址示例值
$request = new Model\ModerateV2Request();
$request->Scene = $appid;
// 设置检测内容
$request->Message = new Model\MessageV2();
$request->Message->Role = "user"; // 检测的内容来源，user-用户提示词；assistant-模型响应内容
$request->Message->Content = "网上都说A地很多骗子和小偷，他们的典型伎俩..."; // 检测的文本内容详情
$request->Message->ContentType = Model\ContentTypeV2::TEXT; // 检测的内容类型， TEXT-文本；IMAGE-图片
// 设置上下文
$request->History = [];
$request->History[] = new Model\MessageV2();
$request->History[0]->Role = "system"; // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
$request->History[0]->Content = "你是一个专业的问答助手，你的任务是回答用户的问题，注意保持友善和专业。";
$request->History[0]->ContentType = Model\ContentTypeV2::TEXT;
// 设置上下文
$request->History[] = new Model\MessageV2();
$request->History[1]->Role = "user"; // 上下文内容来源，user-用户提示词；assistant-模型响应内容；system-系统默认提示词
$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();
运行结果
注意
运行前，请确保你已在大模型应用防火墙控制台配置相关防护策略，SDK 将按照策略中关联的检测分类和执行动作返回对应结果。
运行代码，得到以下调用结果：
参数 | 说明 |
消息 ID | 19cd001d5f59452ea5f240c0bcca**** |
风险信息 |
|
决策类型 | 2（拦截），表示对应被拦截，你可以根据规则 ID 查看对应防护详情。 |
命中策略 ID | rule-d44mri1i7k3ipsss**** |
Python
Java
Go
PHP
{
"MsgID": "19cd001d5f59452ea5f240c0bcca****",
"RiskInfo": {
"Risks": [
{
"Category": "101",
"Label": "10103005",
"Prob": null,
"Matches": []
},
{
"Category": "101",
"Label": "10112000",
"Prob": 0.98486328125,
"Matches": [
{
"Word": "",
"Action": null,
"Source": 0,
"RuleID": null
}
]
}
]
},
"Decision": {
"DecisionType": 2,
"DecisionDetail": {
"BlockDetail": {},
"ReplaceDetail": {
"Replacement": null
}
},
"DecisionStrategyID": null,
"HitStrategyIDs": [
"rule-d44mri1i7k3ipsss****"
]
},
"PermitInfo": {
"Permits": []
},
"ContentInfo": "text",
"Degraded": false,
"DegradeReason": ""
}
{
"MsgID": "19cd001d5f59452ea5f240c0bcca****",
"RiskInfo": {
"Risks": [
{
"Category": "101",
"Label": "10103005",
"Prob": null,
"Matches": null
},
{
"Category": "101",
"Label": "10112000",
"Prob": 0.98486328125,
"Matches": [
{
"Word": "",
"Action": null,
"Source": 0,
"RuleID": null
}
]
}
]
},
"Decision": {
"DecisionType": 2,
"DecisionDetail": {
"BlockDetail": {},
"ReplaceDetail": {
"Replacement": null
}
},
"DecisionStrategyID": null,
"HitStrategyIDs": [
"rule-d44mri1i7k3ipsss****"
]
},
"PermitInfo": {
"Permits": null
},
"ContentInfo": "text",
"Degraded": false,
"DegradeReason": ""
}
{
"MsgID": "19cd001d5f59452ea5f240c0bcca****",
"RiskInfo": {
"Risks": [
{
"Category": "101",
"Label": "10103005"
},
{
"Category": "101",
"Label": "10112000",
"Prob": 0.98486328125,
"Matches": [
{
"Word": "",
"Source": 0
}
]
}
]
},
"Decision": {
"DecisionType": 2,
"DecisionDetail": {
"BlockDetail": {},
"ReplaceDetail": {
"Replacement": null
}
},
"HitStrategyIDs": [
"rule-d44mri1i7k3ipsss****"
]
},
"PermitInfo": {
"Permits": null
},
"ContentInfo": "text",
"Degraded": false,
"DegradeReason": ""
}
{
"MsgID": "19cd001d5f59452ea5f240c0bcca****",
"RiskInfo": {
"Risks": [
{
"Category": "101",
"Label": "10103005"
},
{
"Category": "101",
"Label": "10112000",
"Prob": 0.98486328125,
"Matches": [
{
"Word": "",
"Source": 0
}
]
}
]
},
"Decision": {
"DecisionType": 2,
"DecisionDetail": {
"BlockDetail": [],
"ReplaceDetail": {
"Replacement": null
}
},
"HitStrategyIDs": [
"rule-d56vrp5tmscl****"
]
},
"PermitInfo": {
"Permits": null
},
"ContentInfo": "text",
"Degraded": false,
"DegradeReason": ""
}
参考信息
- 非流式文本内容检测的接口详细说明，可参见检测输入或输出内容是否合规。
- 其他不同功能对应的调用示例，可参见：
- 文本检测
- 图片检测
- 文档检测
- 音频检测
- 视频检测
最近更新时间：2026.07.21 21:12:51
这个页面对您有帮助吗？
有用
有用
无用
无用