このトピックでは、Java 用 SDK を使用して DashVector クライアントを作成する方法について説明します。
DashVector クライアントを使用すると、DashVector サーバーに接続してコレクションに対する操作を実行できます。
前提条件
クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。
API キーを取得していること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。
API 定義
package com.aliyun.dashvector;
// apiKey と endpoint を使用して DashVectorClient オブジェクトを構築します。
DashVectorClient(String apiKey, String endpoint);
// DashVectorClientConfig を使用して DashVectorClient オブジェクトを構築します。
DashVectorClient(DashVectorClientConfig config);
例
コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorClientConfig;
import com.aliyun.dashvector.common.DashVectorException;
public class Main {
public static void main(String[] args) throws DashVectorException {
// apiKey と endpoint を使用して DashVectorClient オブジェクトを構築します。
DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");
// ビルダーを使用して DashVectorClientConfig オブジェクトを構築します。
DashVectorClientConfig config = DashVectorClientConfig.builder()
.apiKey("YOUR_API_KEY")
.endpoint("YOUR_CLUSTER_ENDPOINT")
.timeout(10f)
.build();
client = new DashVectorClient(config);
}
}
リクエストパラメーター
使用できるのは、DashVectorClientConfigBuilder
インスタンスを使用して 構築する DashVectorClientConfig
オブジェクト次の表は、インスタンスによって呼び出すことができるメソッドについて説明しています。
メソッド | 必須 | デフォルト値 | 説明 |
apiKey(String apiKey) | はい | - | API キーを設定します。 |
endpoint(String endpoint) | はい | - | クラスターのエンドポイントを設定します。エンドポイントは、コンソールのクラスター詳細ページで確認できます。 |
timeout(Float timeout) | いいえ | 10.0f | タイムアウト期間を秒単位で設定します。値 -1 はタイムアウトなしを示します。 |
build() | - | - | ビルド |
クラスターのエンドポイントを表示するには、コンソールの クラスターの詳細 ページに移動します。
レスポンスパラメーター
DashVectorClient オブジェクトの初期化中に DashVectorException
がスローされた場合は、例外の詳細に基づいて原因を分析できます。