环境要求

Python 版本不低于 3.7。

下载地址

• 发布地址：https://pypi.org/project/volcengine-python-sdk

• 源码地址：https://github.com/volcengine/volcengine-python-sdk/tree/master/volcenginesdkarkruntime

安装

火山方舟 Python SDK 支持 pip 安装和源码安装两种方式。

通过 pip 安装

执行以下命令：

pip install 'volcengine-python-sdk[ark]'

源码安装

下载相应版本的 SDK 包，解压后进入目录，执行如下命令：

python setup.py install --user

配置访问凭证

初始化 SDK 客户端前，您需要配置访问凭证。

设置 API Key

执行以下命令配置 API Key 作为访问凭证，其中 YOUR_API_KEY 需要替换为您在平台上创建的 API Key。获取 API Key 访问凭证具体步骤参见签名鉴权方式。

export ARK_API_KEY=<YOUR_API_KEY>

执行以下命令验证配置信息：

echo $ARK_API_KEY

如果配置成功，则返回如下示例：

ea3b96d6-***************************

客户端初始化

import os
from volcenginesdkarkruntime import Ark

client = Ark(api_key=os.environ.get("ARK_API_KEY"))

设置地域和访问域名

代码示例中 <ARK_BASE_URL> 处填写火山方舟推理接入点/智能体资源所在区域对应的访问域名，如不填默认访问华北 2 (北京)。火山方舟支持的地域和访问域名参见地域和访问域名。

import os
from volcenginesdkarkruntime import Ark

# 以华北 2 (北京) 为例，<ARK_BASE_URL> 处应改为 ark.cn-beijing.volces.com
client = Ark(
    api_key=os.environ.get("ARK_API_KEY")
    base_url="https://<ARK_BASE_URL>/api/v3"
)

设置超时/重试次数

import os
from volcenginesdkarkruntime import Ark

client = Ark(
    api_key=os.environ.get("ARK_API_KEY")
    timeout=120
    max_retries=2
)