环境要求

Java JDK 版本不低于 1.8。

下载地址

• 源码地址：https://github.com/volcengine/volcengine-java-sdk
  
  

安装

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

通过 Maven 安装

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

<dependency>
  <groupId>com.volcengine</groupId>
  <artifactId>volcengine-java-sdk-ark-runtime</artifactId>
  <version>LATEST</version>
</dependency>

通过 Gradle 安装

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

implementation 'com.volcengine:volcengine-java-sdk-ark-runtime:LATEST'

配置访问凭证

初始化 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 com.volcengine.ark.runtime.service.ArkService;

public class CreateArkClientExample {
    public static void main(String[] args) {
        String apiKey = System.getenv("ARK_API_KEY");
        ArkService service = ArkService.builder().apiKey(apiKey).build();
    }
    // do your operation...
}

设置地域和访问域名

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

import com.volcengine.ark.runtime.service.ArkService;

public class CreateArkClientExample {
    public static void main(String[] args) {
        String apiKey = System.getenv("ARK_API_KEY");
        
        // 以华北 2 (北京) 为例，<ARK_DOMAIN> 处应改为 ark.cn-beijing.volces.com
        ArkService service = ArkService.builder()
            .apiKey(apiKey)
            .baseUrl("https://<ARK_DOMAIN>/api/v3")
            .build();
    }

    // do your operation...
}

设置超时/重试次数

import com.volcengine.ark.runtime.service.ArkService;

public class CreateArkClientExample {
    public static void main(String[] args) {
        String apiKey = System.getenv("ARK_API_KEY");
        ArkService service = ArkService.builder()
            .apiKey(apiKey)
            .timeout(Duration.ofSeconds(120))
            .connectTimeout(Duration.ofSeconds(20))
            .retryTimes(2)
            .build();
    }

    // do your operation...
}