建立Collection - DashVector

本文介紹如何通過HTTP API建立一個新的Collection。

前提條件

已建立Cluster：建立Cluster。
已獲得API-KEY：API-KEY管理。

Method與URL

HTTP

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

使用樣本

說明

需要使用您的api-key替換樣本中的YOUR_API_KEY、您的Cluster Endpoint替換樣本中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。

Shell

            
            
          
# 建立一個名稱為quickstart、向量維度為4、
# 向量資料類型為float（預設值）、
# 距離度量方式為dotproduct（內積）的Collection
# 並預先定義三個Field，名稱為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

# example output:
# {"request_id":"19215409-ea66-4db9-8764-26ce2eb5bb99","code":0,"message":""}

入參描述

參數	Location	類型	必填	說明
{Endpoint}	path	str	是	Cluster的Endpoint，可在控制台Cluster詳情中查看
dashvector-auth-token	header	str	是	api-key
name	body	str	是	待建立的Collection名稱
dimension	body	int	是	向量維度，取值範圍 (1, 20000]
dtype	body	str	否	向量資料類型，`"FLOAT"`（預設）/`"INT"`
fields_schema	body	object	否	Fields定義
metric	body	str	否	距離度量方式，`"euclidean"`/`"dotproduct"`/`"cosine"`（預設）值為`cosine`時，`dtype`必須為`FLOAT`
extra_params	body	object	否	選擇性參數： quantize_type：量化策略，詳情參考向量動態量化 auto_id: 自動產生主鍵，預設開啟

說明

建立Collection時預先定義Fields的收益見Schema Free
量化策略詳情可參考向量動態量化

出參描述

欄位	類型	描述	樣本
code	int	傳回值，參考返回狀態代碼說明	0
message	str	返回訊息	success
request_id	str	請求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99