大模型应用防火墙
大模型应用防火墙
- 文档首页
大模型应用防火墙SDK 参考文档检测
复制全文
下载 pdf文档检测
文档反馈
问问助手您可以基于大模型应用防火墙 SDK 调用接口对文档内容进行检测。本文提供 Python、Java、Go、PHP 开发语言的文档内容检测示例代码，供您参考。
注意事项
- 前置依赖：参考SDK 安装和初始化完成依赖安装和初始化配置。
- 接口说明：接口介绍、使用限制以及参数描述，请参见检测输入或输出内容是否合规。
- 版本要求：
- 语言版本语言版本pythonJavaGoPHP
无代理服务
Python
Java
Go
PHP
import sys
from volcenginesdkllmshield import *
import base64
def load_file_content(file_type, file_path):
with open(file_path, 'rb') as f:
file_bytes = f.read()
baseStr = base64.b64encode(file_bytes).decode('utf-8')
if file_type == "doc":
baseStr = "data:application/msword;base64," + baseStr
elif file_type == "docx":
baseStr = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + baseStr
elif file_type == "txt":
baseStr = "data:text/plain;base64," + baseStr
elif file_type == "xls":
baseStr = "data:application/vnd.ms-excel;base64," + baseStr
elif file_type == "xlsx":
baseStr = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + baseStr
elif file_type == "pdf":
baseStr = "data:application/pdf;base64," + baseStr
print(f"", baseStr)
return baseStr
def main():
# 配置信息（请替换为实际值）
myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" # 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak = "YOUR AK" # 火山账号的 AK
sk = "YOUR SK" # 火山账号的 SK
appid = "app-d3r06khsqn9s73da****" # 资产的 AppId，可在控制台资产管理页面获取
region = "cn-beijing" # 大模型应用防火墙实例所在地域
TIMEOUT = 50 # 超时时间（秒）
try:
# 发送请求并获取响应
client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
# 构建请求
request = ModerateV2Request(
scene = appid, # 资产的 AppId
message = MessageV2(
role = "user", # 检测的内容来源，user-用户提示词；assistant-模型响应内容
content = load_file_content("docx", "/Users/example/demo.docx"), # 需要检测的文档
content_type = ContentTypeV2.FILE
),
)
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.example;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Base64;
import com.volcengine.llmshield.*;
public class Main {
public static String encodeFileToBase64(String ftype, String filepath) throws IOException {
File file = new File(filepath);
try (FileInputStream fis = new FileInputStream(file)) {
byte[] fileBytes = new byte[(int) file.length()];
fis.read(fileBytes);
String baseStr = Base64.getEncoder().encodeToString(fileBytes);
switch (ftype) {
case "doc":
baseStr = "data:application/msword;base64," + baseStr;
break;
case "docx":
baseStr = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + baseStr;
break;
case "txt":
baseStr = "data:text/plain;base64," + baseStr;
break;
case "xls":
baseStr = "data:application/vnd.ms-excel;base64," + baseStr;
break;
case "xlsx":
baseStr = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + baseStr;
break;
case "pdf":
baseStr = "data:application/pdf;base64," + baseStr;
break;
}
System.out.println("baseStr: " + baseStr);
return baseStr;
}
}
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 myAppID = "app-d3r06khsqn9s73da****"; // 资产的 AppId，可在控制台资产管理页面获取
String region = "cn-beijing"; // 大模型应用防火墙实例所在地域
long timeout = 5000; // 超时时间，单位毫秒
ApiClient client = ApiClient.New(myUrl, ak, sk, region, timeout); // 初始化大模型应用防火墙客户端
ModerateV2Request request = new ModerateV2Request();
request.setScene(myAppID);
String file_content;
try {
file_content = encodeFileToBase64("docx","/Users/example/demo.docx");
// 设置检测内容
MessageV2 message = new MessageV2();
message.setContent(file_content);
message.setRole("user"); // 检测的内容来源，user-用户提示词；assistant-模型响应内容
message.setContentType(ContentTypeV2.FILE);
request.setMessage(message);
} catch (IOException e) {
System.err.println("转换失败:" + e.getMessage());
e.printStackTrace();
}
try {
// 调用 Moderate 接口进行检查
ModerateV2Response response = client.Moderate(request );
if (response != null) {
System.out.println("response: " + response);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
package main
import (
"encoding/base64"
"fmt"
"os"
"time"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
)
func encodeFileToBase64(ftype string, filePath string) (string, error) {
data, err := os.ReadFile(filePath)
if err != nil {
return "", fmt.Errorf("读取文件失败: %v", err)
}
base64Str := base64.StdEncoding.EncodeToString(data)
switch ftype {
case "doc":
base64Str = "data:application/msword;base64," + base64Str
case "docx":
base64Str = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + base64Str
case "txt":
base64Str = "data:text/plain;base64," + base64Str
case "xls":
base64Str = "data:application/vnd.ms-excel;base64," + base64Str
case "xlsx":
base64Str = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + base64Str
case "pdf":
base64Str = "data:application/pdf;base64," + base64Str
}
return base64Str, nil
}
func FilledMsgFile(ftype string, ctype llmshield.ContentTypeV2, fileName string) *llmshield.MultiPart {
dtstr, err := encodeFileToBase64(ftype, fileName)
if err != nil {
fmt.Printf("FilledMsgFile error: %v", err)
return nil
}
msg_multi := &llmshield.MultiPart{
Content: dtstr,
ContentType: ctype,
}
return msg_multi
}
func main() {
var response *llmshield.ModerateV2Response
var err error
myUrl := "https://cn-beijing.sdk.access-test.llm-shield.omini-shield.com" // 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak := "YOUR AK" // 火山账号的 AK
sk := "YOUR SK" // 火山账号的 SK
appid := "app-d3r06khsqn9s73da****" // 资产的 AppId，可在控制台资产管理页面获取
region := "cn-beijing" // 大模型应用防火墙实例所在地域
timeout := time.Second * 60 // 超时时间
request := llmshield.ModerateV2Request{
Message: nil,
Scene: appid,
}
dtstr, _ := encodeFileToBase64("docx", "/Users/example/demo.docx") // 待检测文档的本地存储路径
request.Message = &llmshield.MessageV2{
Content: dtstr,
ContentType: llmshield.ContentTypeV2_FILE,
Role: "user",
}
// 创建客户端实例
client := llmshield.New(myUrl, ak, sk, region, timeout)
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;
function load_file_content($ftype, $filePath) {
if (!file_exists($filePath) || !is_readable($filePath)) {
trigger_error("文件不存在或无法读取：{$filePath}", E_USER_ERROR);
return false;
}
$fileHandle = fopen($filePath, 'rb'); // rb = 只读 + 二进制模式（必须！）
if (!$fileHandle) {
trigger_error("无法打开文件：{$filePath}", E_USER_ERROR);
return false;
}
$binaryContent = fread($fileHandle, filesize($filePath));
fclose($fileHandle); // 务必关闭文件句柄
$base64Content = base64_encode($binaryContent);
switch ($ftype) {
case "txt":
$base64Content = "data:text/plain;base64," . $base64Content;
break;
case "doc":
$base64Content = "data:application/msword;base64," . $base64Content;
break;
case "docx":
$base64Content = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," . $base64Content;
break;
case "xls":
$base64Content = "data:application/vnd.ms-excel;base64," . $base64Content;
break;
case "xlsx":
$base64Content = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," . $base64Content;
break;
case "pdf":
$base64Content = "data:application/pdf;base64," . $base64Content;
break;
}
return $base64Content;
}
// 配置信息
$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;
$file_content = load_file_content("docx", "/Users/example/demo.docx"); // 待检测的文档格式与内容
echo $file_content . "\n";
// 设置检测内容
$request->Message = new Model\MessageV2();
$request->Message->Role = "user"; // 检测的内容来源，user-用户提示词；assistant-模型响应内容
$request->Message->Content = $file_content; // 检测的内容详情
$request->Message->ContentType = Model\ContentTypeV2::FILE; // 检测的内容类型， TEXT-文本；IMAGE-图片；FILE-文档
// 设置上下文
$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
import sys
from volcenginesdkllmshield import *
import base64
def load_file_content(file_type, file_path):
with open(file_path, 'rb') as f:
file_bytes = f.read()
baseStr = base64.b64encode(file_bytes).decode('utf-8')
if file_type == "doc":
baseStr = "data:application/msword;base64," + baseStr
elif file_type == "docx":
baseStr = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + baseStr
elif file_type == "txt":
baseStr = "data:text/plain;base64," + baseStr
elif file_type == "xls":
baseStr = "data:application/vnd.ms-excel;base64," + baseStr
elif file_type == "xlsx":
baseStr = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + baseStr
elif file_type == "pdf":
baseStr = "data:application/pdf;base64," + baseStr
print(f"", baseStr)
return baseStr
def main():
# 配置信息（请替换为实际值）
myUrl = "https://cn-beijing.sdk.access.llm-shield.omini-shield.com" # 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak = "YOUR AK" # 火山账号的 AK
sk = "YOUR SK" # 火山账号的 SK
appid = "app-d3r06khsqn9s73da****" # 资产的 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)
# 构建请求
request = ModerateV2Request(
scene = appid, # 资产的 AppId
message = MessageV2(
role = "user", # 检测的内容来源，user-用户提示词；assistant-模型响应内容
content = load_file_content("docx", "/Users/example/demo.docx"), # 需要检测的文档
content_type = ContentTypeV2.FILE
),
)
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.example;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Base64;
import com.volcengine.llmshield.*;
public class Main {
public static String encodeFileToBase64(String ftype, String filepath) throws IOException {
File file = new File(filepath);
try (FileInputStream fis = new FileInputStream(file)) {
byte[] fileBytes = new byte[(int) file.length()];
fis.read(fileBytes);
String baseStr = Base64.getEncoder().encodeToString(fileBytes);
switch (ftype) {
case "doc":
baseStr = "data:application/msword;base64," + baseStr;
break;
case "docx":
baseStr = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + baseStr;
break;
case "txt":
baseStr = "data:text/plain;base64," + baseStr;
break;
case "xls":
baseStr = "data:application/vnd.ms-excel;base64," + baseStr;
break;
case "xlsx":
baseStr = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + baseStr;
break;
case "pdf":
baseStr = "data:application/pdf;base64," + baseStr;
break;
}
System.out.println("baseStr: " + baseStr);
return baseStr;
}
}
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 myAppID = "app-d3r06khsqn9s73da****"; // 资产的 AppId，可在控制台资产管理页面获取
String region = "cn-beijing"; // 大模型应用防火墙实例所在地域
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);
String file_content;
try {
file_content = encodeFileToBase64("docx","/Users/example/demo.docx");
// 设置检测内容
MessageV2 message = new MessageV2();
message.setContent(file_content);
message.setRole("user"); // 检测的内容来源，user-用户提示词；assistant-模型响应内容
message.setContentType(ContentTypeV2.FILE);
request.setMessage(message);
} catch (IOException e) {
System.err.println("转换失败:" + e.getMessage());
e.printStackTrace();
}
try {
// 调用 Moderate 接口进行检查
ModerateV2Response response = client.Moderate(request );
if (response != null) {
System.out.println("response: " + response);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
package main
import (
"encoding/base64"
"fmt"
"os"
"time"
"github.com/volcengine/volcengine-go-sdk/service/llmshield"
)
func encodeFileToBase64(ftype string, filePath string) (string, error) {
data, err := os.ReadFile(filePath)
if err != nil {
return "", fmt.Errorf("读取文件失败: %v", err)
}
base64Str := base64.StdEncoding.EncodeToString(data)
switch ftype {
case "doc":
base64Str = "data:application/msword;base64," + base64Str
case "docx":
base64Str = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," + base64Str
case "txt":
base64Str = "data:text/plain;base64," + base64Str
case "xls":
base64Str = "data:application/vnd.ms-excel;base64," + base64Str
case "xlsx":
base64Str = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," + base64Str
case "pdf":
base64Str = "data:application/pdf;base64," + base64Str
}
return base64Str, nil
}
func FilledMsgFile(ftype string, ctype llmshield.ContentTypeV2, fileName string) *llmshield.MultiPart {
dtstr, err := encodeFileToBase64(ftype, fileName)
if err != nil {
fmt.Printf("FilledMsgFile error: %v", err)
return nil
}
msg_multi := &llmshield.MultiPart{
Content: dtstr,
ContentType: ctype,
}
return msg_multi
}
func main() {
var response *llmshield.ModerateV2Response
var err error
myUrl := "https://cn-beijing.sdk.access-test.llm-shield.omini-shield.com" // 根据大模型应用防火墙实例所在地域替换相应的地域信息
ak := "YOUR AK" // 火山账号的 AK
sk := "YOUR SK" // 火山账号的 SK
appid := "app-d3r06khsqn9s73da****" // 资产的 AppId，可在控制台资产管理页面获取
region := "cn-beijing" // 大模型应用防火墙实例所在地域
timeout := time.Second * 60 // 超时时间
request := llmshield.ModerateV2Request{
Message: nil,
Scene: appid,
}
dtstr, _ := encodeFileToBase64("docx", "/Users/example/demo.docx") // 待检测文档的本地存储路径
request.Message = &llmshield.MessageV2{
Content: dtstr,
ContentType: llmshield.ContentTypeV2_FILE,
Role: "user",
}
// 创建客户端实例
client := llmshield.NewAdvanced(myUrl, ak, sk, region, timeout, "http://10.37.**.**:8888", 30) // 其中 "http://10.37.**.**:8888" 为代理地址示例值、30 为最大连接数示例值
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;
function load_file_content($ftype, $filePath) {
if (!file_exists($filePath) || !is_readable($filePath)) {
trigger_error("文件不存在或无法读取：{$filePath}", E_USER_ERROR);
return false;
}
$fileHandle = fopen($filePath, 'rb'); // rb = 只读 + 二进制模式（必须！）
if (!$fileHandle) {
trigger_error("无法打开文件：{$filePath}", E_USER_ERROR);
return false;
}
$binaryContent = fread($fileHandle, filesize($filePath));
fclose($fileHandle); // 务必关闭文件句柄
$base64Content = base64_encode($binaryContent);
switch ($ftype) {
case "txt":
$base64Content = "data:text/plain;base64," . $base64Content;
break;
case "doc":
$base64Content = "data:application/msword;base64," . $base64Content;
break;
case "docx":
$base64Content = "data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64," . $base64Content;
break;
case "xls":
$base64Content = "data:application/vnd.ms-excel;base64," . $base64Content;
break;
case "xlsx":
$base64Content = "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64," . $base64Content;
break;
case "pdf":
$base64Content = "data:application/pdf;base64," . $base64Content;
break;
}
return $base64Content;
}
// 配置信息
$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;
$file_content = load_file_content("docx", "/Users/example/demo.docx"); // 待检测的文档格式与内容
echo $file_content . "\n";
// 设置检测内容
$request->Message = new Model\MessageV2();
$request->Message->Role = "user"; // 检测的内容来源，user-用户提示词；assistant-模型响应内容
$request->Message->Content = $file_content; // 检测的内容详情
$request->Message->ContentType = Model\ContentTypeV2::FILE; // 检测的内容类型， TEXT-文本；IMAGE-图片；FILE-文档
// 设置上下文
$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();
最近更新时间：2026.04.27 19:47:53
这个页面对您有帮助吗？
有用
有用
无用
无用