本文介绍大模型应用防火墙 Python SDK 的下载地址、安装方式以及初始化配置。

前提条件

• 你已获取账号的AccessKey、SecretKey（即 AK、SK），具体步骤，请参见获取AccessKey、SecretKey。
• 你已在大模型应用防火墙控制台完成资产接入并为资产配置相关防护策略，策略配置详情请参见防护策略介绍。

环境要求

Python 3.7 或以上版本（推荐 Python 3.9）。执行python --version可以检查当前 Python 的版本信息。

注意事项

由于 Windows 系统有最长路径限制，可能会导致 Python 安装失败。可以按照以下方式设置：

1. 按下Win+R，输入regedit打开注册表编辑器。
2. 设置\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem 路径下的变量LongPathsEnabled为1即可。

安装 SDK

以下介绍通过pip3命令安装 SDK 及相关依赖的具体步骤。

1. 安装 SDK。

   pip3 install volcengine-python-sdk
   

2. 安装pydantic依赖。

   pip3 install pydantic
   

3. 安装requests依赖。

   pip3 install requests
   

初始化

大模型应用防火墙支持接收代理服务的请求信息，如果你的大模型业务使用了代理服务器来转发或接收客户端请求，可以在初始化大模型应用防火墙时配置代理相关参数，确保其能正确处理代理服务的请求信息。
不同场景的初始化示例代码如下，其中：

• myUrl、ak、sk、appid 和 region 参数的详细说明，参考关键参数说明。
• 如果有代理服务配置需求，需添加代理服务字典 client.SetProxy(proxy_dict)、最大连接数 client.SetConnMax(connMax) 进行代理配置。不添加则表示不使用代理服务。

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  # 超时时间（秒）
   
    # 初始化大模型应用防火墙客户端
    client = ClientV2(myUrl, ak, sk, region, TIMEOUT)

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"}
    
    # 初始化大模型应用防火墙客户端
    client = ClientV2(myUrl, ak, sk, region, TIMEOUT)
    
    # 设置代理地址
    client.SetProxy(proxy_dict)
    # 设置最大连接数，例如 100
    client.SetConnMax(100)