Release 0.8.10 (#1466)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: himself65 <himself65@users.noreply.github.com>

.github/workflows/test.yml

@@ -119,7 +119,7 @@ jobs:
         run: pnpm run build
       - name: Build ${{ matrix.packages }}
         run: pnpm run build
-        working-directory: packages/llamaindex/e2e/examples/${{ matrix.packages }}
+        working-directory: e2e/examples/${{ matrix.packages }}
 
   typecheck-examples:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -2,86 +2,58 @@
 
 ## Structure
 
-This is a monorepo built with Turborepo
+LlamaIndex.TS uses pnpm monorepo.
 
-Right now, for first-time contributors, these three packages are of the highest importance:
+We recommend you to understand the basics of Node.js, TypeScript, pnpm, and of course, LLM before contributing.
 
-- `packages/llamaindex` which is the main NPM library `llamaindex`
-- `examples` is where the demo code lives
-- `apps/docs` is where the code for the documentation of https://ts.llamaindex.ai/ is located
+There are some important folders in the repository:
 
-### Turborepo docs
-
-You can checkout how Turborepo works using the default [README-turborepo.md](/README-turborepo.md)
+- `packages/*`: Contains the source code of the packages. Each package is a separate npm package.
+  - `llamaindex`: The starter package for LlamaIndex.TS, which contains the all sub-packages.
+  - `core`: The core package of LlamaIndex.TS, which contains the abstract classes and interfaces. It is designed for
+    all JS runtime environments.
+  - `env`: The environment package of LlamaIndex.TS, which contains the environment-specific classes and interfaces. It
+    includes compatibility layers for Node.js, Deno, Vercel Edge Runtime, Cloudflare Workers...
+- `apps/*`: The applications based on LlamaIndex.TS.
+  - `next`: Our documentation website based on Next.js.
+- `examples`: The code examples of LlamaIndex.TS using Node.js.
 
 ## Getting Started
 
-Install NodeJS. Preferably v18 using nvm or n.
-
-Inside the LlamaIndexTS directory:
+Make sure you have Node.js LIS (Long-term Support) installed. You can check your Node.js version by running:
 
+```shell
+node -v
+# v20.x.x
 ```
-npm i -g pnpm ts-node
+
+### Use pnpm
+
+```shell
+corepack enable
+```
+
+### Install dependencies
+
+```shell
 pnpm install
 ```
 
-Note: we use pnpm in this repo, which has a lot of the same functionality and CLI options as npm but it does do some things better in a monorepo, like centralizing dependencies and caching.
+### Build the packages
 
-PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces) and Turborepo had some [useful documentation also](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks).
-
-### Running Typescript
-
-When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
-
-### Test cases
-
-To run them, run
-
-```
-pnpm run test
-```
-
-To write new test cases write them in [packages/llamaindex/tests](/packages/llamaindex/tests)
-
-We use Vitest https://vitest.dev to write our test cases. Vitest comes with a bunch of built-in assertions using the expect function: https://vitest.dev/api/expect.html#expect
-
-### Demo applications
-
-There is an existing ["example"](/examples/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the `llamaindex` package with a new demo, you need to run the build command in the README.
-
-You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
-
-### Installing packages
-
-To install packages for a specific package or demo application, run
-
-```
-pnpm add [NPM Package] --filter [package or application i.e. llamaindex or docs]
-```
-
-To install packages for every package or application run
-
-```
-pnpm add -w [NPM Package]
+```shell
+# Build all packages
+turbo build --filter "./packages/*"
 ```
 
 ### Docs
 
-To contribute to the docs, go to the docs website folder and run the Docusaurus instance.
-
-```bash
-cd apps/docs
-pnpm install
-pnpm start
-```
-
-That should start a webserver which will serve the docs on https://localhost:3000
-
-Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.
+See the [docs](./apps/next/README.md) for more information.
 
 ## Changeset
 
-We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run in the root folder:
+We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new
+changeset, run in the root folder:
 
 ```
 pnpm changeset
@@ -95,6 +67,6 @@ The [Release Github Action](.github/workflows/release.yml) is automatically gene
 PR called "Release {version}".
 
 This PR will update the `package.json` and `CHANGELOG.md` files of each package according to
-the current changesets in the [.changeset](.changeset/) folder.
+the current changesets in the [.changeset](.changeset) folder.
 
 If this PR is merged it will automatically add version tags to the repository and publish the updated packages to NPM.

apps/docs/CHANGELOG.md

@@ -1,5 +1,58 @@
 # docs
 
+## 0.0.114
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+  - @llamaindex/examples@0.0.14
+
+## 0.0.113
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.0.112
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+  - @llamaindex/examples@0.0.13
+
+## 0.0.111
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.110
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.0.109
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.0.108
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.0.107
 
 ### Patch Changes

apps/docs/docs/modules/llms/available_llms/bedrock.md

@@ -25,6 +25,7 @@ ANTHROPIC_CLAUDE_3_SONNET = "anthropic.claude-3-sonnet-20240229-v1:0";
 ANTHROPIC_CLAUDE_3_HAIKU = "anthropic.claude-3-haiku-20240307-v1:0";
 ANTHROPIC_CLAUDE_3_OPUS = "anthropic.claude-3-opus-20240229-v1:0"; // available on us-west-2
 ANTHROPIC_CLAUDE_3_5_SONNET = "anthropic.claude-3-5-sonnet-20240620-v1:0";
+ANTHROPIC_CLAUDE_3_5_HAIKU = "anthropic.claude-3-5-haiku-20241022-v1:0";
 META_LLAMA2_13B_CHAT = "meta.llama2-13b-chat-v1";
 META_LLAMA2_70B_CHAT = "meta.llama2-70b-chat-v1";
 META_LLAMA3_8B_INSTRUCT = "meta.llama3-8b-instruct-v1:0";

apps/docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.107",
+  "version": "0.0.114",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,29 +15,29 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "3.5.2",
-    "@docusaurus/remark-plugin-npm2yarn": "3.5.2",
+    "@docusaurus/core": "3.6.0",
+    "@docusaurus/remark-plugin-npm2yarn": "3.6.0",
     "@llamaindex/examples": "workspace:*",
-    "@mdx-js/react": "3.0.1",
-    "clsx": "2.1.1",
+    "@mdx-js/react": "^3.1.0",
+    "clsx": "^2.1.1",
     "llamaindex": "workspace:*",
-    "postcss": "8.4.41",
-    "prism-react-renderer": "2.4.0",
-    "raw-loader": "4.0.2",
-    "react": "18.3.1",
+    "postcss": "^8.4.47",
+    "prism-react-renderer": "^2.4.0",
+    "raw-loader": "^4.0.2",
+    "react": "^18.3.1",
     "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.5.2",
-    "@docusaurus/preset-classic": "3.5.2",
-    "@docusaurus/theme-classic": "3.5.2",
-    "@docusaurus/types": "3.5.2",
+    "@docusaurus/module-type-aliases": "3.6.0",
+    "@docusaurus/preset-classic": "3.6.0",
+    "@docusaurus/theme-classic": "3.6.0",
+    "@docusaurus/types": "3.6.0",
     "@tsconfig/docusaurus": "2.0.3",
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.9.0",
     "docusaurus-plugin-typedoc": "1.0.5",
-    "typedoc": "0.26.6",
-    "typedoc-plugin-markdown": "4.2.6",
-    "typescript": "^5.6.2"
+    "typedoc": "0.26.11",
+    "typedoc-plugin-markdown": "4.2.10",
+    "typescript": "^5.6.3"
   },
   "browserslist": {
     "production": [

apps/next/.gitignore

@@ -29,3 +29,4 @@ next-env.d.ts
 
 # build
 /src/content/docs/cloud/api
+./types

apps/next/CHANGELOG.md

@@ -1,5 +1,92 @@
 # @llamaindex/doc
 
+## 0.0.12
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+- Updated dependencies [d89ebe0]
+- Updated dependencies [fd8c882]
+- Updated dependencies [fd8c882]
+  - llamaindex@0.8.10
+  - @llamaindex/core@0.4.7
+  - @llamaindex/workflow@0.0.4
+  - @llamaindex/cloud@2.0.7
+  - @llamaindex/node-parser@0.0.8
+  - @llamaindex/openai@0.1.32
+  - @llamaindex/readers@1.0.8
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+  - @llamaindex/cloud@2.0.6
+  - @llamaindex/core@0.4.6
+  - @llamaindex/node-parser@0.0.7
+  - @llamaindex/openai@0.1.31
+  - @llamaindex/readers@1.0.7
+
+## 0.0.10
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - @llamaindex/core@0.4.5
+  - llamaindex@0.8.8
+  - @llamaindex/node-parser@0.0.6
+  - @llamaindex/workflow@0.0.3
+  - @llamaindex/cloud@2.0.5
+  - @llamaindex/openai@0.1.30
+  - @llamaindex/readers@1.0.6
+
+## 0.0.9
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.4
+- @llamaindex/core@0.4.4
+- llamaindex@0.8.7
+- @llamaindex/node-parser@0.0.5
+- @llamaindex/openai@0.1.29
+- @llamaindex/readers@1.0.5
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - @llamaindex/core@0.4.3
+  - llamaindex@0.8.6
+  - @llamaindex/cloud@2.0.3
+  - @llamaindex/node-parser@0.0.4
+  - @llamaindex/openai@0.1.28
+  - @llamaindex/readers@1.0.4
+
+## 0.0.7
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+  - @llamaindex/cloud@2.0.2
+  - @llamaindex/core@0.4.2
+  - @llamaindex/node-parser@0.0.3
+  - @llamaindex/openai@0.1.27
+  - @llamaindex/readers@1.0.3
+
+## 0.0.6
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+  - @llamaindex/readers@1.0.2
+
 ## 0.0.5
 
 ### Patch Changes

apps/next/README.md

@@ -1,4 +1,4 @@
-# next
+# Docs
 
 This is a Next.js application generated with
 [Create Fumadocs](https://github.com/fuma-nama/fumadocs).
@@ -6,15 +6,10 @@ This is a Next.js application generated with
 Run development server:
 
 ```bash
-npm run dev
-# or
-pnpm dev
-# or
-yarn dev
+turbo run dev
+# turbo will build all required packages before running the dev server
 ```
 
-Open http://localhost:3000 with your browser to see the result.
-
 ## Learn More
 
 To learn more about Next.js and Fumadocs, take a look at the following

apps/next/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/doc",
-  "version": "0.0.5",
+  "version": "0.0.12",
   "private": true,
   "scripts": {
     "build": "pnpm run build:docs && next build",
@@ -12,6 +12,7 @@
   },
   "dependencies": {
     "@icons-pack/react-simple-icons": "^10.1.0",
+    "@llamaindex/chat-ui": "0.0.5",
     "@llamaindex/cloud": "workspace:*",
     "@llamaindex/core": "workspace:*",
     "@llamaindex/node-parser": "workspace:*",
@@ -67,7 +68,7 @@
   "devDependencies": {
     "@next/env": "^15.0.2",
     "@types/mdx": "^2.0.13",
-    "@types/node": "22.8.6",
+    "@types/node": "22.9.0",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
     "autoprefixer": "^10.4.20",

apps/next/scripts/update-llamacloud.mts

@@ -1,4 +1,4 @@
-import { PipelinesService } from "@llamaindex/cloud/api";
+import { upsertBatchPipelineDocumentsApiV1PipelinesPipelineIdDocumentsPut } from "@llamaindex/cloud/api";
 import fg from "fast-glob";
 import {
   fileGenerator,
@@ -30,9 +30,8 @@ async function processContent(content: string): Promise<string> {
 }
 
 export async function updateLlamaCloud(): Promise<void> {
-  // eslint-disable-next-line turbo/no-undeclared-env-vars
   const apiKey = process.env.LLAMA_CLOUD_API_KEY;
-  // eslint-disable-next-line turbo/no-undeclared-env-vars
+
   const index = process.env.LLAMA_CLOUD_PIPELINE_ID;
 
   if (!apiKey || !index) {
@@ -83,28 +82,26 @@ export async function updateLlamaCloud(): Promise<void> {
 
   console.log(`added ${records.length} records`);
 
-  await PipelinesService.upsertBatchPipelineDocumentsApiV1PipelinesPipelineIdDocumentsPut(
-    {
-      baseUrl: "https://api.cloud.llamaindex.ai/",
-      body: records.map((record) => ({
-        id: record.id,
-        metadata: {
-          title: record.title,
-          description: record.description,
-          documentUrl: record.id,
-          category: record.category,
-        },
-        text: record.content,
-      })),
-      path: {
-        pipeline_id: index,
-      },
-      throwOnError: true,
-      headers: {
-        Authorization: `Bearer ${apiKey}`,
+  await upsertBatchPipelineDocumentsApiV1PipelinesPipelineIdDocumentsPut({
+    baseUrl: "https://api.cloud.llamaindex.ai/",
+    body: records.map((record) => ({
+      id: record.id,
+      metadata: {
+        title: record.title,
+        description: record.description,
+        documentUrl: record.id,
+        category: record.category,
       },
+      text: record.content,
+    })),
+    path: {
+      pipeline_id: index,
     },
-  );
+    throwOnError: true,
+    headers: {
+      Authorization: `Bearer ${apiKey}`,
+    },
+  });
 
   console.log("done");
 }

apps/next/src/app/(home)/page.tsx

@@ -11,6 +11,7 @@ import { NpmInstall } from "@/components/npm-install";
 import { TextEffect } from "@/components/text-effect";
 import { Button } from "@/components/ui/button";
 import { Skeleton } from "@/components/ui/skeleton";
+import { LEGACY_DOCUMENT_URL } from "@/lib/const";
 import { SiStackblitz } from "@icons-pack/react-simple-icons";
 import {
   CodeBlock as FumaCodeBlock,
@@ -24,20 +25,21 @@ export default function HomePage() {
   return (
     <main className="container mx-auto px-4 py-12">
       <h1 className="text-4xl md:text-6xl font-bold text-center mb-4">
-        Build RAG Web App using
+        Build context-augmented web apps using
         <br /> <span className="text-blue-500">LlamaIndex.TS</span>
       </h1>
       <p className="text-xl text-center text-fd-muted-foreground mb-12 ">
-        LlamaIndex.TS is the JS/TS library from our popular Python library
-        llama-index for building LLM applications
+        LlamaIndex.TS is the JS/TS version of{" "}
+        <a href="https://llamaindex.ai">LlamaIndex</a>, the framework for
+        building agentic generative AI applications connected to your data.
       </p>
       <div className="text-center text-lg text-fd-muted-foreground mb-12">
-        <span>Designed for building web applications under </span>
+        <span>Designed for building web applications in </span>
         <TextEffect />
       </div>
 
       <div className="flex flex-wrap justify-center gap-4">
-        <Link href="/docs/llamaindex">
+        <Link href={LEGACY_DOCUMENT_URL}>
           <Button variant="outline">Get Started</Button>
         </Link>
         <NpmInstall />
@@ -57,8 +59,8 @@ export default function HomePage() {
         <Feature
           icon={Footprints}
           subheading="Progressive"
-          heading="Adding AI feature from simple to complex"
-          description="LlamaIndex.TS is designed to be simple to start with and can be extended to build complex AI applications."
+          heading="From the simplest to the most complex"
+          description="LlamaIndex.TS is designed to be simple to get started, but powerful enough to build complex, agentic AI applications."
         >
           <Suspense
             fallback={
@@ -112,9 +114,9 @@ const response = await agent.chat({
         </Feature>
         <Feature
           icon={Bot}
-          subheading="Agent"
-          heading="Build agent for RAG"
-          description="Build agents for RAG using LlamaIndex.TS. Agents are the core building blocks of RAG applications."
+          subheading="Agents"
+          heading="Build agentic RAG applications"
+          description="Truly powerful retrieval-augmented generation applications use agentic techniques, and LlamaIndex.TS makes it easy to build them."
         >
           <CodeBlock
             code={`import { FunctionTool } from "llamaindex";
@@ -136,19 +138,19 @@ await agent.chat('...');`}
         <Feature
           icon={Blocks}
           subheading="Providers"
-          heading="LLM / Data Loader / Vector Store"
-          description="LlamaIndex.TS provides various providers to turn your data into valuable insights."
+          heading="LLMs, Data Loaders, Vector Stores and more!"
+          description="LlamaIndex.TS has hundreds of integrations to connect to your data, index it, and query it with LLMs."
         >
           <div className="mt-8 flex flex-col gap-8">
             <div>
               <h3 className="text-lg font-semibold text-fd-muted-foreground mb-2">
-                LLM
+                LLMs
               </h3>
               <InfiniteLLMProviders />
             </div>
             <div>
               <h3 className="text-lg font-semibold text-fd-muted-foreground mb-2">
-                Vector Store
+                Vector Stores
               </h3>
               <InfiniteVectorStoreProviders />
             </div>
@@ -156,8 +158,8 @@ await agent.chat('...');`}
         </Feature>
         <Feature
           icon={Terminal}
-          subheading="Create Llama CLI"
-          heading="CLI for starting RAG app with one line"
+          subheading="create-llama CLI"
+          heading="Build a RAG app with a single command"
           description="A command line tool to generate LlamaIndex apps, the easiest way to get started with LlamaIndex."
         >
           <div className="my-6">

apps/next/src/app/api/chat/route.ts

@@ -0,0 +1,30 @@
+import { LlamaIndexAdapter, type Message } from "ai";
+import { SimpleChatEngine, type ChatMessage } from "llamaindex";
+import { NextResponse, type NextRequest } from "next/server";
+
+export async function POST(request: NextRequest) {
+  try {
+    const { messages } = (await request.json()) as { messages: Message[] };
+    const userMessage = messages[messages.length - 1];
+    if (!userMessage || userMessage.role !== "user") {
+      return NextResponse.json(
+        { detail: "Last message is not a user message" },
+        { status: 400 },
+      );
+    }
+
+    const chatEngine = new SimpleChatEngine();
+
+    return LlamaIndexAdapter.toDataStreamResponse(
+      await chatEngine.chat({
+        message: userMessage.content,
+        chatHistory: messages as ChatMessage[],
+        stream: true,
+      }),
+      {},
+    );
+  } catch (error) {
+    const detail = (error as Error).message;
+    return NextResponse.json({ detail }, { status: 500 });
+  }
+}

apps/next/src/app/layout.config.tsx

@@ -1,4 +1,4 @@
-import { Badge } from "@/components/ui/badge";
+import { LEGACY_DOCUMENT_URL } from "@/lib/const";
 import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
 import Image from "next/image";
 
@@ -27,18 +27,8 @@ export const baseOptions: BaseLayoutProps = {
   githubUrl: "https://github.com/run-llama/LlamaIndexTS",
   links: [
     {
-      text: (
-        <div className="relative">
-          Docs
-          <Badge
-            variant="outline"
-            className="text-blue-500 absolute -top-5 -left-5 bg-fd-background hover:scale-125 transition-transform -rotate-3 hover:-rotate-12"
-          >
-            new
-          </Badge>
-        </div>
-      ),
-      url: "/docs/llamaindex",
+      text: "Docs",
+      url: LEGACY_DOCUMENT_URL,
       active: "nested-url",
     },
   ],

apps/next/src/components/contribution.tsx

@@ -7,9 +7,8 @@ import { ReactElement } from "react";
 export function Contributing(): ReactElement {
   return (
     <div className="flex flex-col items-center border-x border-t px-4 py-16 text-center">
-      <Heart className="mb-4" />
       <h2 className="mb-4 text-xl font-semibold sm:text-2xl">
-        Made Possible by You.
+        Made possible by you <Heart className="inline align-middle" />
       </h2>
       <p className="mb-4 text-fd-muted-foreground">
         LlamaIndex.TS is powered by the open source community.

apps/next/src/components/contributor-count.tsx

@@ -53,9 +53,6 @@ export default async function ContributorCounter({
           </div>
         ) : null}
       </div>
-      <div className="text-center text-sm text-fd-muted-foreground">
-        Some of our best contributors.
-      </div>
     </div>
   );
 }

apps/next/src/components/demo/chat.tsx

@@ -0,0 +1,8 @@
+"use client";
+import { ChatSection } from "@llamaindex/chat-ui";
+import { useChat } from "ai/react";
+
+export const ChatDemo = () => {
+  const handler = useChat();
+  return <ChatSection handler={handler} />;
+};

apps/next/src/content/docs/llamaindex/guide/chat.mdx

@@ -0,0 +1,46 @@
+---
+title: Chat-UI 
+description: Use chat-ui to add a chat interface to your LlamaIndexTS application.
+---
+import { ChatDemo } from '../../../../components/demo/chat';
+import "@llamaindex/chat-ui/styles/code.css";
+import "@llamaindex/chat-ui/styles/katex.css";
+
+Using [chat-ui](https://github.com/run-llama/chat-ui), it's easy to add a chat interface to your LlamaIndexTS application.
+You just need to create an API route that provides an `api/chat` endpoint and a chat component to consume the API.
+
+## API route
+
+As an example, this is an API route for the Next.js App Router. Copy the following code into your `app/api/chat/route.ts` file to get started:
+
+```json doc-gen:file
+{
+  "file": "./src/app/api/chat/route.ts",
+	"codeblock": true
+}
+```
+
+## Chat UI
+
+This is the simplest way to add a chat interface to your application. Copy the following code into your application to consume the API:
+
+```json doc-gen:file
+{
+  "file": "./src/components/demo/chat.tsx",
+	"codeblock": true
+}
+```
+
+## Try it out ⬇️
+
+Combining both, you're getting a fully functional chat interface:
+
+<ChatDemo />
+
+## Next Steps
+
+The steps above are the bare minimum to get a chat interface working. From here, you can go two ways:
+
+1. Use [create-llama](https://github.com/run-llama/create-llama) to scaffold a new LlamaIndexTS project including complex API routes and chat interfaces or
+2. Learn more about [chat-ui](https://github.com/run-llama/chat-ui) and [LlamaIndexTS](https://github.com/run-llama/llamaindex-ts) to customize the chat interface and API routes to your needs.
+

apps/next/src/content/docs/llamaindex/guide/meta.json

@@ -1,5 +1,5 @@
 {
   "title": "Guide",
   "description": "See our guide",
-  "pages": ["workflow"]
+  "pages": ["workflow", "chat"]
 }

apps/next/src/content/docs/llamaindex/setup/typescript.mdx

@@ -93,6 +93,35 @@ See more about [moduleResolution](https://www.typescriptlang.org/docs/handbook/m
 	</Accordion>
 </Accordions>
 
+## Enable AsyncIterable for `Web Stream` API
+
+Some modules uses `Web Stream` API like `ReadableStream` and `WritableStream`, you need to enable `DOM.AsyncIterable` in your `tsconfig.json`.
+
+```json5
+{
+  compilerOptions: {
+    // ⬇️ add this lib to your tsconfig.json
+    lib: ["DOM.AsyncIterable"],
+  },
+}
+```
+
+```ts twoslash
+import { OpenAIAgent } from '@llamaindex/openai'
+
+const agent = new OpenAIAgent({
+  tools: []
+})
+
+const response = await agent.chat({
+  message: 'Hello, how are you?',
+  stream: true
+})
+for await (const _ of response) {
+                      //^?
+  // ...
+}
+```
 
 ## Run TypeScript Script in Node.js
 

apps/next/src/deps/cloud.ts

@@ -1,8 +1,8 @@
 import {
   type MetadataFilter,
   type MetadataFilters,
-  PipelinesService,
   type RetrievalParams,
+  runSearchApiV1PipelinesPipelineIdRetrievePost,
   type TextNodeWithScore,
 } from "@llamaindex/cloud/api";
 import { QueryBundle } from "@llamaindex/core/query-engine";
@@ -74,7 +74,7 @@ export class LlamaCloudRetriever extends BaseRetriever {
     const pipelineId = this.pipelineId;
 
     const { data: results } =
-      await PipelinesService.runSearchApiV1PipelinesPipelineIdRetrievePost({
+      await runSearchApiV1PipelinesPipelineIdRetrievePost({
         throwOnError: true,
         path: {
           pipeline_id: pipelineId,

apps/next/tailwind.config.js

@@ -10,6 +10,7 @@ export default {
     "./src/mdx-components.{ts,tsx}",
     "./node_modules/fumadocs-ui/dist/**/*.js",
     "./node_modules/fumadocs-openapi/dist/**/*.js",
+    "./node_modules/@llamaindex/chat-ui/**/*.{ts,tsx}",
   ],
   presets: [createPreset()],
   // eslint-disable-next-line @typescript-eslint/no-require-imports

apps/next/turbo.json

@@ -0,0 +1,16 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "outputs": [
+        ".next",
+        ".source",
+        "next-env.d.ts",
+        "src/content/docs/cloud/api/**"
+      ]
+    },
+    "dev": {
+      "dependsOn": ["^build"]
+    }
+  }
+}

apps/next/types/cache-life.d.ts

@@ -1,135 +0,0 @@
-// Type definitions for Next.js cacheLife configs
-
-declare module "next/cache" {
-  export { cacheTag as unstable_cacheTag } from "next/dist/server/use-cache/cache-tag";
-  export {
-    revalidatePath,
-    revalidateTag,
-  } from "next/dist/server/web/spec-extension/revalidate";
-  export { unstable_cache } from "next/dist/server/web/spec-extension/unstable-cache";
-  export { unstable_noStore } from "next/dist/server/web/spec-extension/unstable-no-store";
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"default"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 900 seconds (15 minutes)
-   *   expire:     never
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 15 minutes, start revalidating new values in the background.
-   * It lives for the maximum age of the server cache. If this entry has no traffic for a while, it may serve an old value the next request.
-   */
-  export function unstable_cacheLife(profile: "default"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"seconds"` profile.
-   * ```
-   *   stale:      0 seconds
-   *   revalidate: 1 seconds
-   *   expire:     1 seconds
-   * ```
-   *
-   * This cache may be stale on clients for 0 seconds before checking with the server.
-   * This cache will expire after 1 seconds. The next request will recompute it.
-   */
-  export function unstable_cacheLife(profile: "seconds"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"minutes"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 60 seconds (1 minute)
-   *   expire:     3600 seconds (1 hour)
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 1 minute, start revalidating new values in the background.
-   * If this entry has no traffic for 1 hour it will expire. The next request will recompute it.
-   */
-  export function unstable_cacheLife(profile: "minutes"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"hours"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 3600 seconds (1 hour)
-   *   expire:     86400 seconds (1 day)
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 1 hour, start revalidating new values in the background.
-   * If this entry has no traffic for 1 day it will expire. The next request will recompute it.
-   */
-  export function unstable_cacheLife(profile: "hours"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"days"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 86400 seconds (1 day)
-   *   expire:     604800 seconds (1 week)
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 1 day, start revalidating new values in the background.
-   * If this entry has no traffic for 1 week it will expire. The next request will recompute it.
-   */
-  export function unstable_cacheLife(profile: "days"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"weeks"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 604800 seconds (1 week)
-   *   expire:     2592000 seconds (30 days)
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 1 week, start revalidating new values in the background.
-   * If this entry has no traffic for 30 days it will expire. The next request will recompute it.
-   */
-  export function unstable_cacheLife(profile: "weeks"): void;
-
-  /**
-   * Cache this `"use cache"` for a timespan defined by the `"max"` profile.
-   * ```
-   *   stale:      300 seconds (5 minutes)
-   *   revalidate: 2592000 seconds (30 days)
-   *   expire:     never
-   * ```
-   *
-   * This cache may be stale on clients for 5 minutes before checking with the server.
-   * If the server receives a new request after 30 days, start revalidating new values in the background.
-   * It lives for the maximum age of the server cache. If this entry has no traffic for a while, it may serve an old value the next request.
-   */
-  export function unstable_cacheLife(profile: "max"): void;
-
-  /**
-   * Cache this `"use cache"` using a custom timespan.
-   * ```
-   *   stale: ... // seconds
-   *   revalidate: ... // seconds
-   *   expire: ... // seconds
-   * ```
-   *
-   * This is similar to Cache-Control: max-age=`stale`,s-max-age=`revalidate`,stale-while-revalidate=`expire-revalidate`
-   *
-   * If a value is left out, the lowest of other cacheLife() calls or the default, is used instead.
-   */
-  export function unstable_cacheLife(profile: {
-    /**
-     * This cache may be stale on clients for ... seconds before checking with the server.
-     */
-    stale?: number;
-    /**
-     * If the server receives a new request after ... seconds, start revalidating new values in the background.
-     */
-    revalidate?: number;
-    /**
-     * If this entry has no traffic for ... seconds it will expire. The next request will recompute it.
-     */
-    expire?: number;
-  }): void;
-}

apps/next/types/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

e2e/examples/cloudflare-worker-agent/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @llamaindex/cloudflare-worker-agent-test
 
+## 0.0.106
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+
+## 0.0.105
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.0.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.0.101
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.0.100
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.0.99
 
 ### Patch Changes

e2e/examples/cloudflare-worker-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/cloudflare-worker-agent-test",
-  "version": "0.0.99",
+  "version": "0.0.106",
   "type": "module",
   "private": true,
   "scripts": {
@@ -14,10 +14,10 @@
   "devDependencies": {
     "@cloudflare/vitest-pool-workers": "^0.5.8",
     "@cloudflare/workers-types": "^4.20240924.0",
-    "@vitest/runner": "2.1.1",
-    "@vitest/snapshot": "2.1.1",
-    "typescript": "^5.6.2",
-    "vitest": "2.1.1",
+    "@vitest/runner": "2.1.4",
+    "@vitest/snapshot": "2.1.4",
+    "typescript": "^5.6.3",
+    "vitest": "2.1.4",
     "wrangler": "^3.78.8"
   },
   "dependencies": {

e2e/examples/llama-parse-browser/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @llamaindex/llama-parse-browser-test
 
+## 0.0.27
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.7
+
+## 0.0.26
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.6
+
+## 0.0.25
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.5
+
+## 0.0.24
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.4
+
+## 0.0.23
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.3
+
+## 0.0.22
+
+### Patch Changes
+
+- @llamaindex/cloud@2.0.2
+
 ## 0.0.21
 
 ### Patch Changes

e2e/examples/llama-parse-browser/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/llama-parse-browser-test",
   "private": true,
-  "version": "0.0.21",
+  "version": "0.0.27",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -9,7 +9,7 @@
     "preview": "vite preview"
   },
   "devDependencies": {
-    "typescript": "^5.5.3",
+    "typescript": "^5.6.3",
     "vite": "^5.4.1",
     "vite-plugin-wasm": "^3.3.0"
   },

e2e/examples/llama-parse-browser/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "target": "ES2020",
     "useDefineForClassFields": true,
@@ -20,7 +20,7 @@
   },
   "references": [
     {
-      "path": "../../../../cloud/tsconfig.json"
+      "path": "../../../packages/cloud/tsconfig.json"
     }
   ]
 }

e2e/examples/nextjs-agent/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @llamaindex/next-agent-test
 
+## 0.1.106
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+
+## 0.1.105
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.1.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.1.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.1.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.1.101
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.1.100
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.1.99
 
 ### Patch Changes

e2e/examples/nextjs-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-agent-test",
-  "version": "0.1.99",
+  "version": "0.1.106",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -10,18 +10,18 @@
   "dependencies": {
     "ai": "^3.3.21",
     "llamaindex": "workspace:*",
-    "next": "14.2.11",
+    "next": "15.0.2",
     "react": "18.3.1",
     "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.9.0",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
-    "eslint": "9.13.0",
+    "eslint": "9.14.0",
     "eslint-config-next": "15.0.2",
     "postcss": "^8.4.41",
     "tailwindcss": "^3.4.10",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   }
 }

e2e/examples/nextjs-agent/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,

e2e/examples/nextjs-edge-runtime/CHANGELOG.md

@@ -1,5 +1,56 @@
 # test-edge-runtime
 
+## 0.1.105
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+
+## 0.1.104
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.1.103
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.1.102
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.1.101
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.1.100
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.1.99
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.1.98
 
 ### Patch Changes

e2e/examples/nextjs-edge-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/nextjs-edge-runtime-test",
-  "version": "0.1.98",
+  "version": "0.1.105",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -9,14 +9,14 @@
   },
   "dependencies": {
     "llamaindex": "workspace:*",
-    "next": "14.2.11",
+    "next": "15.0.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.9.0",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   }
 }

e2e/examples/nextjs-node-runtime/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @llamaindex/next-node-runtime
 
+## 0.0.87
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+
+## 0.0.86
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.0.85
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.84
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.83
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.0.82
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.0.81
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.0.80
 
 ### Patch Changes

e2e/examples/nextjs-node-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-node-runtime-test",
-  "version": "0.0.80",
+  "version": "0.0.87",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -9,18 +9,18 @@
   },
   "dependencies": {
     "llamaindex": "workspace:*",
-    "next": "14.2.11",
+    "next": "15.0.2",
     "react": "18.3.1",
     "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.9.0",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
-    "eslint": "9.13.0",
+    "eslint": "9.14.0",
     "eslint-config-next": "15.0.2",
     "postcss": "^8.4.41",
     "tailwindcss": "^3.4.10",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   }
 }

e2e/examples/nextjs-node-runtime/src/actions/openai.ts

@@ -15,7 +15,6 @@ Settings.llm = new OpenAI({
 });
 Settings.embedModel = new HuggingFaceEmbedding({
   modelType: "BAAI/bge-small-en-v1.5",
-  quantized: false,
 });
 Settings.callbackManager.on("llm-tool-call", (event) => {
   console.log(event.detail);

e2e/examples/nextjs-node-runtime/src/utils/tokenizer.ts

@@ -1,5 +1,5 @@
 // test runtime
-import { Tokenizers, tokenizers } from "@llamaindex/env";
+import { Tokenizers, tokenizers } from "@llamaindex/env/tokenizers";
 import "llamaindex";
 
 // @ts-expect-error EdgeRuntime is not defined in type

e2e/examples/nextjs-node-runtime/tsconfig.json

@@ -1,5 +1,4 @@
 {
-  "extends": "../../../../../tsconfig.json",
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,

e2e/examples/waku-query-engine/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @llamaindex/waku-query-engine-test
 
+## 0.0.106
+
+### Patch Changes
+
+- Updated dependencies [f066e50]
+  - llamaindex@0.8.10
+
+## 0.0.105
+
+### Patch Changes
+
+- Updated dependencies [4fc001c]
+- Updated dependencies [4d4cd8a]
+  - llamaindex@0.8.9
+
+## 0.0.104
+
+### Patch Changes
+
+- Updated dependencies [ad85bd0]
+  - llamaindex@0.8.8
+
+## 0.0.103
+
+### Patch Changes
+
+- llamaindex@0.8.7
+
+## 0.0.102
+
+### Patch Changes
+
+- Updated dependencies [95a5cc6]
+  - llamaindex@0.8.6
+
+## 0.0.101
+
+### Patch Changes
+
+- Updated dependencies [14cc9eb]
+- Updated dependencies [a6db5dd]
+- Updated dependencies [396b1e1]
+  - llamaindex@0.8.5
+
+## 0.0.100
+
+### Patch Changes
+
+- Updated dependencies [35430d3]
+  - llamaindex@0.8.4
+
 ## 0.0.99
 
 ### Patch Changes

e2e/examples/waku-query-engine/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/waku-query-engine-test",
-  "version": "0.0.99",
+  "version": "0.0.106",
   "type": "module",
   "private": true,
   "scripts": {
@@ -16,10 +16,10 @@
     "waku": "0.21.4"
   },
   "devDependencies": {
-    "@types/react": "18.3.11",
+    "@types/react": "18.3.12",
     "@types/react-dom": "18.3.1",
     "autoprefixer": "^10.4.20",
     "tailwindcss": "^3.4.14",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   }
 }