You need to enable JavaScript to run this app.
导航

update

最近更新时间2024.01.22 19:38:14

首次发布时间2023.11.24 15:54:47

概述

/collection/update 接口用于为指定数据集 Collection 增加字段。

说明

Collection 支持新增字段 fields,不支持新增Vector字段类型;已定义字段 fields 不支持修改,仅支持修改数据集描述。

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时,需要构造签名进行鉴权,详细的 OpenAPI 签名调用方法请参见 API签名调用指南

URI

/api/collection/update

统一资源标识符

请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

子参数

类型

是否必选

默认值

参数说明

collection_name

string

指定修改的 Collection 名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • Collection 名称不能重复。

description

string

”“

修改 Collection 的描述。

  • 长度要求:[0, 65535]。

fields

说明

一个 Collection 里的 fields 数量上限是 200。

field_name

string

指定修改字段的名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • 字段名称不能重复。

field_type

string

指定修改字段类型,可选值详见 field_type 可选值说明**。**

default_val

和field_type一致

指定修改字段默认值,默认值详见 field_type 可选值说明**。**

  • 当 field_name 作为主键时,default_val 不会生效,同时也不会被校验。

dim

int

field_type 为vector 时必选

指定修改字段向量维度。

  • 取值范围:[4, 2048],且必须是 4 的倍数。
  • 向量维度是指向量中包含的元素的数量。

pipeline_name

string

field_type 为 text 时可选

文本。纯文本预处理能力 pipeline 是指向量数据库将文本切片、文本向量化、入库、存储自动化的预处理流程。支持以string形式写入原始数据。
pipeline_name 枚举值如下:

  • text_split_bge_large_zh:向量数据库使用切分器将长文本切分成短文本,调用 embedding 模型将短文本向量化。
  • text_bge_large_zh:向量数据库不切分文本,直接调用 embedding 模型将文本向量化。

field_type 可选值

字段类型

可用索引类型

default_val默认值

数据写入时
取值范围

default_val
取值范围

可为主键

说明

int64

枚举

0

int64 范围

int64 范围

整数

float32

范围

0.0

float32 范围

float32 范围

浮点数

string

枚举

"default"

长度<=128

字符串

bool

枚举

false

true/false

true/false

布尔类型

list<string>

枚举

["default"]

List 长度<=32

List 长度<=32

字符串数组

list<int64>

枚举

[0]

List 长度<=32

List 长度<=32

整数数组

text

文本,注意事项:

  • field_type 设置为 text 时可选参数 pipeline_name。
  • 当定义字段 fields 添加了带 pipeline_name 的 text 字段,则不允许添加 vector 字段,且只能有一个带 pipeline_name 的 text 字段;当定义字段 fields 添加了不带 pipeline_name 的 text 字段,则允许添加 vector 字段,且允许添加多个不带 pipeline_name 的 text 字段,text 字段最多200个。

响应消息

参数

参数说明

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

状态码说明

状态码

http状态码

返回信息

状态码说明

0

200

success

指定的 Collection 修改成功。

1000003

400

invalid request:%s

非法参数

  • 缺失必选参数。
  • 出现了预期之外的参数,比如 primary_key。
  • 对已有 field 做了变更(删除、更改属性等)。
  • 字段类型与相关字段属性不满足约束条件。

1000001

401

unauthorized

请求头中缺乏鉴权信息。

1000002

403

no permission

权限不足。

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256***' \
  http://***/api/collection/update \
  -d '{
    "collection_name": "test_name",
    "description": "test dataset",
    "fields": [
        {
            "field_name": "city",
            "field_type": "int64",       
            "default_val": 0
        },
        {
            "field_name": "author",
            "field_type": "string",      
            "default_val": "null"
        }
    ]
}'

响应消息

执行成功返回:

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{"code":0,"msg":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}

执行失败返回:

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000003,"msg":"invalid request: collect miss","request_id":"021695029537650fd001de666660000000000000000000230da93"}