跳到主要内容
版本：V1.1.0

add - 插入数据

add() 用于向 collection 中插入新数据。在新增记录时，如果已存在具有相同 ID 的记录，则会报错。

信息

仅支持在使用 SeekdbClient 连接时，才能使用该接口。关于 SeekdbClient 的详细介绍，参见 SeekdbClient。

前提条件​

  • 您已经安装了 seekdb-js，有关安装 seekdb-js 的详细信息，参见 快速开始。

  • 您已经安装了 seekdb 服务器模式，有关安装 seekdb 服务器模式的详细信息，参见 通过 yum install 部署 seekdb。

  • 您已经连接到数据库。有关连接的详细操作参见 SeekdbClient。

  • 请确保连接的用户具备 Insert 权限。查看当前用户权限的相关操作请参见 查看用户权限。如果不具备该权限，请联系管理员为您授权，用户授权的相关操作请参见 直接授予权限。

请求参数​

add(
    ids: ids,
    embeddings: embeddings,
    documents: documents,
    metadatas: metadatas
)
参数取值类型是否必选描述取值示例
idsstring 或者 string[]必选文档 ID，可以是单个 ID 或 ID 数组。item1
embeddingsnumber[] | number[][]可选可以是单个向量或向量数组。如果不提供且提供了 documents，会自动使用 embeddingFunction 生成。[0.1, 0.2, 0.3]
documentsstring | string[]可选文档内容，可以是单个字符串或字符串数组。"Hello world", "seekdb is fast"
metadatasMetadata | Metadata[]可选元数据，可以是单个对象或对象数组。{ category: "test" }, { category: "db" }
信息

  • 如果提供了 embeddings: 直接使用向量，不调用 embeddingFunction（即使提供了）。

  • 如果未提供 embeddings 但提供了 documents:

    • 如果集合有 embeddingFunction（在创建或获取时设置），将自动从文档生成向量。

    • 如果集合没有 embeddingFunction，将抛出 ValueError。

  • 如果既未提供 embeddings 也未提供 documents: 将抛出 ValueError。

  • 所有数组参数的长度必须一致。

  • ID 不能重复。

请求示例​

import { SeekdbClient } from "seekdb";

const client = new SeekdbClient({
  host: "127.0.0.1",
  port: 2881,
  user: "root",
  password: "",
  database: "test",
});

const collection = await client.createCollection({
  name: "my_collection"
});

await collection.add({
  ids: ["item1", "item2"],
  documents: ["Hello world", "seekdb is fast"],
  metadatas: [{ category: "test" }, { category: "db" }]
});

返回参数​

无

相关操作​

Contents

编辑此页