向量数据库 Viking DB 支持通过 Java SDK 操作数据库。在使用 Java SDK 之前，需要先完成安装 SDK 和 初始化 SDK 步骤。

1. 已通过 注册账号及开通服务 操作完成注册账号及开通服务。
2. 获取安全凭证。Access Key（访问密钥）是访问火山引擎服务的安全凭证，包含Access Key ID（简称为AK）和Secret Access Key（简称为SK）两部分。可登录火山引擎控制台并前往【密钥管理】查看当前账号的 AK / SK，更多详情请参考 Access Key（密钥）管理。
   

为优化权限系统，向量库 SDK分为控制面和数据面，其中控制面为管理数据集、索引、离线任务；数据面为数据、检索和向量化。控制面同时支持从页面操作，请您根据需要配置依赖。

1. 控制面依赖配置

<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>volcengine-java-sdk-vikingdb</artifactId>
    <version>{version}</version>
    <!-- 推荐使用最新版本 -->
    <!-- 版本号可以参考https://central.sonatype.com/artifact/com.volcengine/volcengine-java-sdk-vikingdb/versions -->
</dependency>

maven仓库：
https://central.sonatype.com/artifact/com.volcengine/volcengine-java-sdk-vikingdb/versions
源代码地址：
https://github.com/volcengine/volcengine-java-sdk/tree/master/volcengine-java-sdk-vikingdb

2. 数据面依赖配置

<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>vikingdb-java-sdk</artifactId>
    <version>{version}</version>
    <!-- 推荐使用最新版本 -->
    <!-- 版本号可以参考https://central.sonatype.com/artifact/com.volcengine/vikingdb-java-sdk/versions -->
</dependency>

maven仓库：
https://central.sonatype.com/artifact/com.volcengine/vikingdb-java-sdk/versions
源代码地址：
https://github.com/volcengine/vikingdb-java-sdk

如需私网连接，参考私网连接方式进行配置并获取域名。目前私网连接请求域名仅支持http。

1. 数据面(Data / Search / Embedding)

import com.volcengine.vikingdb.runtime.core.auth.AuthWithAkSk;
import com.volcengine.vikingdb.runtime.core.ClientConfig;
import com.volcengine.vikingdb.runtime.enums.Scheme;
import com.volcengine.vikingdb.runtime.vector.service.VectorService;

import java.util.Properties;

public class VikingDBQuickStart {

    public static void main(String[] args) throws Exception {
        String host = "api-vikingdb.vikingdb.cn-beijing.volces.com";
        String region = "cn-beijing";
        String accessKey = "your-access-key";
        String secretKey = "your-secret-key";

        // 初始化客户端
        VectorService vectorService = new VectorService(
                Scheme.HTTPS,
                host,
                region,
                new AuthWithAkSk(accessKey, secretKey),
                ClientConfig.builder().build()
        );

        System.out.println("VikingDB client initialized successfully.");

        // 后续操作...
    }
}

2. 控制面(Collection / Index / Task)

import com.volcengine.ApiClient;
import com.volcengine.sign.Credentials;
import com.volcengine.vikingdb.VikingdbApi;

public class QuickStart {
    public static void main(String[] args) {
        String ak = "your-access-key"; // 替换为您的 AK
        String sk = "your-secret-key"; // 替换为您的 SK
        String endpoint = "vikingdb.cn-beijing.volcengineapi.com"; // 填写您的控制面服务域名
        String region = "cn-beijing"; // 填写您的服务区域

        ApiClient apiClient = new ApiClient()
                .setEndpoint(endpoint)
                .setCredentials(Credentials.getCredentials(ak, sk))
                .setRegion(region);

        VikingdbApi api = new VikingdbApi(apiClient);

        // 您现在可以使用 'api' 对象调用 VikingDB API
        // ......
    }
}