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

前提条件

• 已注册火山引擎账号并完成实名认证。具体步骤，请参见账号注册及实名认证。
• 已在大模型应用防火墙控制台开通当前服务。
• 已获取账号的AccessKey、SecretKey，具体步骤，请参见获取AccessKey、SecretKey。

环境要求

Python 2.7 或以上版本。执行python --version可以检查当前 Python 的版本信息。

注意事项

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

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

安装 SDK

1. 前往volcengine-python-sdk下载大模型应用防火墙 Python SDK 安装包。
2. 使用以下任意一种方式安装 SDK。

   • 方式一：使用 pip 命令安装 SDK。

     pip install volcengine-python-sdk
     

   • 方式二：使用 setup.py 脚本安装 SDK。

     • 执行python setup.py install --user命令，为指定 user 安装 SDK。
     • 执行sudo python setup.py install命令，为全部 user 安装 SDK。

初始化

配置 AK 和 SK

在代码中设置您的 AK 和 SK，可直接使用主账号信息，或者通过用户管理创建子账号，并为子账号授予相应的权限。

configuration.ak = "YOUR AK"
configuration.sk = "YOUR SK"

配置服务接入地域

1. 在大模型应用防火墙控制台实例列表，查看实例所在地域。
   
2. 获取地域 ID，详情请参见 Region 列表。例如：
   • 华北 2（北京）：cn-beijing
   • 华东 2（上海）：cn-shanghai
3. 在代码中设置服务接入地域。

   configuration.region = "cn-beijing"
   

示例代码

完整的初始化示例代码如下：

from __future__ import print_function
import volcenginesdkcore
import volcenginesdkwaf
from volcenginesdkcore.rest import ApiException

if __name__ == '__main__':
    configuration = volcenginesdkcore.Configuration()
    configuration.ak = "YOUR AK"  # Access Key，用于身份验证
    configuration.sk = "YOUR SK"  # Secret Key，用于签名
    configuration.region = "cn-beijing"  # 大模型应用防火墙所属地域对应的 ID
    
    # 设置默认配置
    volcenginesdkcore.Configuration.set_default(configuration)

    # 创建 WAF API 实例
    api_instance = volcenginesdkwaf.WAFApi()