文档中心

向量数据库VikingDB

请输入

数据集(Collection)

updateVikingdbCollection

概述

update_vikingdb_collection 用于为指定数据集 Collection 追加字段。
Collection 支持新增字段（fields）；已定义字段（fields）不支持修改，仅支持修改数据集描述（description）。

方法定义

Python SDK 通过 VIKINGDBApi().update_vikingdb_collection(request) 调用，request 类型为 volcenginesdkvikingdb.UpdateVikingdbCollectionRequest。

请求参数

请求参数为 UpdateVikingdbCollectionRequest，包含的参数如下表所示。

参数	类型	是否必选	描述
project_name	str	否	项目名称，对应 API 字段 `ProjectName`，默认 default。
collection_name	str	至少填写一个	集合名称，对应 API 字段 `CollectionName`。以字母开头，仅可包含字母、数字、下划线，长度 1-128。与 `resource_id` 至少填写一个，可同时填写。
resource_id	str		集合资源 ID，对应 API 字段 `ResourceId`。与 `collection_name` 至少填写一个，推荐同时填写确保准确。
description	str	否	集合描述，对应 API 字段 `Description`，最长 65535 字节。
fields	list[FieldForUpdateVikingdbCollectionInput]	是	新增字段列表，对应 API 字段 `Fields`。单个集合总字段数上限 128，仅支持追加新字段。

Field 参数结构

参数	类型	是否必选	描述
field_name	str	是	新增字段名称，对应 API 字段 `FieldName`。必须以英文字母开头，可包含英文字母、数字、下划线和点号，不能以点号结尾，长度 `[1,128]` Byte。
field_type	str	是	新增字段类型，对应 API 字段 `FieldType`。支持 string、int64、float32、bool、list[string]、list[int64]、text、date_time、geo_point、list[geo_point]；不支持新增 vector、sparse_vector、tensor、image、video。
default_value	object	否	默认值配置，对应 API 字段 `DefaultValue`。省略时 int64、float32、string、bool、list<int64>、list<string>、text、date_time、geo_point、list<geo_point> 分别使用 `0`、`0.0`、`"default"`、`false`、`[0]`、`["default"]`、空字符串、`1970-01-01T00:00:00Z`、`"0, 0"`、空列表。

返回参数

参数	类型	示例值	描述
message	str	success	操作结果描述，对应 API 字段 `Message`。

示例

请求示例

import os
import volcenginesdkcore
import volcenginesdkvikingdb as vdb
from volcenginesdkvikingdb.api.vikingdb_api import VIKINGDBApi

configuration = volcenginesdkcore.Configuration()
configuration.ak = os.environ["VIKINGDB_AK"]
configuration.sk = os.environ["VIKINGDB_SK"]
configuration.region = os.environ["VIKINGDB_REGION"]
configuration.host = os.environ["VIKINGDB_HOST"]
configuration.scheme = "https"
volcenginesdkcore.Configuration.set_default(configuration)

client = VIKINGDBApi()

request = vdb.UpdateVikingdbCollectionRequest(
    collection_name="sdk_demo_collection",
    description="append new fields",
    fields=[
        vdb.FieldForUpdateVikingdbCollectionInput(
            field_name="new_tag",
            field_type="string",
        ),
        vdb.FieldForUpdateVikingdbCollectionInput(
            field_name="extra_score",
            field_type="float32",
        ),
    ],
)
response = client.update_vikingdb_collection(request)
print(response.message or "update submitted")

最近更新时间：2026.09.08 12:02:56

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求示例 #

请求示例