本文介紹如何通過HTTP API創建一個新的Collection。
前提條件
Method與URL
POST https://{Endpoint}/v1/collections
使用示例
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT,代碼才能正常運行。
創建單向量集合
# 創建一個名稱為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":""}
創建多向量集合
curl -XPOST \
-H 'dashvector-auth-token: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "multi_vector_demo",
"vectors_schema": {
"title": {
"dimension": 4
},
"content": {
"dimension": 6,
"metric": "dotproduct"
}
},
"fields_schema": {
"author": "STRING"
}
}' https://YOUR_CLUSTER_ENDPOINT/v1/collections
# example output:
# {"request_id":"819b6ffe-bf44-42a4-8efa-a53a93d93bcd","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 | 否 | 向量數據類型, |
fields_schema | body | object | 否 | Fields定義 |
metric | body | str | 否 | 距離度量方式, 值為 |
extra_params | body | object | 否 | 可選參數:
|
vectors_schema | body | object | 否 | 多個向量字段定義,類型為 |
創建Collection時預先定義Fields的收益見Schema Free
量化策略詳情可參考向量動態量化
出參描述
字段 | 類型 | 描述 | 示例 |
code | int | 返回值,參考返回狀態碼說明 | 0 |
message | str | 返回消息 | success |
request_id | str | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |