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'

请参见1.获取并配置 API Key 。

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_BASE_URL> 处填写火山方舟推理接入点/应用资源所在区域对应的访问域名，如不填默认访问华北 2 (北京)。火山方舟支持的地域和访问域名参见地域和访问域名。

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)
            .baseUrl("<ARK_BASE_URL>")
            .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...
}

并发调用

当您的业务有较高的请求量，您可以通过单例模式结合线程池和连接池来调整并发调用，以应对不同的并发需求。

建议：

• 每个进程仅初始化ArkService一次，作为单例使用。多次初始化会构建多个线程池以及连接池。
• 进程退出前需要使用 service.shutdownExecutor() 关闭线程池。

import com.volcengine.ark.runtime.service.ArkService;
import okhttp3.ConnectionPool;
import okhttp3.Dispatcher;
import java.util.concurrent.TimeUnit;

public class CreateArkClientExample {
    static String apiKey = System.getenv("ARK_API_KEY");
    static ConnectionPool connectionPool = new ConnectionPool(5, 1, TimeUnit.SECONDS);
    static Dispatcher dispatcher = new Dispatcher();
    static ArkService service = ArkService.builder()
        .dispatcher(dispatcher)
        .connectionPool(connectionPool)
        .apiKey(apiKey)
        .build();

    public static void main(String[] args) {
        // do your operation...
    }
}

使用Access Key鉴权

1. 获取到Access Key。如需创建/查看Access Key，请参见API访问密钥管理。
2. 设置API密钥到环境变量，推荐命名为：VOLC_ACCESSKEY和VOLC_SECRETKEY。

环境变量配置方法类似API Key配置环境变量，具体请参见 配置 API Key 到环境变量。

3. 按照下面示例代码进行初始化。

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

public class CreateArkClientExample {
    public static void main(String[] args) {
        String ak = System.getenv("VOLC_ACCESSKEY");
        String sk = System.getenv("VOLC_SECRETKEY");
        ArkService service = ArkService.builder().ak(ak).sk(sk)
                .build();
    }

    // do your operation...
}