このトピックでは、HTTP API を使用してコレクションを作成する方法について説明します。
前提条件
クラスタが作成されていること。詳細については、「クラスタの作成」をご参照ください。
API キーを取得していること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。
メソッドと URL
POST https://{Endpoint}/v1/collections例
コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスタのエンドポイントに置き換える必要があります。
# コレクションを作成し、その名前を quickstart、ベクトル次元数を 4、
# ベクトルデータ型をデフォルト値の FLOAT、
# 距離メトリックを dotproduct に設定します。
# name、weight、および age フィールドを事前に定義し、それぞれのデータ型を STRING、FLOAT、および INT に設定します。
curl -XPOST \
-H 'dashvector-auth-token: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "quickstart",
"dimension": 4,
"metric": "dotproduct",
"fields_schema": {
"name": "STRING",
"age": "INT",
"weight": "FLOAT"
}
}' https://YOUR_CLUSTER_ENDPOINT/v1/collections
# 出力例:
# {"request_id":"19215409-ea66-4db9-8764-26ce2eb5bb99","code":0,"message":""}リクエストパラメータ
パラメータ | 場所 | タイプ | 必須 | 説明 |
{Endpoint} | パス | str | はい | クラスタのエンドポイント。エンドポイントは、コンソールの クラスタの詳細 ページで確認できます。 |
dashvector-auth-token | ヘッダー | str | はい | API キー。 |
name | 本文 | str | はい | 作成するコレクションの名前。 |
dimension | 本文 | int | はい | ベクトル次元数。有効な値: (1, 20000]。 |
dtype | 本文 | str | いいえ | ベクトルデータ型。有効な値: |
fields_schema | 本文 | object | いいえ | 事前定義されたフィールド。 |
metric | 本文 | str | いいえ | 距離メトリック。有効な値: 値が |
コレクションの作成時にフィールドを事前定義する利点の詳細については、「スキーマフリー」をご参照ください。
レスポンスパラメータ
パラメータ | タイプ | 説明 | 例 |
code | int | 返されたステータスコード。詳細については、「ステータスコード」をご参照ください。 | 0 |
message | str | 返されたメッセージ。 | success |
request_id | str | リクエストの一意の ID。 | 19215409-ea66-4db9-8764-26ce2eb5bb99 |