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

默认嵌入函数

嵌入函数将文本文档转换为向量嵌入,用于相似度搜索。seekdb-js 支持内置与自定义嵌入函数。

默认嵌入函数使用本地模型(Xenova/all-MiniLM-L6-v2),无需 API 密钥,适合快速开发与测试。使用前需先手动安装 @seekdb/default-embed

npm install @seekdb/default-embed

安装完成后,可按以下两种方式使用默认嵌入逻辑:

  • 方式一:创建 Collection 时不传入 embeddingFunction,系统将自动使用默认嵌入函数进行向量化。

    // 不传入 embeddingFunction 时,自动使用默认嵌入函数
    const collection = await client.createCollection({
    name: "local_embed_collection",
    });
  • 方式二:显式传入 DefaultEmbeddingFunction 实例(便于统一通过参数指定嵌入函数)。

    import { DefaultEmbeddingFunction } from "@seekdb/default-embed";

    const defaultEmbed = new DefaultEmbeddingFunction({
    // 如果遇到下载问题,可尝试切换区域,默认为 'cn'
    // region: 'intl'
    });

    const collection = await client.createCollection({
    name: "local_embed_collection",
    embeddingFunction: defaultEmbed,
    });

首次进行向量化时会自动下载模型,预计 3~5 分钟,具体时间视网络情况而定,请耐心等待。

相关操作

如果您需要使用其他内置函数或者自定义函数,可以参考以下文档创建和使用自定义函数: