Java SDK を使用したコレクションのステータスとスキーマのクエリ - DashVector

Java SDK を使用して、既存の DashVector コレクションのステータス、スキーマ、および構成を取得します。

前提条件

開始する前に、以下が準備できていることを確認してください。

DashVector クラスター
API キー
最新バージョンの DashVector SDK

API 定義

Java

// DashVectorClient
public Response<CollectionMeta> describe(String name);

リクエストパラメーター

パラメーター	型	必須	デフォルト値	説明
name	String	はい	-	既存のコレクションの名前。

使用例

次の例では、quickstart という名前のコレクションの詳細を取得します。事前に、「コレクションの作成」の例に従ってこのコレクションを作成してください。

次のプレースホルダーを実際の値に置き換えてください。

プレースホルダー	説明
`<your-api-key>`	ご使用の API キー
`<your-cluster-endpoint>`	ご使用のクラスターエンドポイント

Java

import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.CollectionMeta;
import com.aliyun.dashvector.models.responses.Response;

public class Main {
    public static void main(String[] args) throws DashVectorException {
        DashVectorClient client = new DashVectorClient("<your-api-key>", "<your-cluster-endpoint>");

        Response<CollectionMeta> response = client.describe("quickstart");

        System.out.println(response);
    }
}

レスポンスの例：

{
    "code": 0,
    "message": "",
    "requestId": "cb468965-d86b-405a-87a4-a596e61c1240",
    "output": {
        "name": "quickstart",
        "dimension": 4,
        "dataType": "FLOAT",
        "metric": "dotproduct",
        "status": "SERVING",
        "fieldsSchema": {
            "name": "STRING",
            "weight": "FLOAT",
            "age": "INT",
            "id": "LONG"
        },
        "partitionStatus": {
            "default": "SERVING"
        }
    }
}

レスポンスパラメーター

describe メソッドは Response<CollectionMeta> オブジェクトを返します。次のメソッドを使用して、レスポンスデータにアクセスします。

メソッド	型	説明	例
getCode()	int	ステータスコード。詳細については、「ステータスコード」をご参照ください。	0
getMessage()	String	レスポンスメッセージ。	success
getRequestId	String	一意のリクエスト ID。	19215409-ea66-4db9-8764-26ce2eb5bb99
getOutput()	CollectionMeta	コレクションのメタデータ。次の表をご参照ください。	-
isSuccess()	Boolean	操作が成功したかどうか。	true

CollectionMeta オブジェクトは、getOutput() によって返され、以下のフィールドを含みます：

フィールド	型	説明
name	String	コレクション名。
dimension	int	ベクターのディメンション。
dataType	String	`FLOAT` などのベクターデータの型。
metric	String	`dotproduct` などの距離メトリック。
status	String	コレクションのステータス。`SERVING` の値は、コレクションがリクエストを受け入れる準備ができていることを示します。
fieldsSchema	Map<String, String>	スカラーフィールドの定義。各エントリは、フィールド名をそのデータの型 (`STRING`、`FLOAT`、`INT`、または `LONG`) にマッピングします。
partitionStatus	Map<String, String>	各パーティションのステータス。

完全な型定義については、「CollectionMeta」をご参照ください。