DashVector: コレクションの作成 - DashVector

ベクトル次元、距離メトリック、およびオプションの事前定義フィールドを指定して POST リクエストを送信し、DashVector コレクションを作成します。

前提条件

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

DashVector クラスター。詳細については、「クラスターの作成」をご参照ください。
API キー。詳細については、「API キーの管理」をご参照ください。
最新の DashVector SDK。詳細については、「DashVector SDK をインストールする」をご参照ください。

メソッドと URL

HTTP

POST https://{Endpoint}/v1/collections

例

リクエストを実行する前に、YOUR_API_KEY と YOUR_CLUSTER_ENDPOINT を実際の値に置き換えてください。

Shell

# 4次元ベクトル、デフォルトのデータ型 FLOAT、距離メトリック dotproduct、
# および 3 つの事前定義フィールド name (STRING)、age (INT)、weight (FLOAT) を持つ
# "quickstart" という名前のコレクションを作成します。

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",
      "id": 1234567890
    }
  }' 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	いいえ	ベクトルデータの型。有効な値: `FLOAT` (デフォルト)、`INT`。
`metric`	ボディ	str	いいえ	距離メトリック。有効な値: `euclidean`、`dotproduct`、`cosine` (デフォルト)。 `cosine` に設定した場合、`dtype` は `FLOAT` である必要があります。
`fields_schema`	ボディ	object	いいえ	事前定義フィールドとそのデータの型。サポートされているデータの型: `STRING`、`INT`、`FLOAT`。

説明

コレクション作成時にフィールドを事前定義する利点の詳細については、「スキーマフリー」をご参照ください。

応答パラメーター

パラメーター	型	説明	例
`code`	int	状態コード。 `0` は成功を示します。詳細については、「状態コード」をご参照ください。	0
`message`	str	応答メッセージ。	success
`request_id`	str	一意のリクエスト ID。	19215409-ea66-4db9-8764-26ce2eb5bb99