You need to enable JavaScript to run this app.
导航
SDK 概览
最近更新时间:2025.11.07 11:19:29首次发布时间:2025.03.28 19:07:11
复制全文
我的收藏
有用
有用
无用
无用

大模型应用防火墙 SDK 是面向大语言模型应用的内容安全与合规治理组件,提供从输入提示词到模型响应的全链路合规检测与安全代答能力。你可以通过该 SDK 将业务资产(以 AppID 识别)与防护策略绑定,按地域接入服务地址(myUrl/region),并以非流式或流式方式完成内容检测与优化结果生成。

SDK 简介

大模型应用防火墙 SDK 封装了最新版本的 API,以访问密钥(AccessKey)识别调用者身份,提供自动签名等功能,方便您通过 API 创建和管理资源。

核心功能

  • 文本内容合规检测(非流式):一次性提交完整上下文进行深度语义分析,适用于需要整体语义的场景;通过 Moderate 接口返回检测结果与决策类型(如“放行”“拦截”等)。
  • 文本内容合规检测(流式):在模型流式响应期间分块送检,降低整体等待时间;通过 UseStream = 1 或 UseStream = 2 控制会话生命周期,支持边生成边检测的场景。
  • 图片内容合规检测(非流式):​对图片内容进行检测以规避血腥、暴力、黄色等不良内容,保障合规性与安全性,防止模型被滥用。

    注意

    • 仅预付费企业版实例或按量后付费实例支持检测图片。
    • 图片大小限制:10 MB 以内。
    • 图片格式限制:JPG、JPEG、PNG、WEBP、BMP、静态 GIF。
  • 安全代答生成:当检测结果需要“安全代答”时,基于 MsgID 触发 Generate 接口获取安全且友好的代答,结果以流式段落返回,适配需要自动修正输出的使用场景。

    注意

    使用流式检测时,需要待检测完全结束(最后一次传入 usestream=2)并返回结果后,才能调用代答接口,否则可能会导致调用失败。

SDK 列表

下表提供了大模型应用防火墙支持的 SDK 语言列表、下载地址和说明文档。最新版本对应新版

源码地址和说明文档

最新版本

如果您的控制台为最新版本,请参考以下表格获取源码和 SDK 示例。
Image

编程语言

GitHub 地址

说明文档

Python

volcengine-python-sdk

Python 使用示例

Java

volcengine-java-sdk

Java 使用示例

Go

volcengine-go-sdk

Go 使用示例

PHP

volcengine-php-sdk

PHP 使用示例

历史版本

如果您的控制台为旧版本,请参考以下表格获取源码和 SDK 示例。

编程语言

GitHub 地址

说明文档

Python

volcengine-python-sdk

Python 使用示例

Java

volcengine-java-sdk

Java 使用示例

Go

volcengine-go-sdk

Go 使用示例

PHP

volcengine-php-sdk

PHP 使用示例

C++

--

C++ 使用示例