[!CAUTION]

已弃用通知

该项目已弃用，不再维护。

如需使用 LlamaCloud/LlamaParse，请查看我们的文档：https://developers.llamaindex.ai/python/cloud/

感谢所有为 LlamaIndex.TS 做出贡献和使用它的朋友们。

LlamaIndex.TS（已弃用）

面向您的大语言模型应用的数据框架。

在支持 TypeScript 的 JavaScript 运行环境中，利用您自己的数据与大型语言模型（LLMs，如 OpenAI ChatGPT 等）进行交互。

文档：https://ts.llamaindex.ai/

在线试用示例：

什么是 LlamaIndex.TS？

LlamaIndex.TS 致力于成为一个轻量级、易于使用的库集合，帮助您将大型语言模型与您自己的数据集成到应用程序中。

兼容性

多种 JavaScript 环境支持

LlamaIndex.TS 支持多种 JavaScript 环境，包括：

• Node.js >= 20 ✅
• Deno ✅
• Bun ✅
• Nitro ✅
• Vercel Edge Runtime ✅（存在一定限制）
• Cloudflare Workers ✅（存在一定限制）

目前，由于缺乏对 AsyncLocalStorage 类似 API 的支持，浏览器端的支持较为有限。

支持的 LLMs：

• OpenAI LLMs
• Anthropic LLMs
• Groq LLMs
• Llama2、Llama3、Llama3.1 LLMs
• MistralAI LLMs
• Fireworks LLMs
• DeepSeek LLMs
• ReplicateAI LLMs
• TogetherAI LLMs
• HuggingFace LLMs
• DeepInfra LLMs
• Gemini LLMs

快速开始

npm install llamaindex
pnpm install llamaindex
yarn add llamaindex

在 Node.js、Deno、Bun、TypeScript 等环境中设置？

请参阅我们的官方文档：https://ts.llamaindex.ai/docs/llamaindex/getting_started

添加提供商包

在大多数情况下，您还需要安装提供商包才能使用 LlamaIndexTS。这些包用于添加 AI 模型、用于数据摄取的文件读取器或用于存储文档的向量数据库等。

例如，要使用 OpenAI LLM，您可以安装以下包：

npm install @llamaindex/openai
pnpm install @llamaindex/openai
yarn add @llamaindex/openai

演示平台

请访问我们的 NextJS 演示平台：https://llama-playground.vercel.app/。源代码可在 https://github.com/run-llama/ts-playground 上找到。

入门核心概念：

请参阅我们的文档：https://ts.llamaindex.ai/docs/llamaindex/getting_started/concepts

贡献：

更多信息请参阅我们的贡献指南。我们非常鼓励您为 LlamaIndex.TS 做出贡献！

社区

欢迎加入我们的 Discord！https://discord.com/invite/eN6D2HQ4aX

LlamaIndexTS 快速上手指南

⚠️ 重要提示：项目已弃用

LlamaIndexTS 项目目前已停止维护。官方建议迁移至 Python 版本或使用 LlamaCloud/LlamaParse。 本文档仅作为历史参考，不建议在新项目中直接使用。如需最新功能，请访问 LlamaIndex 官方文档。

---

1. 环境准备

LlamaIndexTS 是一个用于在 JavaScript/TypeScript 运行时中构建 LLM 应用的数据框架。

系统要求

• 运行时环境（任选其一）：
  • Node.js >= 20 ✅
  • Deno ✅
  • Bun ✅
  • Nitro, Vercel Edge Runtime, Cloudflare Workers ✅ (部分功能受限)
• 注意：浏览器端支持有限，因缺乏 AsyncLocalStorage 类 API 支持。

前置依赖

• 确保已安装 npm, pnpm 或 yarn 包管理器。
• 推荐使用国内镜像源加速安装（以 npm 为例）：

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

---

2. 安装步骤

安装核心库

选择以下任一命令安装主包：

npm install llamaindex
# 或
pnpm install llamaindex
# 或
yarn add llamaindex

安装提供商插件

大多数功能需要额外安装对应的提供商包（如模型接口、文件读取器、向量存储等）。

示例：安装 OpenAI 支持

npm install @llamaindex/openai
# 或
pnpm install @llamaindex/openai
# 或
yarn add @llamaindex/openai

支持的模型包括：OpenAI, Anthropic, Groq, Llama2/3, MistralAI, Gemini 等。

---

3. 基本使用

以下是一个基于 Node.js + TypeScript 的最简示例，展示如何加载文档并进行查询。

代码示例 (index.ts)

import { Document, VectorStoreIndex, Settings } from "llamaindex";
import { OpenAI } from "@llamaindex/openai";

// 配置 LLM (需设置环境变量 OPENAI_API_KEY)
Settings.llm = new OpenAI({ model: "gpt-3.5-turbo" });

async function main() {
  // 1. 准备数据
  const documents = [
    new Document({ text: "LlamaIndexTS 是一个用于 JS 环境的 LLM 数据框架。" }),
    new Document({ text: "它支持 Node.js, Deno, Bun 等多种运行时。" }),
  ];

  // 2. 创建索引
  console.log("正在构建索引...");
  const index = await VectorStoreIndex.fromDocuments(documents);

  // 3. 创建查询引擎
  const queryEngine = index.asQueryEngine();

  // 4. 发起查询
  const response = await queryEngine.query("LlamaIndexTS 支持哪些环境？");
  
  console.log("回答:", response.response);
}

main().catch(console.error);

运行项目

npx ts-node index.ts
# 或使用 bun/deno 运行
bun run index.ts

---

更多资源：

• 官方文档（存档）：https://ts.llamaindex.ai/
• 在线示例：Stackblitz Playground
• 社区交流：Discord