方舟提供了 Python 、 Go 、 Java 的 SDK ,方便您使用对应编程语言快速调用/集成方舟的模型服务。
您本地已经安装了Python ,且版本不低于 3.7。
您可以在终端中输入命令确认Python是否安装以及安装的版本,如未安装,请参考Python安装教程安装,注意选择版本3.7及以上版本。
python -V
在终端中执行以下命令安装Python SDK。
pip install 'volcengine-python-sdk[ark]'
说明
pip install volcengine-python-sdk[ark]
python setup.py install --user
如您本地已经安装了 Python SDK,当需要使用方舟提供的最新能力,需要升级SDK至最新版本,可以在命令中增加-U
参数。
pip install -U 'volcengine-python-sdk[ark]'
检查并安装 Go 版本,Go 版本需要 1.18 或以上。
go version
如果未安装 Go 或者版本不满足要求,您可以访问 Go 语言官方网站下载并安装适合您操作系统的 Go 版本。请确保选择 1.18 或以上版本。
<your-project-name>
替换为您的项目名称。# 如在文件夹 ark-demo 下打开终端窗口,运行命令go mod init ark-demo go mod init <your-project-name>
go get -u github.com/volcengine/volcengine-go-sdk
说明
为了保证系统一致性或者稳定性,你需要安装特定版本的SDK,可以通过下面,安装指定的版本。go get -u github.com/volcengine/volcengine-go-sdk@<VERSION>
<VERSION>
替换为您要安装的SDK版本号,可以从这里查询。import "github.com/volcengine/volcengine-go-sdk/service/arkruntime"
go.mod
和 go.sum
文件。go mod tidy
步骤与安装 Go SDK相同,可参考安装 Go SDK,第1,2步升级至最新/指定版本SDK。
java -version
如果未安装 Java 或者版本不满足要求,您可以访问 Oracle 官方网站下载并安装适合您操作系统的 Java 版本。请确保选择 1.8 或以上版本。
了解 SDK 最新版本,可访问源码地址:https://github.com/volcengine/volcengine-java-sdk
火山方舟 Java SDK 支持通过 Maven 安装、通过 Gradle 安装两种方式。
在 pom.xml
文件中进行如下配置,完整配置可参考 Maven Central:
<dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-ark-runtime</artifactId> <version>LATEST</version> </dependency>
说明
替换'LATEST' 为 方舟 Java SDK 最新版本号,点此可查询。如果需要安装指定版本SDK,也可以替换为具体版本号。
在 build.gradle
文件中进行如下配置,在 dependencies
中添加依赖。
implementation 'com.volcengine:volcengine-java-sdk-ark-runtime:LATEST'
说明
替换'LATEST' 为 方舟 Java SDK 最新版本号,点此可查询。如果需要安装指定版本SDK,也可以替换为具体版本号。
同安装 Java SDK,指定需要升级的版本号即可。
火山方舟模型调用 API 与 OpenAI API 协议兼容,您可以使用兼容 OpenAI API 协议的多语言社区 SDK 调用火山方舟大模型或应用。您可以很方便地迁移模型服务至方舟平台以及 Doubao 大模型。具体使用方法请参考兼容OpenAI API。