如何通过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 |

相关推荐
星迹日几秒前
MySQL:数据库设计
数据库·mysql
文慧的科技江湖2 分钟前
图文结合 - 光伏系统产品设计PRD文档 -(慧哥)慧知开源充电桩平台
人工智能·开源·储能·训练·光伏·推理
白熊1886 分钟前
【计算机视觉】CV实战项目 - 基于YOLOv5与DeepSORT的智能交通监控系统:原理、实战与优化
人工智能·yolo·计算机视觉
听闻风很好吃16 分钟前
Redis高级数据类型解析(二)——Set、Sorted Set与Geo实战指南
数据库·redis·缓存
小刘同学++17 分钟前
Qt 使用 MySQL 数据库的基本方法
数据库·qt·mysql
gis收藏家18 分钟前
几何编码:启用矢量模式地理空间机器学习
人工智能·机器学习
宝耶20 分钟前
HTTP协议-请求协议
网络协议·http·servlet
编程在手天下我有23 分钟前
缓存与数据库数据一致性:旁路缓存、读写穿透和异步写入模式解析
数据库·缓存·oracle·软件开发·架构设计·数据一致性
不吃酸的柠檬23 分钟前
MATLAB 中的图形绘制
人工智能·机器学习·matlab
云攀登者-望正茂34 分钟前
Redis 及其在系统设计中的作用
数据库·redis·缓存