面向 AI 助手：本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/install-and-upgrade-sdk.md，全部文档索引见 https://ark.volcengine.com/llms.txt。

安装及升级 SDK

方舟提供了 Python 、 Go 和 Java 的 SDK ，方便使用对应编程语言快速调用方舟的模型服务。

推荐新项目使用最新稳定版方舟官方 SDK。对于新版 SDK 暂未支持的 API，可继续安装并使用旧版渠道 SDK；两套 SDK 的包名和导入路径不同，可以在迁移期间并存。请仅在对应代码路径中初始化所需客户端，避免混用请求或响应类型。

Python SDK#

前提条件#

本地已安装了 Python ，且版本不低于 3.8。

可在终端中通过命令确认 Python 版本。

Bash
python -V

Python 可使用 UV 安装，并通过它来管理虚拟环境。UV 是一个 Rust 编写的、速度极快的 Python 包和项目管理器，可以方便进行环境隔离，避免干扰您系统中已有的 Python 配置。

安装 Python SDK#

推荐安装最新版方舟官方 SDK：

Bash
python -m pip install --upgrade arkruntime

在代码中使用：

Python
from arkruntime import Ark

如需调用新版 SDK 暂不支持的 API，可继续安装旧版渠道 SDK：

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

升级 Python SDK#

升级方舟官方 SDK：

Bash
python -m pip install --upgrade arkruntime

升级旧版渠道 SDK：

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

Go SDK#

前提条件#

检查 Go 版本，需 1.20 或以上。

Bash
go version

如未安装或版本不满足，可访问 Go 语言官方网站 下载并安装，请选择 1.20 或以上版本。

安装 Go SDK#

  1. Go SDK 使用 go mod 管理，可运行以下命令初始化 go mod。<YOUR_PROJECT_NAME> 替换为项目名称。

    Bash
    # 如在文件夹 ark-demo 下打开终端窗口，运行命令go mod init ark-demo
go mod init <YOUR_PROJECT_NAME>

  2. 在本地初始化 go mod 后，运行以下命令安装最新版方舟官方 SDK。

    Bash
    go get github.com/volcengine/ark-runtime-go@latest

  3. 在代码中引入方舟官方 SDK。

    Go
    import "github.com/volcengine/ark-runtime-go/arkruntime"

如需调用新版 SDK 暂不支持的 API，可继续安装并引入旧版渠道 SDK：

Bash
go get -u github.com/volcengine/volcengine-go-sdk
Go
import "github.com/volcengine/volcengine-go-sdk/service/arkruntime"

  1. 更新依赖后，使用命令整理依赖。

    Bash
    go mod tidy

升级 Go SDK#

  • 将方舟官方 SDK 升级至最新版本：

    Bash
    go get github.com/volcengine/ark-runtime-go@latest

  • 将方舟官方 SDK 升级至指定版本：

    Bash
    go get github.com/volcengine/ark-runtime-go@<VERSION>

  • 升级旧版渠道 SDK：

    Bash
    go get -u github.com/volcengine/volcengine-go-sdk@<VERSION>

Java SDK#

适用范围#

本 SDK 仅适用于 Java 服务端开发，暂不支持 Android 平台。若需在 Android 平台使用相关功能，需由客户自行开发适配方案。

前提条件#

  1. 检查并安装 Java 版本，Java 版本需 1.8 或以上。

    Bash
    java -version

如未安装 Java 或者版本不满足要求，可访问 Oracle 官方网站 下载并安装适合操作系统的 Java 版本。请确保选择 1.8 或以上版本。

安装 Java SDK#

火山方舟 Java SDK 支持通过 Maven 安装、通过 Gradle 安装两种方式。

安装方舟官方 SDK（推荐）#

推荐新项目使用方舟官方 SDK。请从 Maven Central 获取最新稳定版本，并将 <VERSION> 替换为该版本号。

XML
<dependency>
  <groupId>com.volcengine</groupId>
  <artifactId>ark-runtime</artifactId>
  <version><VERSION></version>
</dependency>
Groovy
implementation "com.volcengine:ark-runtime:<VERSION>"

安装旧版渠道 SDK#

如需调用新版 SDK 暂不支持的 API，可继续使用以下旧版渠道 SDK。请将 <VERSION> 替换为方舟 Java SDK 最新版本号，SDK 版本可查询：https://central.sonatype.com/artifact/com.volcengine/volcengine-java-sdk-ark-runtime。如需安装指定版本 SDK，也可替换为具体版本号。

通过 Maven 安装#

在 pom.xml 文件中进行如下配置，完整配置可参考 Maven Central：

XML
...
<dependency>
  <groupId>com.volcengine</groupId>
  <artifactId>volcengine-java-sdk-ark-runtime</artifactId>
  <version><VERSION></version>
</dependency>
...
通过 Gradle 安装#

在 build.gradle 文件中进行如下配置，在 dependencies 中添加依赖。

plaintext
implementation 'com.volcengine:volcengine-java-sdk-ark-runtime:<VERSION>'

升级 Java SDK#

升级方舟官方 SDK#

使用 Maven Central 上的最新稳定版本替换 <VERSION>，验证通过后在构建文件中锁定该版本。

升级旧版渠道 SDK#

旧版渠道 SDK 请按下方方式查询和升级。

同安装 Java SDK，指定需升级的版本号即可。

第三方SDK#

火山方舟模型调用 API 与 OpenAI API 协议兼容，可使用兼容 OpenAI API 协议的多语言社区 SDK 调用火山方舟大模型或应用。可很方便地迁移模型服务至方舟平台以及 Doubao 大模型。具体使用方法请参考兼容 OpenAI SDK。

相关文档#

SDK 常见使用示例：包含SDK的常见用法。