找回密码
 立即注册
首页 业界区 安全 如何通过HTTP API新建Collection

如何通过HTTP API新建Collection

钱闲华 3 小时前
本文介绍如何通过HTTP API创建一个新的Collection。
前提条件


  • 已创建Cluster:创建Cluster。
  • 已获得API-KEY:API-KEY管理。
Method与URL

HTTP
  1. POST https://{Endpoint}/v1/collections
复制代码
使用示例

说明
需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT,代码才能正常运行。
创建单向量集合

Shell
  1. # 创建一个名称为quickstart、向量维度为4、
  2. # 向量数据类型为float(默认值)、
  3. # 距离度量方式为dotproduct(内积)的Collection
  4. # 并预先定义八个Field,名称为name、weight、age、id、tags、numbers、bankCards、grades,数据类型分别为string、float、int、long、ARRAY_STRING、ARRAY_INT、ARRAY_LONG、ARRAY_FLOAT
  5. curl -XPOST \
  6.   -H 'dashvector-auth-token: YOUR_API_KEY' \
  7.   -H 'Content-Type: application/json' \
  8.   -d '{
  9.     "name": "quickstart",
  10.     "dimension": 4,
  11.     "metric": "dotproduct",
  12.     "fields_schema": {
  13.       "name": "STRING",
  14.       "age": "INT",
  15.       "weight": "FLOAT",
  16.       "id": "LONG",
  17.       "tags":"ARRAY_STRING",
  18.       "numbers":"ARRAY_INT",
  19.       "bankCards":"ARRAY_LONG",
  20.       "grades":"ARRAY_FLOAT"      
  21.     }
  22.   }' https://YOUR_CLUSTER_ENDPOINT/v1/collections
  23. # example output:
  24. # {"request_id":"19215409-ea66-4db9-8764-26ce2eb5bb99","code":0,"message":""}
复制代码
创建多向量集合
  1. curl -XPOST \
  2.   -H 'dashvector-auth-token: YOUR_API_KEY' \
  3.   -H 'Content-Type: application/json' \
  4.   -d '{
  5.     "name": "multi_vector_demo",
  6.     "vectors_schema": {
  7.       "title": {
  8.         "dimension": 4
  9.       },
  10.       "content": {
  11.         "dimension": 6,
  12.         "metric": "dotproduct"
  13.       }
  14.     },
  15.     "sparse_vectors_schema": {
  16.       "abstruct": {
  17.         "metric": "dotproduct"
  18.       },
  19.       "keywords": {
  20.         "metric": "dotproduct"
  21.       }
  22.       # 稀疏向量索引目前仅支持内积度量,dimension/dtype使用默认值无需设置
  23.     },
  24.     "fields_schema": {
  25.       "author": "STRING"
  26.     }
  27. }' https://YOUR_CLUSTER_ENDPOINT/v1/collections
  28. # example output:
  29. # {"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
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

相关推荐

您需要登录后才可以回帖 登录 | 立即注册