文档中心

向量数据库VikingDB

请输入

数据(data)

UpsertData

概述

UpsertData 用于在指定的数据集 Collection 内写入数据。指定写入的数据是一个数组，允许单次插入一条数据或者多条数据，单次最多可插入100条数据。
对 V1 版本的 UpsertData 接口进行了调整（仅影响含 vectorize/pipeline 配置的需要向量化数据集，已带 vector 类型字段的数据集不受影响），核心信息如下：

含 vectorize/pipeline 配置的数据集写入，embedding 计算将从实时同步转为后台异步执行，数据生效会有一定滞后；
UpsertData 接口不再返回 need_token_usage 参数信息。

请求参数

字段名	类型	是否必传	说明
CollectionName/CollectionAlias	`string`	是	数据集名称或数据集别名，二选一
Fields	`Record<string, unknown>[]`	是	数据，数据每个元素是 map
TTL	`number`	否	过期时间
async_upsert	`bool`	否	对于“需要向量化”的数据集：本参数仅区分是否流式更新。 async_upsert=false，异步写入生效后触发索引流式更新 async_upsert=true，异步写入生效后仍不触发索引流式更新对于“已有向量数据”的数据集：异步写入开关。异步写入限流阈值为同步写入的 10 倍异步写入的数据不会实时同步写入 collection，滞后时间为分钟级别。可通过接口 `FetchDataInCollection` 来确认数据是否已经写入 collection 异步写入的数据不会触发索引的流式更新，索引同步时间为小时级别。可通过接口 `FetchDataInIndex`接口确认数据是否同步至 index

响应参数

运行示例前，请完成以下准备：
在 Node.js 项目中安装示例导入的 VikingDB SDK 依赖；按示例语言保存为 .js/.mjs 或 .ts 文件，并使用对应的 Node.js/TypeScript 工具链运行。
AK/SK 在火山引擎控制台“密钥管理”中创建；Host 和 Region 取自地域和访问域名。请按代码的参数或环境变量读取方式完成配置。
Collection、Index 名称从 VikingDB 控制台对应资源详情获取；Task ID 使用创建或查询任务接口返回的 ID。请将 <YOUR_...> 占位符替换为真实值。
若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并替换为真实的 <YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>。

declare class VikingdbResponse {
  readonly OriginalRequest: string;
  readonly LogId: string;
  constructor(
    OriginalRequest: string,
    LogId: string
  );
}

参考示例

import { vikingdb } from '@volcengine/openapi'

declare const service: vikingdb.VikingdbService // 替换为你初始化好的实例

await service.data.UpsertData({
  CollectionName: '<YOUR_COLLECTION_NAME>', 
  Fields: [
    { Id: 1, Name: 'Tom' },
    { Id: 2, Name: 'Jerry' },
  ],
})

参数说明补充

async_upsert=true 表示异步写入：接口接收后后台处理，数据可见存在延迟；async_upsert=false 或省略表示同步写入：请求在本批写入处理完成后返回。已带向量字段的数据集使用同步模式；需要后台向量化时使用异步模式。

最近更新时间：2026.09.08 15:30:56

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

参数说明补充 #

参数说明补充