---

什么是 EmbedJs？

EmbedJs 是一个用于个性化大语言模型响应的开源框架。它是一个功能强大的工具集，可帮助开发者在 Node.js 环境中轻松构建增强检索生成（RAG）和大语言模型（LLM）应用。

EmbedJs 可将数据分割成易于管理的块，生成相关的嵌入向量，并将其存储到向量数据库中以实现优化的检索。借助该框架，用户可以从自有数据中提取上下文信息、找到精确的答案，或进行交互式聊天对话，所有这些都完全根据其自身数据定制。

📖 文档

我们提供了全面的指南和 API 文档，助您充分利用 EmbedJs：

• 简介
• 快速入门
• 支持的数据类型
• 示例

🌐 贡献

欢迎各位贡献代码！请先查看仓库中的问题列表，然后随时提交 Pull Request。更多详情请参阅贡献指南。

EmbedJs 快速上手指南

EmbedJs 是一个开源的 Node.js 框架，专为个性化大语言模型（LLM）响应而设计。它能够帮助开发者轻松构建强大的检索增强生成（RAG）应用，支持数据分块、嵌入生成及向量数据库存储，从而实现基于私有数据的上下文提取、精准问答和交互式对话。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows、macOS 或 Linux
• 运行时环境：Node.js (建议版本 18.x 或更高)
• 包管理器：npm 或 yarn
• 前置知识：基本的 JavaScript/TypeScript 编程能力

提示：国内开发者如遇 npm 安装缓慢，可临时切换至淘宝镜像源：

npm config set registry https://registry.npmmirror.com

安装步骤

通过 npm 安装核心包 @llm-tools/embedjs。您可以根据项目需求额外安装特定的数据加载器或向量存储插件。

npm install @llm-tools/embedjs

若需使用特定功能（如读取 PDF 文件或连接 Pinecone 数据库），请按需安装对应插件，例如：

npm install @llm-tools/embedjs-loader-pdf @llm-tools/embedjs-vectorstore-pinecone

基本使用

以下是一个最简单的示例，展示如何加载文本数据、生成嵌入并将其存入内存向量库，最后进行相似度检索。

import { Embedder } from "@llm-tools/embedjs";
import { MemoryVectorStore } from "@llm-tools/embedjs-vectorstore-memory";
import { TextLoader } from "@llm-tools/embedjs-loader-text";

async function main() {
  // 1. 初始化向量存储
  const vectorStore = new MemoryVectorStore();

  // 2. 创建 Embedder 实例并配置数据源
  const embedder = new Embedder({
    vectorStore,
    loaders: [
      new TextLoader({
        data: "EmbedJs 是一个用于构建 RAG 应用的强大 Node.js 框架。",
        metadata: { source: "intro" }
      })
    ]
  });

  // 3. 执行嵌入并存储
  await embedder.load();

  // 4. 查询相似内容
  const results = await vectorStore.similaritySearch("什么是 EmbedJs？", 1);

  console.log("检索结果:", results[0].pageContent);
}

main().catch(console.error);

运行上述代码后，系统将自动把文本分块、生成向量并存储，随后根据查询语句返回最相关的片段。您可以在此基础上扩展更多数据源（如 PDF、URL、数据库）和持久化向量库（如 Chroma、Qdrant）。