钱闲华 发表于 4 天前

如何通过HTTP API新建Collection

本文介绍如何通过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、id、tags、numbers、bankCards、grades,数据类型分别为string、float、int、long、ARRAY_STRING、ARRAY_INT、ARRAY_LONG、ARRAY_FLOAT

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": "LONG",
      "tags":"ARRAY_STRING",
      "numbers":"ARRAY_INT",
      "bankCards":"ARRAY_LONG",
      "grades":"ARRAY_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"
      }
    },
    "sparse_vectors_schema": {
      "abstruct": {
      "metric": "dotproduct"
      },
      "keywords": {
      "metric": "dotproduct"
      }
      # 稀疏向量索引目前仅支持内积度量,dimension/dtype使用默认值无需设置
    },
    "fields_schema": {
      "author": "STRING"
    }
}' https://YOUR_CLUSTER_ENDPOINT/v1/collections

# example output:
# {"request_id":"819b6ffe-bf44-42a4-8efa-a53a93d93bcd","code":0,"message":""}入参描述

参数Location类型必填说明pathstr是Cluster的Endpoint,可在控制台Cluster详情中查看dashvector-auth-tokenheaderstr是api-keynamebodystr是待创建的Collection名称dimensionbodyint是向量维度,取值范围 (1, 20000\]dtypebodystr否向量数据类型,"FLOAT"(默认)/"INT"fields\_schemabodyobject否Fields定义metricbodystr否距离度量方式,"euclidean"/"dotproduct"/"cosine"(默认) 值为cosine时,dtype必须为FLOATextra\_paramsbodyobject否可选参数: - quantize\_type:量化策略,详情参考向量动态量化 - auto\_id: 自动生成主键,默认开启vectors\_schemabodyobject否多个向量字段定义,类型为 Map,详情参考多向量检索sparse\_vectors\_schemabodyobject否多个稀疏向量字段定义,类型为 Map,详情参考多向量检索说明

[*]创建Collection时预先定义Fields的收益见Schema Free
[*]量化策略详情可参考向量动态量化
出参描述

字段类型描述示例codeint返回值,参考返回状态码说明0messagestr返回消息successrequest\_idstr请求唯一id19215409-ea66-4db9-8764-26ce2eb5bb99
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
页: [1]
查看完整版本: 如何通过HTTP API新建Collection