如何通过HTTP API新建Collection

本文介绍如何通过HTTP API创建一个新的Collection。


前提条件

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":""}

创建多向量集合

复制代码
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 | 否 | 向量数据类型,"FLOAT"(默认)/"INT" |
| fields_schema | body | object | 否 | Fields定义 |
| metric | body | str | 否 | 距离度量方式,"euclidean"/"dotproduct"/"cosine"(默认) 值为cosine时,dtype必须为FLOAT |
| extra_params | body | object | 否 | 可选参数: * quantize_type:量化策略,详情参考向量动态量化 * auto_id: 自动生成主键,默认开启 |
| vectors_schema | body | object | 否 | 多个向量字段定义,类型为 Map<String, VectorParam>,详情参考多向量检索 |

说明

出参描述

|------------|--------|---------------------------------------------------------------------------------|--------------------------------------|
| 字段 | 类型 | 描述 | 示例 |
| code | int | 返回值,参考返回状态码说明 | 0 |
| message | str | 返回消息 | success |
| request_id | str | 请求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |

相关推荐
jndingxin6 分钟前
瑞芯微算法环境搭建(2)------编译opencv
人工智能·opencv·计算机视觉
LeeZhao@11 分钟前
【具身智能】具身机器人VLA算法入门及实战(一):具身智能系统及VLA
人工智能·docker·语言模型·机器人
深度之眼15 分钟前
【Nature高分思路速递】 物理驱动的机器学习
人工智能·机器学习·pinn
weixin_3077791317 分钟前
在 Microsoft Azure 上部署 ClickHouse 数据仓库:托管服务与自行部署的全面指南
开发语言·数据库·数据仓库·云计算·azure
甜辣uu24 分钟前
【源码讲解+复现】YOLOv10: Real-Time End-to-End Object Detection
人工智能·yolo·目标检测·nms-free
六元七角八分26 分钟前
pom.xml
xml·数据库
虚行36 分钟前
Mysql 数据同步中间件 对比
数据库·mysql·中间件
奥尔特星云大使38 分钟前
mysql读写分离中间件Atlas安装部署及使用
数据库·mysql·中间件·读写分离·atlas
胖达不服输43 分钟前
「日拱一码」105 机器学习原子间势能MLIP
人工智能·机器学习·机器学习原子间势能·mlip
牛马baby1 小时前
【mysql】in 用到索引了吗?
数据库·mysql·in