Merge main into sweep/json-support_2

.changeset/beige-items-chew.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Breaking: allow documents to be reimported with hash checking.

.changeset/breezy-students-listen.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Update storage exports (thanks @TomPenguin)

.changeset/config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
   "changelog": "@changesets/cli/changelog",
-  "commit": true,
+  "commit": false,
   "fixed": [],
   "linked": [],
   "access": "public",

.changeset/silly-bugs-fold.md

@@ -1,5 +0,0 @@
----
-"create-llama": patch
----
-
-Added option to automatically install dependencies (for Python and TS)

.changeset/spotty-schools-thank.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Breaking: removed nodeId and docId. Just use id\_

.github/ISSUE_TEMPLATE/sweep-bugfix.yml

@@ -1,10 +1,11 @@
 name: Bugfix
-title: ""
-description: Write something like "We notice ... behavior when ... happens instead of ..." If you would like to use sweep.dev prefix with "Sweep:"
+title: 'Sweep: '
+description: Write something like "We notice ... behavior when ... happens instead of ...""
+labels: sweep
 body:
   - type: textarea
     id: description
     attributes:
       label: Details
       description: More details about the bug
-      placeholder: The bug might be in ... file
+      placeholder: The bug might be in ... file

.github/ISSUE_TEMPLATE/sweep-feature.yml

@@ -1,10 +1,11 @@
 name: Feature Request
-title: ""
-description: Write something like "Write an api endpoint that does "..." in the "..." file". If you would like to use sweep.dev prefix with "Sweep:"
+title: 'Sweep: '
+description: Write something like "Write an api endpoint that does "..." in the "..." file"
+labels: sweep
 body:
   - type: textarea
     id: description
     attributes:
       label: Details
-      description: More details
-      placeholder: The new endpoint should use the ... class from ... file because it contains ... logic
+      description: More details for Sweep
+      placeholder: The new endpoint should use the ... class from ... file because it contains ... logic

.github/ISSUE_TEMPLATE/sweep-refactor.yml

@@ -1,10 +1,11 @@
 name: Refactor
-title: ""
-description: Write something like "Modify the ... api endpoint to use ... version and ... framework" If you would like to use sweep.dev prefix with "Sweep:"
+title: 'Sweep: '
+description: Write something like "Modify the ... api endpoint to use ... version and ... framework"
+labels: sweep
 body:
   - type: textarea
     id: description
     attributes:
       label: Details
-      description: More details
-      placeholder: We are migrating this function to ... version because ...
+      description: More details for Sweep
+      placeholder: We are migrating this function to ... version because ...

.github/workflows/e2e.yml

@@ -1,59 +0,0 @@
-name: E2E Tests
-on:
-  push:
-    branches: [main]
-  pull_request:
-    paths:
-      - "packages/create-llama/**"
-      - ".github/workflows/e2e.yml"
-    branches: [main]
-
-env:
-  POETRY_VERSION: "1.6.1"
-
-jobs:
-  e2e:
-    name: create-llama
-    timeout-minutes: 60
-    strategy:
-      fail-fast: true
-      matrix:
-        node-version: [18, 20]
-        python-version: ["3.11"]
-        os: [macos-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: ${{ env.POETRY_VERSION }}
-      - uses: pnpm/action-setup@v2
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "pnpm"
-      - name: Install dependencies
-        run: pnpm install
-      - name: Install Playwright Browsers
-        run: pnpm exec playwright install --with-deps
-        working-directory: ./packages/create-llama
-      - name: Build create-llama
-        run: pnpm run build
-        working-directory: ./packages/create-llama
-      - name: Run Playwright tests
-        run: pnpm exec playwright test
-        env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        working-directory: ./packages/create-llama
-      - uses: actions/upload-artifact@v3
-        if: always()
-        with:
-          name: playwright-report
-          path: ./packages/create-llama/playwright-report/
-          retention-days: 30

.github/workflows/lint_on_push_or_pull.yml

@@ -12,16 +12,14 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "pnpm"
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
       - name: Install dependencies
         run: pnpm install
+
       - name: Run lint
-        run: pnpm run lint
-      - name: Run Prettier
-        run: pnpm run format
+        run: pnpm run lint

.github/workflows/test.yml

@@ -7,32 +7,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "pnpm"
-      - name: Install dependencies
-        run: pnpm install
-      - name: Run tests
-        run: pnpm run test
-  typecheck:
-    runs-on: ubuntu-latest
+    - name: Checkout code
+      uses: actions/checkout@v2
 
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: ".nvmrc"
-          cache: "pnpm"
-      - name: Install dependencies
-        run: pnpm install
-      - name: Build
-        run: pnpm run build
-        working-directory: ./packages/core
-      - name: Run Type Check
-        run: pnpm run type-check
+    - name: Setup Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '18'
+
+    - name: Install dependencies
+      run: |
+        npm i -g pnpm
+        pnpm install
+
+    - name: Run tests
+      run: pnpm run test

.gitignore

@@ -3,7 +3,6 @@
 # dependencies
 node_modules
 .pnp
-.pnpm-store
 .pnp.js
 
 # testing
@@ -37,16 +36,3 @@ yarn-error.log*
 .vercel
 
 dist/
-lib/
-
-# vs code
-.vscode/launch.json
-
-.cache
-test-results/
-playwright-report/
-blob-report/
-playwright/.cache/
-
-# intellij
-**/.idea

.husky/pre-commit

@@ -1,6 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-pnpm format
 pnpm lint
-npx lint-staged

.nvmrc

@@ -1 +0,0 @@
-18

.prettierignore

@@ -1,4 +0,0 @@
-apps/docs/i18n
-pnpm-lock.yaml
-lib/
-dist/

.vscode/settings.json

@@ -4,9 +4,5 @@
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "[xml]": {
     "editor.defaultFormatter": "redhat.vscode-xml"
-  },
-  "jest.rootPath": "./packages/core",
-  "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter"
   }
 }

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Right now there are two packages of importance:
 
 packages/core which is the main NPM library llamaindex
 
-examples is where the demo code lives
+apps/simple is where the demo code lives
 
 ### Turborepo docs
 
@@ -47,7 +47,7 @@ We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch
 
 ### 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 core package with a new demo, you need to run the build command in the README.
+There is an existing ["simple"](/apps/simple/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 core 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
 
@@ -56,7 +56,7 @@ You can create new demo applications in the apps folder. Just run pnpm init in t
 To install packages for a specific package or demo application, run
 
 ```
-pnpm add [NPM Package] --filter [package or application i.e. core or docs]
+pnpm add [NPM Package] --filter [package or application i.e. core or simple]
 ```
 
 To install packages for every package or application run

README.md

@@ -1,10 +1,5 @@
 # LlamaIndex.TS
 
-[![NPM Version](https://img.shields.io/npm/v/llamaindex)](https://www.npmjs.com/package/llamaindex)
-[![NPM License](https://img.shields.io/npm/l/llamaindex)](https://www.npmjs.com/package/llamaindex)
-[![NPM Downloads](https://img.shields.io/npm/dm/llamaindex)](https://www.npmjs.com/package/llamaindex)
-[![Discord](https://img.shields.io/discord/1059199217496772688)](https://discord.com/invite/eN6D2HQ4aX)
-
 LlamaIndex is a data framework for your LLM application.
 
 Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
@@ -17,7 +12,7 @@ LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you
 
 ## Getting started with an example:
 
-LlamaIndex.TS requires Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
+LlamaIndex.TS requries Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
 
 In a new folder:
 
@@ -25,7 +20,7 @@ In a new folder:
 export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
 pnpm init
 pnpm install typescript
-pnpm exec tsc --init # if needed
+pnpm exec tsc –-init # if needed
 pnpm install llamaindex
 pnpm install @types/node
 ```
@@ -41,7 +36,7 @@ async function main() {
   // Load essay from abramov.txt in Node
   const essay = await fs.readFile(
     "node_modules/llamaindex/examples/abramov.txt",
-    "utf-8",
+    "utf-8"
   );
 
   // Create Document object with essay
@@ -53,7 +48,7 @@ async function main() {
   // Query the index
   const queryEngine = index.asQueryEngine();
   const response = await queryEngine.query(
-    "What did the author do in college?",
+    "What did the author do in college?"
   );
 
   // Output response
@@ -66,7 +61,7 @@ main();
 Then you can run it using
 
 ```bash
-pnpx ts-node example.ts
+pnpm dlx ts-node example.ts
 ```
 
 ## Playground
@@ -89,38 +84,11 @@ Check out our NextJS playground at https://llama-playground.vercel.app/. The sou
 
 - [SimplePrompt](/packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
 
-## Note: NextJS:
-
-If you're using NextJS App Router, you'll need to use the NodeJS runtime (default) and add the following config to your next.config.js to have it use imports/exports in the same way Node does.
-
-```js
-export const runtime = "nodejs"; // default
-```
-
-```js
-// next.config.js
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  webpack: (config) => {
-    config.resolve.alias = {
-      ...config.resolve.alias,
-      sharp$: false,
-      "onnxruntime-node$": false,
-      mongodb$: false,
-    };
-    return config;
-  },
-};
-
-module.exports = nextConfig;
-```
-
 ## Supported LLMs:
 
 - OpenAI GPT-3.5-turbo and GPT-4
 - Anthropic Claude Instant and Claude 2
 - Llama2 Chat LLMs (70B, 13B, and 7B parameters)
-- MistralAI Chat LLMs
 
 ## Contributing:
 

apps/demo-edge-runtime/.env.example

@@ -1,3 +0,0 @@
-# Rename this file to `.env.local` to use environment variables locally with `next dev`
-# https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables
-MY_HOST="example.com"

apps/demo-edge-runtime/README.md

@@ -1,30 +0,0 @@
-This is a [LlamaIndex](https://www.llamaindex.ai/) project using [Next.js](https://nextjs.org/) bootstrapped with [`create-llama`](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/create-llama).
-
-## Getting Started
-
-First, install the dependencies:
-
-```
-npm install
-```
-
-Second, run the development server:
-
-```
-npm run dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about LlamaIndex, take a look at the following resources:
-
-- [LlamaIndex Documentation](https://docs.llamaindex.ai) - learn about LlamaIndex (Python features).
-- [LlamaIndexTS Documentation](https://ts.llamaindex.ai) - learn about LlamaIndex (Typescript features).
-
-You can check out [the LlamaIndexTS GitHub repository](https://github.com/run-llama/LlamaIndexTS) - your feedback and contributions are welcome!

apps/demo-edge-runtime/app/api/chat/engine/constants.mjs

@@ -1,4 +0,0 @@
-export const STORAGE_DIR = "./data";
-export const STORAGE_CACHE_DIR = "./cache";
-export const CHUNK_SIZE = 512;
-export const CHUNK_OVERLAP = 20;

apps/demo-edge-runtime/app/api/chat/engine/generate.mjs

@@ -1,53 +0,0 @@
-import {
-  serviceContextFromDefaults,
-  SimpleDirectoryReader,
-  storageContextFromDefaults,
-  VectorStoreIndex,
-} from "llamaindex";
-
-import * as dotenv from "dotenv";
-
-import {
-  CHUNK_OVERLAP,
-  CHUNK_SIZE,
-  STORAGE_CACHE_DIR,
-  STORAGE_DIR,
-} from "./constants.mjs";
-
-// Load environment variables from local .env file
-dotenv.config();
-
-async function getRuntime(func) {
-  const start = Date.now();
-  await func();
-  const end = Date.now();
-  return end - start;
-}
-
-async function generateDatasource(serviceContext) {
-  console.log(`Generating storage context...`);
-  // Split documents, create embeddings and store them in the storage context
-  const ms = await getRuntime(async () => {
-    const storageContext = await storageContextFromDefaults({
-      persistDir: STORAGE_CACHE_DIR,
-    });
-    const documents = await new SimpleDirectoryReader().loadData({
-      directoryPath: STORAGE_DIR,
-    });
-    await VectorStoreIndex.fromDocuments(documents, {
-      storageContext,
-      serviceContext,
-    });
-  });
-  console.log(`Storage context successfully generated in ${ms / 1000}s.`);
-}
-
-(async () => {
-  const serviceContext = serviceContextFromDefaults({
-    chunkSize: CHUNK_SIZE,
-    chunkOverlap: CHUNK_OVERLAP,
-  });
-
-  await generateDatasource(serviceContext);
-  console.log("Finished generating storage.");
-})();

apps/demo-edge-runtime/app/api/chat/engine/index.ts

@@ -1,59 +0,0 @@
-import {
-  ContextChatEngine,
-  LLM,
-  SimpleDocumentStore,
-  VectorStoreIndex,
-  genericFileSystem,
-  serviceContextFromDefaults,
-  storageContextFromDefaults,
-} from "llamaindex";
-import { CHUNK_OVERLAP, CHUNK_SIZE, STORAGE_CACHE_DIR } from "./constants.mjs";
-
-async function getDataSource(llm: LLM) {
-  const fs = genericFileSystem;
-  await fs.writeFile(
-    `${STORAGE_CACHE_DIR}/doc_store.json`,
-    JSON.stringify(await import("../../../../cache/doc_store.json")),
-  );
-  await fs.writeFile(
-    `${STORAGE_CACHE_DIR}/index_store.json`,
-    JSON.stringify(await import("../../../../cache/index_store.json")),
-  );
-  await fs.writeFile(
-    `${STORAGE_CACHE_DIR}/vector_store.json`,
-    JSON.stringify(await import("../../../../cache/vector_store.json")),
-  );
-
-  const serviceContext = serviceContextFromDefaults({
-    llm,
-    chunkSize: CHUNK_SIZE,
-    chunkOverlap: CHUNK_OVERLAP,
-  });
-  let storageContext = await storageContextFromDefaults({
-    persistDir: `${STORAGE_CACHE_DIR}`,
-  });
-
-  const numberOfDocs = Object.keys(
-    (storageContext.docStore as SimpleDocumentStore).toDict(),
-  ).length;
-  if (numberOfDocs === 0) {
-    throw new Error(
-      `StorageContext is empty - call 'npm run generate' to generate the storage first`,
-    );
-  }
-  return await VectorStoreIndex.init({
-    storageContext,
-    serviceContext,
-  });
-}
-
-export async function createChatEngine(llm: LLM) {
-  const index = await getDataSource(llm);
-  const retriever = index.asRetriever();
-  retriever.similarityTopK = 5;
-
-  return new ContextChatEngine({
-    chatModel: llm,
-    retriever,
-  });
-}

apps/demo-edge-runtime/app/api/chat/llamaindex-stream.ts

@@ -1,66 +0,0 @@
-import {
-  JSONValue,
-  createCallbacksTransformer,
-  createStreamDataTransformer,
-  experimental_StreamData,
-  trimStartOfStreamHelper,
-  type AIStreamCallbacksAndOptions,
-} from "ai";
-
-type ParserOptions = {
-  image_url?: string;
-};
-
-function createParser(
-  res: AsyncGenerator<any>,
-  data: experimental_StreamData,
-  opts?: ParserOptions,
-) {
-  const trimStartOfStream = trimStartOfStreamHelper();
-  return new ReadableStream<string>({
-    start() {
-      // if image_url is provided, send it via the data stream
-      if (opts?.image_url) {
-        const message: JSONValue = {
-          type: "image_url",
-          image_url: {
-            url: opts.image_url,
-          },
-        };
-        data.append(message);
-      } else {
-        data.append({}); // send an empty image response for the user's message
-      }
-    },
-    async pull(controller): Promise<void> {
-      const { value, done } = await res.next();
-      if (done) {
-        controller.close();
-        data.append({}); // send an empty image response for the assistant's message
-        data.close();
-        return;
-      }
-
-      const text = trimStartOfStream(value ?? "");
-      if (text) {
-        controller.enqueue(text);
-      }
-    },
-  });
-}
-
-export function LlamaIndexStream(
-  res: AsyncGenerator<any>,
-  opts?: {
-    callbacks?: AIStreamCallbacksAndOptions;
-    parserOptions?: ParserOptions;
-  },
-): { stream: ReadableStream; data: experimental_StreamData } {
-  const data = new experimental_StreamData();
-  return {
-    stream: createParser(res, data, opts?.parserOptions)
-      .pipeThrough(createCallbacksTransformer(opts?.callbacks))
-      .pipeThrough(createStreamDataTransformer(true)),
-    data,
-  };
-}

apps/demo-edge-runtime/app/api/chat/route.ts

@@ -1,82 +0,0 @@
-import { Message, StreamingTextResponse } from "ai";
-import { ChatMessage, MessageContent, OpenAI } from "llamaindex";
-import { NextRequest, NextResponse } from "next/server";
-import { createChatEngine } from "./engine";
-import { LlamaIndexStream } from "./llamaindex-stream";
-
-export const runtime = "edge";
-export const dynamic = "force-dynamic";
-
-const getLastMessageContent = (
-  textMessage: string,
-  imageUrl: string | undefined,
-): MessageContent => {
-  if (!imageUrl) return textMessage;
-  return [
-    {
-      type: "text",
-      text: textMessage,
-    },
-    {
-      type: "image_url",
-      image_url: {
-        url: imageUrl,
-      },
-    },
-  ];
-};
-
-export async function POST(request: NextRequest) {
-  try {
-    const body = await request.json();
-    const { messages, data }: { messages: Message[]; data: any } = body;
-    const lastMessage = messages.pop();
-    if (!messages || !lastMessage || lastMessage.role !== "user") {
-      return NextResponse.json(
-        {
-          error:
-            "messages are required in the request body and the last message must be from the user",
-        },
-        { status: 400 },
-      );
-    }
-
-    const llm = new OpenAI({
-      model: (process.env.MODEL as any) ?? "gpt-3.5-turbo",
-      maxTokens: 512,
-    });
-
-    const chatEngine = await createChatEngine(llm);
-
-    const lastMessageContent = getLastMessageContent(
-      lastMessage.content,
-      data?.imageUrl,
-    );
-
-    const response = await chatEngine.chat(
-      lastMessageContent as MessageContent,
-      messages as ChatMessage[],
-      true,
-    );
-
-    // Transform the response into a readable stream
-    const { stream, data: streamData } = LlamaIndexStream(response, {
-      parserOptions: {
-        image_url: data?.imageUrl,
-      },
-    });
-
-    // Return a StreamingTextResponse, which can be consumed by the client
-    return new StreamingTextResponse(stream, {}, streamData);
-  } catch (error) {
-    console.error("[LlamaIndex]", error);
-    return NextResponse.json(
-      {
-        error: (error as Error).message,
-      },
-      {
-        status: 500,
-      },
-    );
-  }
-}

apps/demo-edge-runtime/app/components/chat-section.tsx

@@ -1,46 +0,0 @@
-"use client";
-
-import { useChat } from "ai/react";
-import { useMemo } from "react";
-import { insertDataIntoMessages } from "./transform";
-import { ChatInput, ChatMessages } from "./ui/chat";
-
-export default function ChatSection() {
-  const {
-    messages,
-    input,
-    isLoading,
-    handleSubmit,
-    handleInputChange,
-    reload,
-    stop,
-    data,
-  } = useChat({
-    api: process.env.NEXT_PUBLIC_CHAT_API,
-    headers: {
-      "Content-Type": "application/json", // using JSON because of vercel/ai 2.2.26
-    },
-  });
-
-  const transformedMessages = useMemo(() => {
-    return insertDataIntoMessages(messages, data);
-  }, [messages, data]);
-
-  return (
-    <div className="space-y-4 max-w-5xl w-full">
-      <ChatMessages
-        messages={transformedMessages}
-        isLoading={isLoading}
-        reload={reload}
-        stop={stop}
-      />
-      <ChatInput
-        input={input}
-        handleSubmit={handleSubmit}
-        handleInputChange={handleInputChange}
-        isLoading={isLoading}
-        multiModal={process.env.NEXT_PUBLIC_MODEL === "gpt-4-vision-preview"}
-      />
-    </div>
-  );
-}

apps/demo-edge-runtime/app/components/header.tsx

@@ -1,28 +0,0 @@
-import Image from "next/image";
-
-export default function Header() {
-  return (
-    <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
-      <p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto  lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
-        Get started by editing&nbsp;
-        <code className="font-mono font-bold">app/page.tsx</code>
-      </p>
-      <div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
-        <a
-          href="https://www.llamaindex.ai/"
-          className="flex items-center justify-center font-nunito text-lg font-bold gap-2"
-        >
-          <span>Built by LlamaIndex</span>
-          <Image
-            className="rounded-xl"
-            src="/llama.png"
-            alt="Llama Logo"
-            width={40}
-            height={40}
-            priority
-          />
-        </a>
-      </div>
-    </div>
-  );
-}

apps/demo-edge-runtime/app/components/transform.ts

@@ -1,19 +0,0 @@
-import { JSONValue, Message } from "ai";
-
-export const isValidMessageData = (rawData: JSONValue | undefined) => {
-  if (!rawData || typeof rawData !== "object") return false;
-  if (Object.keys(rawData).length === 0) return false;
-  return true;
-};
-
-export const insertDataIntoMessages = (
-  messages: Message[],
-  data: JSONValue[] | undefined,
-) => {
-  if (!data) return messages;
-  messages.forEach((message, i) => {
-    const rawData = data[i];
-    if (isValidMessageData(rawData)) message.data = rawData;
-  });
-  return messages;
-};

apps/demo-edge-runtime/app/components/ui/chat/chat-avatar.tsx

@@ -1,34 +0,0 @@
-"use client";
-
-import Image from "next/image";
-import { Message } from "./chat-messages";
-
-export default function ChatAvatar(message: Message) {
-  if (message.role === "user") {
-    return (
-      <div className="flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border shadow bg-background">
-        <svg
-          xmlns="http://www.w3.org/2000/svg"
-          viewBox="0 0 256 256"
-          fill="currentColor"
-          className="h-4 w-4"
-        >
-          <path d="M230.92 212c-15.23-26.33-38.7-45.21-66.09-54.16a72 72 0 1 0-73.66 0c-27.39 8.94-50.86 27.82-66.09 54.16a8 8 0 1 0 13.85 8c18.84-32.56 52.14-52 89.07-52s70.23 19.44 89.07 52a8 8 0 1 0 13.85-8ZM72 96a56 56 0 1 1 56 56 56.06 56.06 0 0 1-56-56Z"></path>
-        </svg>
-      </div>
-    );
-  }
-
-  return (
-    <div className="flex h-8 w-8 shrink-0 select-none items-center justify-center rounded-md border  bg-black text-white">
-      <Image
-        className="rounded-md"
-        src="/llama.png"
-        alt="Llama Logo"
-        width={24}
-        height={24}
-        priority
-      />
-    </div>
-  );
-}

apps/demo-edge-runtime/app/components/ui/chat/chat-input.tsx

@@ -1,43 +0,0 @@
-"use client";
-
-export interface ChatInputProps {
-  /** The current value of the input */
-  input?: string;
-  /** An input/textarea-ready onChange handler to control the value of the input */
-  handleInputChange?: (
-    e:
-      | React.ChangeEvent<HTMLInputElement>
-      | React.ChangeEvent<HTMLTextAreaElement>,
-  ) => void;
-  /** Form submission handler to automatically reset input and append a user message  */
-  handleSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
-  isLoading: boolean;
-  multiModal?: boolean;
-}
-
-export default function ChatInput(props: ChatInputProps) {
-  return (
-    <>
-      <form
-        onSubmit={props.handleSubmit}
-        className="flex items-start justify-between w-full max-w-5xl p-4 bg-white rounded-xl shadow-xl gap-4"
-      >
-        <input
-          autoFocus
-          name="message"
-          placeholder="Type a message"
-          className="w-full p-4 rounded-xl shadow-inner flex-1"
-          value={props.input}
-          onChange={props.handleInputChange}
-        />
-        <button
-          disabled={props.isLoading}
-          type="submit"
-          className="p-4 text-white rounded-xl shadow-xl bg-gradient-to-r from-cyan-500 to-sky-500 disabled:opacity-50 disabled:cursor-not-allowed"
-        >
-          Send message
-        </button>
-      </form>
-    </>
-  );
-}

apps/demo-edge-runtime/app/components/ui/chat/chat-item.tsx

@@ -1,13 +0,0 @@
-"use client";
-
-import ChatAvatar from "./chat-avatar";
-import { Message } from "./chat-messages";
-
-export default function ChatItem(message: Message) {
-  return (
-    <div className="flex items-start gap-4 pt-5">
-      <ChatAvatar {...message} />
-      <p className="break-words">{message.content}</p>
-    </div>
-  );
-}

apps/demo-edge-runtime/app/components/ui/chat/chat-messages.tsx

@@ -1,48 +0,0 @@
-"use client";
-
-import { useEffect, useRef } from "react";
-import ChatItem from "./chat-item";
-
-export interface Message {
-  id: string;
-  content: string;
-  role: string;
-}
-
-export default function ChatMessages({
-  messages,
-  isLoading,
-  reload,
-  stop,
-}: {
-  messages: Message[];
-  isLoading?: boolean;
-  stop?: () => void;
-  reload?: () => void;
-}) {
-  const scrollableChatContainerRef = useRef<HTMLDivElement>(null);
-
-  const scrollToBottom = () => {
-    if (scrollableChatContainerRef.current) {
-      scrollableChatContainerRef.current.scrollTop =
-        scrollableChatContainerRef.current.scrollHeight;
-    }
-  };
-
-  useEffect(() => {
-    scrollToBottom();
-  }, [messages.length]);
-
-  return (
-    <div className="w-full max-w-5xl p-4 bg-white rounded-xl shadow-xl">
-      <div
-        className="flex flex-col gap-5 divide-y h-[50vh] overflow-auto"
-        ref={scrollableChatContainerRef}
-      >
-        {messages.map((m: Message) => (
-          <ChatItem key={m.id} {...m} />
-        ))}
-      </div>
-    </div>
-  );
-}

apps/demo-edge-runtime/app/components/ui/chat/index.ts

@@ -1,6 +0,0 @@
-import ChatInput from "./chat-input";
-import ChatMessages from "./chat-messages";
-
-export type { ChatInputProps } from "./chat-input";
-export type { Message } from "./chat-messages";
-export { ChatInput, ChatMessages };

apps/demo-edge-runtime/app/globals.css

@@ -1,94 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-@layer base {
-  :root {
-    --background: 0 0% 100%;
-    --foreground: 222.2 47.4% 11.2%;
-
-    --muted: 210 40% 96.1%;
-    --muted-foreground: 215.4 16.3% 46.9%;
-
-    --popover: 0 0% 100%;
-    --popover-foreground: 222.2 47.4% 11.2%;
-
-    --border: 214.3 31.8% 91.4%;
-    --input: 214.3 31.8% 91.4%;
-
-    --card: 0 0% 100%;
-    --card-foreground: 222.2 47.4% 11.2%;
-
-    --primary: 222.2 47.4% 11.2%;
-    --primary-foreground: 210 40% 98%;
-
-    --secondary: 210 40% 96.1%;
-    --secondary-foreground: 222.2 47.4% 11.2%;
-
-    --accent: 210 40% 96.1%;
-    --accent-foreground: 222.2 47.4% 11.2%;
-
-    --destructive: 0 100% 50%;
-    --destructive-foreground: 210 40% 98%;
-
-    --ring: 215 20.2% 65.1%;
-
-    --radius: 0.5rem;
-  }
-
-  .dark {
-    --background: 224 71% 4%;
-    --foreground: 213 31% 91%;
-
-    --muted: 223 47% 11%;
-    --muted-foreground: 215.4 16.3% 56.9%;
-
-    --accent: 216 34% 17%;
-    --accent-foreground: 210 40% 98%;
-
-    --popover: 224 71% 4%;
-    --popover-foreground: 215 20.2% 65.1%;
-
-    --border: 216 34% 17%;
-    --input: 216 34% 17%;
-
-    --card: 224 71% 4%;
-    --card-foreground: 213 31% 91%;
-
-    --primary: 210 40% 98%;
-    --primary-foreground: 222.2 47.4% 1.2%;
-
-    --secondary: 222.2 47.4% 11.2%;
-    --secondary-foreground: 210 40% 98%;
-
-    --destructive: 0 63% 31%;
-    --destructive-foreground: 210 40% 98%;
-
-    --ring: 216 34% 17%;
-
-    --radius: 0.5rem;
-  }
-}
-
-@layer base {
-  * {
-    @apply border-border;
-  }
-  body {
-    @apply bg-background text-foreground;
-    font-feature-settings:
-      "rlig" 1,
-      "calt" 1;
-  }
-  .background-gradient {
-    background-color: #fff;
-    background-image: radial-gradient(
-        at 21% 11%,
-        rgba(186, 186, 233, 0.53) 0,
-        transparent 50%
-      ),
-      radial-gradient(at 85% 0, hsla(46, 57%, 78%, 0.52) 0, transparent 50%),
-      radial-gradient(at 91% 36%, rgba(194, 213, 255, 0.68) 0, transparent 50%),
-      radial-gradient(at 8% 40%, rgba(251, 218, 239, 0.46) 0, transparent 50%);
-  }
-}

apps/demo-edge-runtime/app/layout.tsx

@@ -1,22 +0,0 @@
-import type { Metadata } from "next";
-import { Inter } from "next/font/google";
-import "./globals.css";
-
-const inter = Inter({ subsets: ["latin"] });
-
-export const metadata: Metadata = {
-  title: "Create Llama App",
-  description: "Generated by create-llama",
-};
-
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode;
-}) {
-  return (
-    <html lang="en">
-      <body className={inter.className}>{children}</body>
-    </html>
-  );
-}

apps/demo-edge-runtime/app/page.tsx

@@ -1,11 +0,0 @@
-import Header from "@/app/components/header";
-import ChatSection from "./components/chat-section";
-
-export default function Home() {
-  return (
-    <main className="flex min-h-screen flex-col items-center gap-10 p-24 background-gradient">
-      <Header />
-      <ChatSection />
-    </main>
-  );
-}

apps/demo-edge-runtime/next-env.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="next" />
-/// <reference types="next/image-types/global" />
-
-// NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.

apps/demo-edge-runtime/next.config.js

@@ -1,4 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {};
-
-module.exports = nextConfig;

apps/demo-edge-runtime/package.json

@@ -1,32 +0,0 @@
-{
-  "name": "demo-edge-runtime",
-  "version": "0.1.0",
-  "scripts": {
-    "dev": "next dev",
-    "build": "next build",
-    "start": "next start",
-    "lint": "next lint",
-    "generate": "node app/api/chat/engine/generate.mjs"
-  },
-  "dependencies": {
-    "ai": "^2.2.27",
-    "dotenv": "^16.3.1",
-    "llamaindex": "0.0.46",
-    "next": "^14.0.4",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "supports-color": "^9.4.0"
-  },
-  "devDependencies": {
-    "@types/node": "^20.10.3",
-    "@types/react": "^18.2.42",
-    "@types/react-dom": "^18.2.17",
-    "autoprefixer": "^10.4.16",
-    "eslint": "^8.55.0",
-    "eslint-config-next": "^14.0.3",
-    "postcss": "^8.4.32",
-    "tailwindcss": "^3.3.6",
-    "typescript": "^5.3.2",
-    "cross-env": "^7.0.3"
-  }
-}

apps/demo-edge-runtime/postcss.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-  plugins: {
-    tailwindcss: {},
-    autoprefixer: {},
-  },
-};

apps/demo-edge-runtime/tailwind.config.ts

@@ -1,78 +0,0 @@
-import type { Config } from "tailwindcss";
-import { fontFamily } from "tailwindcss/defaultTheme";
-
-const config: Config = {
-  darkMode: ["class"],
-  content: ["app/**/*.{ts,tsx}", "components/**/*.{ts,tsx}"],
-  theme: {
-    container: {
-      center: true,
-      padding: "2rem",
-      screens: {
-        "2xl": "1400px",
-      },
-    },
-    extend: {
-      colors: {
-        border: "hsl(var(--border))",
-        input: "hsl(var(--input))",
-        ring: "hsl(var(--ring))",
-        background: "hsl(var(--background))",
-        foreground: "hsl(var(--foreground))",
-        primary: {
-          DEFAULT: "hsl(var(--primary))",
-          foreground: "hsl(var(--primary-foreground))",
-        },
-        secondary: {
-          DEFAULT: "hsl(var(--secondary))",
-          foreground: "hsl(var(--secondary-foreground))",
-        },
-        destructive: {
-          DEFAULT: "hsl(var(--destructive) / <alpha-value>)",
-          foreground: "hsl(var(--destructive-foreground) / <alpha-value>)",
-        },
-        muted: {
-          DEFAULT: "hsl(var(--muted))",
-          foreground: "hsl(var(--muted-foreground))",
-        },
-        accent: {
-          DEFAULT: "hsl(var(--accent))",
-          foreground: "hsl(var(--accent-foreground))",
-        },
-        popover: {
-          DEFAULT: "hsl(var(--popover))",
-          foreground: "hsl(var(--popover-foreground))",
-        },
-        card: {
-          DEFAULT: "hsl(var(--card))",
-          foreground: "hsl(var(--card-foreground))",
-        },
-      },
-      borderRadius: {
-        xl: `calc(var(--radius) + 4px)`,
-        lg: `var(--radius)`,
-        md: `calc(var(--radius) - 2px)`,
-        sm: "calc(var(--radius) - 4px)",
-      },
-      fontFamily: {
-        sans: ["var(--font-sans)", ...fontFamily.sans],
-      },
-      keyframes: {
-        "accordion-down": {
-          from: { height: "0" },
-          to: { height: "var(--radix-accordion-content-height)" },
-        },
-        "accordion-up": {
-          from: { height: "var(--radix-accordion-content-height)" },
-          to: { height: "0" },
-        },
-      },
-      animation: {
-        "accordion-down": "accordion-down 0.2s ease-out",
-        "accordion-up": "accordion-up 0.2s ease-out",
-      },
-    },
-  },
-  plugins: [],
-};
-export default config;

apps/demo-edge-runtime/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "incremental": true,
-    "plugins": [
-      {
-        "name": "next"
-      }
-    ],
-    "paths": {
-      "@/*": ["./*"]
-    },
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
-}

apps/docs/.gitignore

@@ -7,7 +7,6 @@
 # Generated files
 .docusaurus
 .cache-loader
-lib
 
 # Misc
 .DS_Store

apps/docs/babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
 };

apps/docs/docs/.gitignore

@@ -1 +0,0 @@
-api/

apps/docs/docs/api/classes/Anthropic.md

@@ -0,0 +1,193 @@
+---
+id: "Anthropic"
+title: "Class: Anthropic"
+sidebar_label: "Anthropic"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Anthropic LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new Anthropic**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`Anthropic`](Anthropic.md)\> |
+
+#### Defined in
+
+[llm/LLM.ts:449](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L449)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[llm/LLM.ts:442](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L442)
+
+___
+
+### callbackManager
+
+• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
+
+#### Defined in
+
+[llm/LLM.ts:447](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L447)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:443](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L443)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:439](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L439)
+
+___
+
+### model
+
+• **model**: `string`
+
+#### Defined in
+
+[llm/LLM.ts:436](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L436)
+
+___
+
+### session
+
+• **session**: `AnthropicSession`
+
+#### Defined in
+
+[llm/LLM.ts:445](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L445)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:437](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L437)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:444](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L444)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:438](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L438)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:484](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L484)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:502](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L502)
+
+___
+
+### mapMessagesToPrompt
+
+▸ **mapMessagesToPrompt**(`messages`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:469](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L469)

apps/docs/docs/api/classes/BaseEmbedding.md

@@ -0,0 +1,81 @@
+---
+id: "BaseEmbedding"
+title: "Class: BaseEmbedding"
+sidebar_label: "BaseEmbedding"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- **`BaseEmbedding`**
+
+  ↳ [`OpenAIEmbedding`](OpenAIEmbedding.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseEmbedding**()
+
+## Methods
+
+### getQueryEmbedding
+
+▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L213)
+
+___
+
+### getTextEmbedding
+
+▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L212)
+
+___
+
+### similarity
+
+▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `embedding1` | `number`[] | `undefined` |
+| `embedding2` | `number`[] | `undefined` |
+| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[Embedding.ts:204](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L204)

apps/docs/docs/api/classes/BaseIndex.md

@@ -0,0 +1,216 @@
+---
+id: "BaseIndex"
+title: "Class: BaseIndex<T>"
+sidebar_label: "BaseIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Indexes are the data structure that we store our nodes and embeddings in so
+they can be retrieved for our queries.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Hierarchy
+
+- **`BaseIndex`**
+
+  ↳ [`ListIndex`](ListIndex.md)
+
+  ↳ [`VectorStoreIndex`](VectorStoreIndex.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseIndex**<`T`\>(`init`)
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<`T`\> |
+
+#### Defined in
+
+[indices/BaseIndex.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L130)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Defined in
+
+[indices/BaseIndex.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L127)
+
+___
+
+### indexStruct
+
+• **indexStruct**: `T`
+
+#### Defined in
+
+[indices/BaseIndex.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L128)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L123)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### vectorStore
+
+• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L126)
+
+## Methods
+
+### asQueryEngine
+
+▸ `Abstract` **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L150)
+
+___
+
+### asRetriever
+
+▸ `Abstract` **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `any` |
+
+#### Returns
+
+[`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[indices/BaseIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L143)
+
+___
+
+### deleteRefDoc
+
+▸ `Abstract` **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+| `deleteFromDocStore?` | `boolean` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[indices/BaseIndex.ts:168](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L168)
+
+___
+
+### insert
+
+▸ **insert**(`document`): `Promise`<`void`\>
+
+Insert a document into the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `document` | [`Document`](Document.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L159)
+
+___
+
+### insertNodes
+
+▸ `Abstract` **insertNodes**(`nodes`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[indices/BaseIndex.ts:167](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L167)

apps/docs/docs/api/classes/BaseNode.md

@@ -0,0 +1,308 @@
+---
+id: "BaseNode"
+title: "Class: BaseNode"
+sidebar_label: "BaseNode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Generic abstract class for retrievable nodes
+
+## Hierarchy
+
+- **`BaseNode`**
+
+  ↳ [`TextNode`](TextNode.md)
+
+## Constructors
+
+### constructor
+
+• **new BaseNode**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`BaseNode`](BaseNode.md)\> |
+
+#### Defined in
+
+[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L55)
+
+## Properties
+
+### embedding
+
+• `Optional` **embedding**: `number`[]
+
+#### Defined in
+
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
+
+___
+
+### excludedEmbedMetadataKeys
+
+• **excludedEmbedMetadataKeys**: `string`[] = `[]`
+
+#### Defined in
+
+[Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L50)
+
+___
+
+### excludedLlmMetadataKeys
+
+• **excludedLlmMetadataKeys**: `string`[] = `[]`
+
+#### Defined in
+
+[Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L51)
+
+___
+
+### hash
+
+• **hash**: `string` = `""`
+
+#### Defined in
+
+[Node.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L53)
+
+___
+
+### id\_
+
+• **id\_**: `string`
+
+The unique ID of the Node/Document. The trailing underscore is here
+to avoid collisions with the id keyword in Python.
+
+Set to a UUID by default.
+
+#### Defined in
+
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `any`\> = `{}`
+
+#### Defined in
+
+[Node.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L49)
+
+___
+
+### relationships
+
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
+
+#### Defined in
+
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L52)
+
+## Accessors
+
+### childNodes
+
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
+
+#### Defined in
+
+[Node.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L107)
+
+___
+
+### nextNode
+
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L87)
+
+___
+
+### parentNode
+
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L97)
+
+___
+
+### prevNode
+
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L75)
+
+___
+
+### sourceNode
+
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L65)
+
+## Methods
+
+### asRelatedNodeInfo
+
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Returns
+
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
+
+#### Defined in
+
+[Node.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L129)
+
+___
+
+### generateHash
+
+▸ `Abstract` **generateHash**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L119)
+
+___
+
+### getContent
+
+▸ `Abstract` **getContent**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L61)
+
+___
+
+### getEmbedding
+
+▸ **getEmbedding**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+#### Defined in
+
+[Node.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L121)
+
+___
+
+### getMetadataStr
+
+▸ `Abstract` **getMetadataStr**(`metadataMode`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L62)
+
+___
+
+### getType
+
+▸ `Abstract` **getType**(): [`ObjectType`](../enums/ObjectType.md)
+
+#### Returns
+
+[`ObjectType`](../enums/ObjectType.md)
+
+#### Defined in
+
+[Node.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L59)
+
+___
+
+### setContent
+
+▸ `Abstract` **setContent**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `any` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Node.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L63)
+
+___
+
+### toJSON
+
+▸ **toJSON**(): `Record`<`string`, `any`\>
+
+Used with built in JSON.stringify
+
+#### Returns
+
+`Record`<`string`, `any`\>
+
+#### Defined in
+
+[Node.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L141)

apps/docs/docs/api/classes/CallbackManager.md

@@ -18,13 +18,13 @@ custom_edit_url: null
 
 #### Parameters
 
-| Name        | Type                     |
-| :---------- | :----------------------- |
+| Name | Type |
+| :------ | :------ |
 | `handlers?` | `CallbackManagerMethods` |
 
 #### Defined in
 
-[packages/core/src/callbacks/CallbackManager.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L86)
+[callbacks/CallbackManager.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L67)
 
 ## Properties
 
@@ -38,8 +38,8 @@ custom_edit_url: null
 
 ##### Parameters
 
-| Name     | Type                                                                |
-| :------- | :------------------------------------------------------------------ |
+| Name | Type |
+| :------ | :------ |
 | `params` | [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md) |
 
 ##### Returns
@@ -52,9 +52,9 @@ CallbackManagerMethods.onLLMStream
 
 #### Defined in
 
-[packages/core/src/callbacks/CallbackManager.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L83)
+[callbacks/CallbackManager.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L64)
 
----
+___
 
 ### onRetrieve
 
@@ -66,8 +66,8 @@ CallbackManagerMethods.onLLMStream
 
 ##### Parameters
 
-| Name     | Type                                                                      |
-| :------- | :------------------------------------------------------------------------ |
+| Name | Type |
+| :------ | :------ |
 | `params` | [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md) |
 
 ##### Returns
@@ -80,4 +80,4 @@ CallbackManagerMethods.onRetrieve
 
 #### Defined in
 
-[packages/core/src/callbacks/CallbackManager.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L84)
+[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/callbacks/CallbackManager.ts#L65)

apps/docs/docs/api/classes/CompactAndRefine.md

@@ -0,0 +1,106 @@
+---
+id: "CompactAndRefine"
+title: "Class: CompactAndRefine"
+sidebar_label: "CompactAndRefine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
+
+## Hierarchy
+
+- [`Refine`](Refine.md)
+
+  ↳ **`CompactAndRefine`**
+
+## Constructors
+
+### constructor
+
+• **new CompactAndRefine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `textQATemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `refineTemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+
+#### Inherited from
+
+[Refine](Refine.md).[constructor](Refine.md#constructor)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L78)
+
+## Properties
+
+### refineTemplate
+
+• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Inherited from
+
+[Refine](Refine.md).[refineTemplate](Refine.md#refinetemplate)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L76)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[Refine](Refine.md).[serviceContext](Refine.md#servicecontext)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L74)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Inherited from
+
+[Refine](Refine.md).[textQATemplate](Refine.md#textqatemplate)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L75)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+| `prevResponse?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Overrides
+
+[Refine](Refine.md).[getResponse](Refine.md#getresponse)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L181)

apps/docs/docs/api/classes/CondenseQuestionChatEngine.md

@@ -0,0 +1,148 @@
+---
+id: "CondenseQuestionChatEngine"
+title: "Class: CondenseQuestionChatEngine"
+sidebar_label: "CondenseQuestionChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex).
+It does two steps on taking a user's chat message: first, it condenses the chat message
+with the previous chat history into a question with more context.
+Then, it queries the underlying Index using the new question with context and returns
+the response.
+CondenseQuestionChatEngine performs well when the input is primarily questions about the
+underlying data. It performs less well when the chat messages are not questions about the
+data, or are very referential to previous context.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new CondenseQuestionChatEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `init.condenseMessagePrompt?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `init.queryEngine` | [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) |
+| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ChatEngine.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L75)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L71)
+
+___
+
+### condenseMessagePrompt
+
+• **condenseMessagePrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L73)
+
+___
+
+### queryEngine
+
+• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Defined in
+
+[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L70)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L72)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L100)
+
+___
+
+### condenseQuestion
+
+▸ `Private` **condenseQuestion**(`chatHistory`, `question`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `question` | `string` |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Defined in
+
+[ChatEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L89)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L118)

apps/docs/docs/api/classes/ContextChatEngine.md

@@ -0,0 +1,111 @@
+---
+id: "ContextChatEngine"
+title: "Class: ContextChatEngine"
+sidebar_label: "ContextChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+ContextChatEngine uses the Index to get the appropriate context for each query.
+The context is stored in the system prompt, and the chat history is preserved,
+ideally allowing the appropriate context to be surfaced for each query.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new ContextChatEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `init.chatModel?` | [`OpenAI`](OpenAI.md) |
+| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
+
+#### Defined in
+
+[ChatEngine.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L133)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L131)
+
+___
+
+### chatModel
+
+• **chatModel**: [`OpenAI`](OpenAI.md)
+
+#### Defined in
+
+[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L130)
+
+___
+
+### retriever
+
+• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L129)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L144)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:182](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L182)

apps/docs/docs/api/classes/Document.md

@@ -1,6 +1,6 @@
 ---
 id: "Document"
-title: "Class: Document<T>"
+title: "Class: Document"
 sidebar_label: "Document"
 sidebar_position: 0
 custom_edit_url: null
@@ -8,15 +8,9 @@ custom_edit_url: null
 
 A document is just a special text node with a docId.
 
-## Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
-
 ## Hierarchy
 
-- [`TextNode`](TextNode.md)<`T`\>
+- [`TextNode`](TextNode.md)
 
   ↳ **`Document`**
 
@@ -24,19 +18,13 @@ A document is just a special text node with a docId.
 
 ### constructor
 
-• **new Document**<`T`\>(`init?`)
-
-#### Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
+• **new Document**(`init?`)
 
 #### Parameters
 
-| Name    | Type                                        |
-| :------ | :------------------------------------------ |
-| `init?` | `Partial`<[`Document`](Document.md)<`T`\>\> |
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`Document`](Document.md)\> |
 
 #### Overrides
 
@@ -44,7 +32,7 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:254](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L254)
+[Node.ts:257](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L257)
 
 ## Properties
 
@@ -58,9 +46,9 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L51)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
 
----
+___
 
 ### endCharIdx
 
@@ -72,9 +60,9 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L157)
+[Node.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L152)
 
----
+___
 
 ### excludedEmbedMetadataKeys
 
@@ -86,9 +74,9 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L55)
+[Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L50)
 
----
+___
 
 ### excludedLlmMetadataKeys
 
@@ -100,9 +88,9 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L56)
+[Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L51)
 
----
+___
 
 ### hash
 
@@ -114,9 +102,9 @@ A document is just a special text node with a docId.
 
 #### Defined in
 
-[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L58)
+[Node.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L53)
 
----
+___
 
 ### id\_
 
@@ -129,17 +117,17 @@ Set to a UUID by default.
 
 #### Inherited from
 
-[TextNode](TextNode.md).[id\_](TextNode.md#id_)
+[TextNode](TextNode.md).[id_](TextNode.md#id_)
 
 #### Defined in
 
-[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L50)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
 
----
+___
 
 ### metadata
 
-• **metadata**: `T`
+• **metadata**: `Record`<`string`, `any`\> = `{}`
 
 #### Inherited from
 
@@ -147,9 +135,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L54)
+[Node.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L49)
 
----
+___
 
 ### metadataSeparator
 
@@ -161,13 +149,13 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L160)
+[Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L155)
 
----
+___
 
 ### relationships
 
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}`
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
 
 #### Inherited from
 
@@ -175,9 +163,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L57)
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L52)
 
----
+___
 
 ### startCharIdx
 
@@ -189,9 +177,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L156)
+[Node.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L151)
 
----
+___
 
 ### text
 
@@ -203,17 +191,17 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L155)
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
 
 ## Accessors
 
 ### childNodes
 
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Inherited from
 
@@ -221,17 +209,17 @@ TextNode.childNodes
 
 #### Defined in
 
-[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L112)
+[Node.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L107)
 
----
+___
 
 ### nextNode
 
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -239,17 +227,17 @@ TextNode.nextNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L92)
+[Node.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L87)
 
----
+___
 
 ### parentNode
 
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -257,17 +245,17 @@ TextNode.parentNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L102)
+[Node.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L97)
 
----
+___
 
 ### prevNode
 
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -275,17 +263,17 @@ TextNode.prevNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L80)
+[Node.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L75)
 
----
+___
 
 ### sourceNode
 
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -293,17 +281,17 @@ TextNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L70)
+[Node.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L65)
 
 ## Methods
 
 ### asRelatedNodeInfo
 
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -311,9 +299,9 @@ TextNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L134)
+[Node.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L129)
 
----
+___
 
 ### generateHash
 
@@ -332,9 +320,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L178)
+[Node.ts:173](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L173)
 
----
+___
 
 ### getContent
 
@@ -342,8 +330,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       | Default value       |
-| :------------- | :----------------------------------------- | :------------------ |
+| Name | Type | Default value |
+| :------ | :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
 
 #### Returns
@@ -356,9 +344,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L192)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L187)
 
----
+___
 
 ### getEmbedding
 
@@ -374,9 +362,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L126)
+[Node.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L121)
 
----
+___
 
 ### getMetadataStr
 
@@ -384,8 +372,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       |
-| :------------- | :----------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
 
 #### Returns
@@ -398,9 +386,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L197)
+[Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L192)
 
----
+___
 
 ### getNodeInfo
 
@@ -410,9 +398,9 @@ The ID is not part of the hash as it can change independent of content.
 
 `Object`
 
-| Name    | Type                    |
-| :------ | :---------------------- |
-| `end`   | `undefined` \| `number` |
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
 | `start` | `undefined` \| `number` |
 
 #### Inherited from
@@ -421,9 +409,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L224)
+[Node.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L219)
 
----
+___
 
 ### getText
 
@@ -439,9 +427,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L228)
+[Node.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L223)
 
----
+___
 
 ### getType
 
@@ -457,9 +445,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:263](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L263)
+[Node.ts:266](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L266)
 
----
+___
 
 ### setContent
 
@@ -467,8 +455,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name    | Type     |
-| :------ | :------- |
+| Name | Type |
+| :------ | :------ |
 | `value` | `string` |
 
 #### Returns
@@ -481,9 +469,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L218)
+[Node.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L213)
 
----
+___
 
 ### toJSON
 
@@ -501,4 +489,4 @@ Used with built in JSON.stringify
 
 #### Defined in
 
-[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/f0be933/packages/core/src/Node.ts#L146)
+[Node.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L141)

apps/docs/docs/api/classes/InMemoryFileSystem.md

@@ -26,7 +26,7 @@ A filesystem implementation that stores files in memory.
 
 #### Defined in
 
-[packages/core/src/storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L25)
+[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L25)
 
 ## Methods
 
@@ -36,8 +36,8 @@ A filesystem implementation that stores files in memory.
 
 #### Parameters
 
-| Name   | Type     |
-| :----- | :------- |
+| Name | Type |
+| :------ | :------ |
 | `path` | `string` |
 
 #### Returns
@@ -50,9 +50,9 @@ A filesystem implementation that stores files in memory.
 
 #### Defined in
 
-[packages/core/src/storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L38)
+[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L38)
 
----
+___
 
 ### mkdir
 
@@ -60,10 +60,10 @@ A filesystem implementation that stores files in memory.
 
 #### Parameters
 
-| Name       | Type     |
-| :--------- | :------- |
-| `path`     | `string` |
-| `options?` | `any`    |
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
 
 #### Returns
 
@@ -75,9 +75,9 @@ A filesystem implementation that stores files in memory.
 
 #### Defined in
 
-[packages/core/src/storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L44)
+[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L44)
 
----
+___
 
 ### readFile
 
@@ -85,10 +85,10 @@ A filesystem implementation that stores files in memory.
 
 #### Parameters
 
-| Name       | Type     |
-| :--------- | :------- |
-| `path`     | `string` |
-| `options?` | `any`    |
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `any` |
 
 #### Returns
 
@@ -100,9 +100,9 @@ A filesystem implementation that stores files in memory.
 
 #### Defined in
 
-[packages/core/src/storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L31)
+[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L31)
 
----
+___
 
 ### writeFile
 
@@ -110,11 +110,11 @@ A filesystem implementation that stores files in memory.
 
 #### Parameters
 
-| Name       | Type     |
-| :--------- | :------- |
-| `path`     | `string` |
-| `content`  | `string` |
-| `options?` | `any`    |
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `content` | `string` |
+| `options?` | `any` |
 
 #### Returns
 
@@ -126,4 +126,4 @@ A filesystem implementation that stores files in memory.
 
 #### Defined in
 
-[packages/core/src/storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L27)
+[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/FileSystem.ts#L27)

apps/docs/docs/api/classes/IndexDict.md

@@ -0,0 +1,161 @@
+---
+id: "IndexDict"
+title: "Class: IndexDict"
+sidebar_label: "IndexDict"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- [`IndexStruct`](IndexStruct.md)
+
+  ↳ **`IndexDict`**
+
+## Constructors
+
+### constructor
+
+• **new IndexDict**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor)
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### indexId
+
+• **indexId**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### nodesDict
+
+• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)\> = `{}`
+
+#### Defined in
+
+[indices/BaseIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L45)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+___
+
+### type
+
+• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.SIMPLE_DICT`
+
+#### Defined in
+
+[indices/BaseIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L46)
+
+## Methods
+
+### addNode
+
+▸ **addNode**(`node`, `textId?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `node` | [`BaseNode`](BaseNode.md) |
+| `textId?` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/BaseIndex.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L55)
+
+___
+
+### delete
+
+▸ **delete**(`nodeId`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodeId` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/BaseIndex.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L68)
+
+___
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L48)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
+
+#### Defined in
+
+[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L60)

apps/docs/docs/api/classes/IndexList.md

@@ -0,0 +1,140 @@
+---
+id: "IndexList"
+title: "Class: IndexList"
+sidebar_label: "IndexList"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- [`IndexStruct`](IndexStruct.md)
+
+  ↳ **`IndexList`**
+
+## Constructors
+
+### constructor
+
+• **new IndexList**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor)
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### indexId
+
+• **indexId**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### nodes
+
+• **nodes**: `string`[] = `[]`
+
+#### Defined in
+
+[indices/BaseIndex.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L93)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+___
+
+### type
+
+• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.LIST`
+
+#### Defined in
+
+[indices/BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L94)
+
+## Methods
+
+### addNode
+
+▸ **addNode**(`node`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `node` | [`BaseNode`](BaseNode.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[indices/BaseIndex.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L96)
+
+___
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
+
+#### Defined in
+
+[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L31)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Overrides
+
+[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson)
+
+#### Defined in
+
+[indices/BaseIndex.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L100)

apps/docs/docs/api/classes/IndexNode.md

@@ -1,6 +1,6 @@
 ---
 id: "IndexNode"
-title: "Class: IndexNode<T>"
+title: "Class: IndexNode"
 sidebar_label: "IndexNode"
 sidebar_position: 0
 custom_edit_url: null
@@ -8,15 +8,9 @@ custom_edit_url: null
 
 TextNode is the default node type for text. Most common node type in LlamaIndex.TS
 
-## Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
-
 ## Hierarchy
 
-- [`TextNode`](TextNode.md)<`T`\>
+- [`TextNode`](TextNode.md)
 
   ↳ **`IndexNode`**
 
@@ -24,19 +18,13 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 ### constructor
 
-• **new IndexNode**<`T`\>(`init?`)
-
-#### Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
+• **new IndexNode**(`init?`)
 
 #### Parameters
 
-| Name    | Type                                          |
-| :------ | :-------------------------------------------- |
-| `init?` | `Partial`<[`IndexNode`](IndexNode.md)<`T`\>\> |
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`IndexNode`](IndexNode.md)\> |
 
 #### Overrides
 
@@ -44,7 +32,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L236)
+[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L239)
 
 ## Properties
 
@@ -58,9 +46,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
 
----
+___
 
 ### endCharIdx
 
@@ -72,9 +60,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157)
+[Node.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L152)
 
----
+___
 
 ### excludedEmbedMetadataKeys
 
@@ -86,9 +74,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55)
+[Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L50)
 
----
+___
 
 ### excludedLlmMetadataKeys
 
@@ -100,9 +88,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56)
+[Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L51)
 
----
+___
 
 ### hash
 
@@ -114,9 +102,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58)
+[Node.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L53)
 
----
+___
 
 ### id\_
 
@@ -129,13 +117,13 @@ Set to a UUID by default.
 
 #### Inherited from
 
-[TextNode](TextNode.md).[id\_](TextNode.md#id_)
+[TextNode](TextNode.md).[id_](TextNode.md#id_)
 
 #### Defined in
 
-[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
 
----
+___
 
 ### indexId
 
@@ -143,13 +131,13 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:234](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L234)
+[Node.ts:237](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L237)
 
----
+___
 
 ### metadata
 
-• **metadata**: `T`
+• **metadata**: `Record`<`string`, `any`\> = `{}`
 
 #### Inherited from
 
@@ -157,9 +145,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54)
+[Node.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L49)
 
----
+___
 
 ### metadataSeparator
 
@@ -171,13 +159,13 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160)
+[Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L155)
 
----
+___
 
 ### relationships
 
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}`
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
 
 #### Inherited from
 
@@ -185,9 +173,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57)
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L52)
 
----
+___
 
 ### startCharIdx
 
@@ -199,9 +187,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156)
+[Node.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L151)
 
----
+___
 
 ### text
 
@@ -213,17 +201,17 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155)
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
 
 ## Accessors
 
 ### childNodes
 
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Inherited from
 
@@ -231,17 +219,17 @@ TextNode.childNodes
 
 #### Defined in
 
-[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112)
+[Node.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L107)
 
----
+___
 
 ### nextNode
 
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -249,17 +237,17 @@ TextNode.nextNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92)
+[Node.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L87)
 
----
+___
 
 ### parentNode
 
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -267,17 +255,17 @@ TextNode.parentNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102)
+[Node.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L97)
 
----
+___
 
 ### prevNode
 
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -285,17 +273,17 @@ TextNode.prevNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80)
+[Node.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L75)
 
----
+___
 
 ### sourceNode
 
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -303,17 +291,17 @@ TextNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70)
+[Node.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L65)
 
 ## Methods
 
 ### asRelatedNodeInfo
 
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -321,9 +309,9 @@ TextNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134)
+[Node.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L129)
 
----
+___
 
 ### generateHash
 
@@ -342,9 +330,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178)
+[Node.ts:173](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L173)
 
----
+___
 
 ### getContent
 
@@ -352,8 +340,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       | Default value       |
-| :------------- | :----------------------------------------- | :------------------ |
+| Name | Type | Default value |
+| :------ | :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
 
 #### Returns
@@ -366,9 +354,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L187)
 
----
+___
 
 ### getEmbedding
 
@@ -384,9 +372,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126)
+[Node.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L121)
 
----
+___
 
 ### getMetadataStr
 
@@ -394,8 +382,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       |
-| :------------- | :----------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
 
 #### Returns
@@ -408,9 +396,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197)
+[Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L192)
 
----
+___
 
 ### getNodeInfo
 
@@ -420,9 +408,9 @@ The ID is not part of the hash as it can change independent of content.
 
 `Object`
 
-| Name    | Type                    |
-| :------ | :---------------------- |
-| `end`   | `undefined` \| `number` |
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
 | `start` | `undefined` \| `number` |
 
 #### Inherited from
@@ -431,9 +419,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224)
+[Node.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L219)
 
----
+___
 
 ### getText
 
@@ -449,9 +437,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228)
+[Node.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L223)
 
----
+___
 
 ### getType
 
@@ -467,9 +455,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:245](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L245)
+[Node.ts:248](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L248)
 
----
+___
 
 ### setContent
 
@@ -477,8 +465,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name    | Type     |
-| :------ | :------- |
+| Name | Type |
+| :------ | :------ |
 | `value` | `string` |
 
 #### Returns
@@ -491,9 +479,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218)
+[Node.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L213)
 
----
+___
 
 ### toJSON
 
@@ -511,4 +499,4 @@ Used with built in JSON.stringify
 
 #### Defined in
 
-[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146)
+[Node.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L141)

apps/docs/docs/api/classes/IndexStruct.md

@@ -0,0 +1,82 @@
+---
+id: "IndexStruct"
+title: "Class: IndexStruct"
+sidebar_label: "IndexStruct"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The underlying structure of each index.
+
+## Hierarchy
+
+- **`IndexStruct`**
+
+  ↳ [`IndexDict`](IndexDict.md)
+
+  ↳ [`IndexList`](IndexList.md)
+
+## Constructors
+
+### constructor
+
+• **new IndexStruct**(`indexId?`, `summary?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indexId` | `string` | `undefined` |
+| `summary` | `undefined` | `undefined` |
+
+#### Defined in
+
+[indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L19)
+
+## Properties
+
+### indexId
+
+• **indexId**: `string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L16)
+
+___
+
+### summary
+
+• `Optional` **summary**: `string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L17)
+
+## Methods
+
+### getSummary
+
+▸ **getSummary**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L31)
+
+___
+
+### toJson
+
+▸ **toJson**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Defined in
+
+[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L24)

apps/docs/docs/api/classes/LLMQuestionGenerator.md

@@ -0,0 +1,84 @@
+---
+id: "LLMQuestionGenerator"
+title: "Class: LLMQuestionGenerator"
+sidebar_label: "LLMQuestionGenerator"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query.
+
+## Implements
+
+- [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
+
+## Constructors
+
+### constructor
+
+• **new LLMQuestionGenerator**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`LLMQuestionGenerator`](LLMQuestionGenerator.md)\> |
+
+#### Defined in
+
+[QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L34)
+
+## Properties
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L30)
+
+___
+
+### outputParser
+
+• **outputParser**: [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\>
+
+#### Defined in
+
+[QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L32)
+
+___
+
+### prompt
+
+• **prompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L31)
+
+## Methods
+
+### generate
+
+▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tools` | [`ToolMetadata`](../interfaces/ToolMetadata.md)[] |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
+
+#### Implementation of
+
+[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[generate](../interfaces/BaseQuestionGenerator.md#generate)
+
+#### Defined in
+
+[QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QuestionGenerator.ts#L40)

apps/docs/docs/api/classes/ListIndex.md

@@ -0,0 +1,350 @@
+---
+id: "ListIndex"
+title: "Class: ListIndex"
+sidebar_label: "ListIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A ListIndex keeps nodes in a sequential list structure
+
+## Hierarchy
+
+- [`BaseIndex`](BaseIndex.md)<[`IndexList`](IndexList.md)\>
+
+  ↳ **`ListIndex`**
+
+## Constructors
+
+### constructor
+
+• **new ListIndex**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`IndexList`](IndexList.md)\> |
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L47)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L127)
+
+___
+
+### indexStruct
+
+• **indexStruct**: [`IndexList`](IndexList.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
+
+#### Defined in
+
+[indices/BaseIndex.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L128)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L123)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### vectorStore
+
+• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L126)
+
+## Methods
+
+### asQueryEngine
+
+▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L155)
+
+___
+
+### asRetriever
+
+▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `Object` |
+| `options.mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) |
+
+#### Returns
+
+[`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L142)
+
+___
+
+### deleteNodes
+
+▸ **deleteNodes**(`nodeIds`, `deleteFromDocStore`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodeIds` | `string`[] |
+| `deleteFromDocStore` | `boolean` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L216)
+
+___
+
+### deleteRefDoc
+
+▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+| `deleteFromDocStore?` | `boolean` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L197)
+
+___
+
+### getRefDocInfo
+
+▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, `RefDocInfo`\>\>
+
+#### Returns
+
+`Promise`<`Record`<`string`, `RefDocInfo`\>\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:230](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L230)
+
+___
+
+### insert
+
+▸ **insert**(`document`): `Promise`<`void`\>
+
+Insert a document into the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `document` | [`Document`](Document.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert)
+
+#### Defined in
+
+[indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L159)
+
+___
+
+### insertNodes
+
+▸ **insertNodes**(`nodes`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes)
+
+#### Defined in
+
+[indices/list/ListIndex.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L191)
+
+___
+
+### buildIndexFromNodes
+
+▸ `Static` **buildIndexFromNodes**(`nodes`, `docStore`, `indexStruct?`): `Promise`<[`IndexList`](IndexList.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+| `docStore` | `BaseDocumentStore` |
+| `indexStruct?` | [`IndexList`](IndexList.md) |
+
+#### Returns
+
+`Promise`<[`IndexList`](IndexList.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L176)
+
+___
+
+### fromDocuments
+
+▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+| `args` | `Object` |
+| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
+
+#### Returns
+
+`Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L116)
+
+___
+
+### init
+
+▸ `Static` **init**(`options`): `Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `ListIndexOptions` |
+
+#### Returns
+
+`Promise`<[`ListIndex`](ListIndex.md)\>
+
+#### Defined in
+
+[indices/list/ListIndex.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L51)

apps/docs/docs/api/classes/ListIndexLLMRetriever.md

@@ -0,0 +1,137 @@
+---
+id: "ListIndexLLMRetriever"
+title: "Class: ListIndexLLMRetriever"
+sidebar_label: "ListIndexLLMRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+LLM retriever for ListIndex.
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new ListIndexLLMRetriever**(`index`, `choiceSelectPrompt?`, `choiceBatchSize?`, `formatNodeBatchFn?`, `parseChoiceSelectAnswerFn?`, `serviceContext?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `index` | [`ListIndex`](ListIndex.md) | `undefined` |
+| `choiceSelectPrompt?` | [`SimplePrompt`](../modules.md#simpleprompt) | `undefined` |
+| `choiceBatchSize` | `number` | `10` |
+| `formatNodeBatchFn?` | `NodeFormatterFunction` | `undefined` |
+| `parseChoiceSelectAnswerFn?` | `ChoiceSelectParserFunction` | `undefined` |
+| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` |
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L64)
+
+## Properties
+
+### choiceBatchSize
+
+• **choiceBatchSize**: `number`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L59)
+
+___
+
+### choiceSelectPrompt
+
+• **choiceSelectPrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L58)
+
+___
+
+### formatNodeBatchFn
+
+• **formatNodeBatchFn**: `NodeFormatterFunction`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L60)
+
+___
+
+### index
+
+• **index**: [`ListIndex`](ListIndex.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L57)
+
+___
+
+### parseChoiceSelectAnswerFn
+
+• **parseChoiceSelectAnswerFn**: `ChoiceSelectParserFunction`
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L61)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L62)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L127)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L81)

apps/docs/docs/api/classes/ListIndexRetriever.md

@@ -0,0 +1,82 @@
+---
+id: "ListIndexRetriever"
+title: "Class: ListIndexRetriever"
+sidebar_label: "ListIndexRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Simple retriever for ListIndex that returns all nodes
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new ListIndexRetriever**(`index`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `index` | [`ListIndex`](ListIndex.md) |
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L22)
+
+## Properties
+
+### index
+
+• **index**: [`ListIndex`](ListIndex.md)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L20)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L48)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/list/ListIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndexRetriever.ts#L26)

apps/docs/docs/api/classes/LlamaDeuce.md

@@ -0,0 +1,241 @@
+---
+id: "LlamaDeuce"
+title: "Class: LlamaDeuce"
+sidebar_label: "LlamaDeuce"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Llama2 LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new LlamaDeuce**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`LlamaDeuce`](LlamaDeuce.md)\> |
+
+#### Defined in
+
+[llm/LLM.ts:266](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L266)
+
+## Properties
+
+### chatStrategy
+
+• **chatStrategy**: [`DeuceChatStrategy`](../enums/DeuceChatStrategy.md)
+
+#### Defined in
+
+[llm/LLM.ts:260](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L260)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:263](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L263)
+
+___
+
+### model
+
+• **model**: ``"Llama-2-70b-chat-old"`` \| ``"Llama-2-70b-chat-4bit"`` \| ``"Llama-2-13b-chat"`` \| ``"Llama-2-13b-chat-4bit"`` \| ``"Llama-2-7b-chat"`` \| ``"Llama-2-7b-chat-4bit"``
+
+#### Defined in
+
+[llm/LLM.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L259)
+
+___
+
+### replicateSession
+
+• **replicateSession**: `ReplicateSession`
+
+#### Defined in
+
+[llm/LLM.ts:264](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L264)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:261](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L261)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:262](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L262)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `_parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `_parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:385](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L385)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:422](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L422)
+
+___
+
+### mapMessageTypeA16Z
+
+▸ **mapMessageTypeA16Z**(`messageType`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageType` | [`MessageType`](../modules.md#messagetype) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[llm/LLM.ts:309](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L309)
+
+___
+
+### mapMessagesToPrompt
+
+▸ **mapMessagesToPrompt**(`messages`): `Object`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `prompt` | `string` |
+| `systemPrompt` | `undefined` \| `string` |
+
+#### Defined in
+
+[llm/LLM.ts:281](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L281)
+
+___
+
+### mapMessagesToPromptA16Z
+
+▸ **mapMessagesToPromptA16Z**(`messages`): `Object`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `prompt` | `string` |
+| `systemPrompt` | `undefined` |
+
+#### Defined in
+
+[llm/LLM.ts:295](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L295)
+
+___
+
+### mapMessagesToPromptMeta
+
+▸ **mapMessagesToPromptMeta**(`messages`, `opts?`): `Object`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `opts?` | `Object` |
+| `opts.replicate4Bit?` | `boolean` |
+| `opts.withBos?` | `boolean` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `prompt` | `string` |
+| `systemPrompt` | `undefined` \| `string` |
+
+#### Defined in
+
+[llm/LLM.ts:322](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L322)

apps/docs/docs/api/classes/OpenAI.md

@@ -0,0 +1,193 @@
+---
+id: "OpenAI"
+title: "Class: OpenAI"
+sidebar_label: "OpenAI"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+OpenAI LLM implementation
+
+## Implements
+
+- [`LLM`](../interfaces/LLM.md)
+
+## Constructors
+
+### constructor
+
+• **new OpenAI**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`OpenAI`](OpenAI.md)\> & { `azure?`: `AzureOpenAIConfig`  } |
+
+#### Defined in
+
+[llm/LLM.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L94)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[llm/LLM.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L87)
+
+___
+
+### callbackManager
+
+• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
+
+#### Defined in
+
+[llm/LLM.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L92)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L88)
+
+___
+
+### maxTokens
+
+• `Optional` **maxTokens**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L84)
+
+___
+
+### model
+
+• **model**: ``"gpt-3.5-turbo"`` \| ``"gpt-3.5-turbo-16k"`` \| ``"gpt-4"`` \| ``"gpt-4-32k"``
+
+#### Defined in
+
+[llm/LLM.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L81)
+
+___
+
+### session
+
+• **session**: `OpenAISession`
+
+#### Defined in
+
+[llm/LLM.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L90)
+
+___
+
+### temperature
+
+• **temperature**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L82)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L89)
+
+___
+
+### topP
+
+• **topP**: `number`
+
+#### Defined in
+
+[llm/LLM.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L83)
+
+## Methods
+
+### chat
+
+▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a chat response from the LLM
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat)
+
+#### Defined in
+
+[llm/LLM.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L157)
+
+___
+
+### complete
+
+▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+Get a prompt completion from the LLM
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `prompt` | `string` | the prompt to complete |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) | - |
+
+#### Returns
+
+`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\>
+
+#### Implementation of
+
+[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete)
+
+#### Defined in
+
+[llm/LLM.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L197)
+
+___
+
+### mapMessageType
+
+▸ **mapMessageType**(`messageType`): ``"function"`` \| ``"user"`` \| ``"assistant"`` \| ``"system"``
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageType` | [`MessageType`](../modules.md#messagetype) |
+
+#### Returns
+
+``"function"`` \| ``"user"`` \| ``"assistant"`` \| ``"system"``
+
+#### Defined in
+
+[llm/LLM.ts:140](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L140)

apps/docs/docs/api/classes/OpenAIEmbedding.md

@@ -0,0 +1,177 @@
+---
+id: "OpenAIEmbedding"
+title: "Class: OpenAIEmbedding"
+sidebar_label: "OpenAIEmbedding"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- [`BaseEmbedding`](BaseEmbedding.md)
+
+  ↳ **`OpenAIEmbedding`**
+
+## Constructors
+
+### constructor
+
+• **new OpenAIEmbedding**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`OpenAIEmbedding`](OpenAIEmbedding.md)\> & { `azure?`: `AzureOpenAIConfig`  } |
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor)
+
+#### Defined in
+
+[Embedding.ts:229](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L229)
+
+## Properties
+
+### apiKey
+
+• `Optional` **apiKey**: `string` = `undefined`
+
+#### Defined in
+
+[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L224)
+
+___
+
+### maxRetries
+
+• **maxRetries**: `number`
+
+#### Defined in
+
+[Embedding.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L225)
+
+___
+
+### model
+
+• **model**: `TEXT_EMBED_ADA_002`
+
+#### Defined in
+
+[Embedding.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L221)
+
+___
+
+### session
+
+• **session**: `OpenAISession`
+
+#### Defined in
+
+[Embedding.ts:227](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L227)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Defined in
+
+[Embedding.ts:226](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L226)
+
+## Methods
+
+### getOpenAIEmbedding
+
+▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[Embedding.ts:270](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L270)
+
+___
+
+### getQueryEmbedding
+
+▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding)
+
+#### Defined in
+
+[Embedding.ts:286](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L286)
+
+___
+
+### getTextEmbedding
+
+▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Overrides
+
+[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding)
+
+#### Defined in
+
+[Embedding.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L282)
+
+___
+
+### similarity
+
+▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `embedding1` | `number`[] | `undefined` |
+| `embedding2` | `number`[] | `undefined` |
+| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` |
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity)
+
+#### Defined in
+
+[Embedding.ts:204](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L204)

apps/docs/docs/api/classes/PDFReader.md

@@ -0,0 +1,44 @@
+---
+id: "PDFReader"
+title: "Class: PDFReader"
+sidebar_label: "PDFReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Read the text of a PDF
+
+## Implements
+
+- [`BaseReader`](../interfaces/BaseReader.md)
+
+## Constructors
+
+### constructor
+
+• **new PDFReader**()
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `file` | `string` | `undefined` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<[`Document`](Document.md)[]\>
+
+#### Implementation of
+
+[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
+
+#### Defined in
+
+[readers/PDFReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/PDFReader.ts#L11)

apps/docs/docs/api/classes/Refine.md

@@ -0,0 +1,139 @@
+---
+id: "Refine"
+title: "Class: Refine"
+sidebar_label: "Refine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
+
+## Hierarchy
+
+- **`Refine`**
+
+  ↳ [`CompactAndRefine`](CompactAndRefine.md)
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new Refine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `textQATemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+| `refineTemplate?` | [`SimplePrompt`](../modules.md#simpleprompt) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L78)
+
+## Properties
+
+### refineTemplate
+
+• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L76)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L74)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L75)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+| `prevResponse?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L88)
+
+___
+
+### giveResponseSingle
+
+▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryStr` | `string` |
+| `textChunk` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L113)
+
+___
+
+### refineResponseSingle
+
+▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `response` | `string` |
+| `queryStr` | `string` |
+| `textChunk` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L149)

apps/docs/docs/api/classes/Response.md

@@ -0,0 +1,74 @@
+---
+id: "Response"
+title: "Class: Response"
+sidebar_label: "Response"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Respone is the output of a LLM
+
+## Constructors
+
+### constructor
+
+• **new Response**(`response`, `sourceNodes?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `response` | `string` |
+| `sourceNodes?` | [`BaseNode`](BaseNode.md)[] |
+
+#### Defined in
+
+[Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L10)
+
+## Properties
+
+### response
+
+• **response**: `string`
+
+#### Defined in
+
+[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L7)
+
+___
+
+### sourceNodes
+
+• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)[]
+
+#### Defined in
+
+[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L8)
+
+## Methods
+
+### getFormattedSources
+
+▸ **getFormattedSources**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L15)
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Response.ts#L19)

apps/docs/docs/api/classes/ResponseSynthesizer.md

@@ -0,0 +1,69 @@
+---
+id: "ResponseSynthesizer"
+title: "Class: ResponseSynthesizer"
+sidebar_label: "ResponseSynthesizer"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A ResponseSynthesizer is used to generate a response from a query and a list of nodes.
+
+## Constructors
+
+### constructor
+
+• **new ResponseSynthesizer**(`«destructured»?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `responseBuilder?` | `BaseResponseBuilder` |
+| › `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:285](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L285)
+
+## Properties
+
+### responseBuilder
+
+• **responseBuilder**: `BaseResponseBuilder`
+
+#### Defined in
+
+[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L282)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L283)
+
+## Methods
+
+### synthesize
+
+▸ **synthesize**(`query`, `nodes`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Defined in
+
+[ResponseSynthesizer.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L297)

apps/docs/docs/api/classes/RetrieverQueryEngine.md

@@ -0,0 +1,77 @@
+---
+id: "RetrieverQueryEngine"
+title: "Class: RetrieverQueryEngine"
+sidebar_label: "RetrieverQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A query engine that uses a retriever to query an index and then synthesizes the response.
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new RetrieverQueryEngine**(`retriever`, `responseSynthesizer?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
+| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+
+#### Defined in
+
+[QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L34)
+
+## Properties
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L32)
+
+___
+
+### retriever
+
+• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+#### Defined in
+
+[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L31)
+
+## Methods
+
+### query
+
+▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
+
+Query the query engine and get a response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query)
+
+#### Defined in
+
+[QueryEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L45)

apps/docs/docs/api/classes/SentenceSplitter.md

@@ -0,0 +1,238 @@
+---
+id: "SentenceSplitter"
+title: "Class: SentenceSplitter"
+sidebar_label: "SentenceSplitter"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap.
+
+One of the advantages of SentenceSplitter is that even in the fixed length chunks it will try to keep sentences together.
+
+## Constructors
+
+### constructor
+
+• **new SentenceSplitter**(`chunkSize?`, `chunkOverlap?`, `tokenizer?`, `tokenizerDecoder?`, `paragraphSeparator?`, `chunkingTokenizerFn?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `chunkSize` | `number` | `DEFAULT_CHUNK_SIZE` |
+| `chunkOverlap` | `number` | `DEFAULT_CHUNK_OVERLAP` |
+| `tokenizer` | `any` | `null` |
+| `tokenizerDecoder` | `any` | `null` |
+| `paragraphSeparator` | `string` | `"\n\n\n"` |
+| `chunkingTokenizerFn` | `any` | `undefined` |
+
+#### Defined in
+
+[TextSplitter.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L35)
+
+## Properties
+
+### chunkOverlap
+
+• `Private` **chunkOverlap**: `number`
+
+#### Defined in
+
+[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L28)
+
+___
+
+### chunkSize
+
+• `Private` **chunkSize**: `number`
+
+#### Defined in
+
+[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L27)
+
+___
+
+### chunkingTokenizerFn
+
+• `Private` **chunkingTokenizerFn**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L32)
+
+___
+
+### paragraphSeparator
+
+• `Private` **paragraphSeparator**: `string`
+
+#### Defined in
+
+[TextSplitter.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L31)
+
+___
+
+### tokenizer
+
+• `Private` **tokenizer**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L29)
+
+___
+
+### tokenizerDecoder
+
+• `Private` **tokenizerDecoder**: `any`
+
+#### Defined in
+
+[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L30)
+
+## Methods
+
+### combineTextSplits
+
+▸ **combineTextSplits**(`newSentenceSplits`, `effectiveChunkSize`): `TextSplit`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `newSentenceSplits` | `SplitRep`[] |
+| `effectiveChunkSize` | `number` |
+
+#### Returns
+
+`TextSplit`[]
+
+#### Defined in
+
+[TextSplitter.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L155)
+
+___
+
+### getEffectiveChunkSize
+
+▸ `Private` **getEffectiveChunkSize**(`extraInfoStr?`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[TextSplitter.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L74)
+
+___
+
+### getParagraphSplits
+
+▸ **getParagraphSplits**(`text`, `effectiveChunkSize?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `effectiveChunkSize?` | `number` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L91)
+
+___
+
+### getSentenceSplits
+
+▸ **getSentenceSplits**(`text`, `effectiveChunkSize?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `effectiveChunkSize?` | `number` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L117)
+
+___
+
+### processSentenceSplits
+
+▸ `Private` **processSentenceSplits**(`sentenceSplits`, `effectiveChunkSize`): `SplitRep`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `sentenceSplits` | `string`[] |
+| `effectiveChunkSize` | `number` |
+
+#### Returns
+
+`SplitRep`[]
+
+#### Defined in
+
+[TextSplitter.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L130)
+
+___
+
+### splitText
+
+▸ **splitText**(`text`, `extraInfoStr?`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[TextSplitter.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L247)
+
+___
+
+### splitTextWithOverlaps
+
+▸ **splitTextWithOverlaps**(`text`, `extraInfoStr?`): `TextSplit`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+| `extraInfoStr?` | `string` |
+
+#### Returns
+
+`TextSplit`[]
+
+#### Defined in
+
+[TextSplitter.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/TextSplitter.ts#L219)

apps/docs/docs/api/classes/SimpleChatEngine.md

@@ -0,0 +1,96 @@
+---
+id: "SimpleChatEngine"
+title: "Class: SimpleChatEngine"
+sidebar_label: "SimpleChatEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts.
+
+## Implements
+
+- [`ChatEngine`](../interfaces/ChatEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleChatEngine**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`SimpleChatEngine`](SimpleChatEngine.md)\> |
+
+#### Defined in
+
+[ChatEngine.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L40)
+
+## Properties
+
+### chatHistory
+
+• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
+
+#### Defined in
+
+[ChatEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L37)
+
+___
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L38)
+
+## Methods
+
+### chat
+
+▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](Response.md)\>
+
+Send message along with the class's current chat history to the LLM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `string` |  |
+| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat)
+
+#### Defined in
+
+[ChatEngine.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L45)
+
+___
+
+### reset
+
+▸ **reset**(): `void`
+
+Resets the chat history so that it's empty.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset)
+
+#### Defined in
+
+[ChatEngine.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ChatEngine.ts#L54)

apps/docs/docs/api/classes/SimpleDirectoryReader.md

@@ -0,0 +1,43 @@
+---
+id: "SimpleDirectoryReader"
+title: "Class: SimpleDirectoryReader"
+sidebar_label: "SimpleDirectoryReader"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Read all of the documents in a directory. Currently supports PDF and TXT files.
+
+## Implements
+
+- [`BaseReader`](../interfaces/BaseReader.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleDirectoryReader**()
+
+## Methods
+
+### loadData
+
+▸ **loadData**(`«destructured»`): `Promise`<[`Document`](Document.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`SimpleDirectoryReaderLoadDataProps`](../modules.md#simpledirectoryreaderloaddataprops) |
+
+#### Returns
+
+`Promise`<[`Document`](Document.md)[]\>
+
+#### Implementation of
+
+[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
+
+#### Defined in
+
+[readers/SimpleDirectoryReader.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L37)

apps/docs/docs/api/classes/SimpleDocumentStore.md

@@ -0,0 +1,480 @@
+---
+id: "SimpleDocumentStore"
+title: "Class: SimpleDocumentStore"
+sidebar_label: "SimpleDocumentStore"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- `KVDocumentStore`
+
+  ↳ **`SimpleDocumentStore`**
+
+## Constructors
+
+### constructor
+
+• **new SimpleDocumentStore**(`kvStore?`, `namespace?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `kvStore?` | `SimpleKVStore` |
+| `namespace?` | `string` |
+
+#### Overrides
+
+KVDocumentStore.constructor
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L19)
+
+## Properties
+
+### kvStore
+
+• `Private` **kvStore**: `SimpleKVStore`
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L17)
+
+## Methods
+
+### addDocuments
+
+▸ **addDocuments**(`docs`, `allowUpdate?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `docs` | [`BaseNode`](BaseNode.md)[] | `undefined` |
+| `allowUpdate` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVDocumentStore.addDocuments
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L33)
+
+___
+
+### deleteDocument
+
+▸ **deleteDocument**(`docId`, `raiseError?`, `removeRefDocNode?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `docId` | `string` | `undefined` |
+| `raiseError` | `boolean` | `true` |
+| `removeRefDocNode` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVDocumentStore.deleteDocument
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L131)
+
+___
+
+### deleteRefDoc
+
+▸ **deleteRefDoc**(`refDocId`, `raiseError?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `refDocId` | `string` | `undefined` |
+| `raiseError` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVDocumentStore.deleteRefDoc
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L148)
+
+___
+
+### docs
+
+▸ **docs**(): `Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)\>\>
+
+#### Returns
+
+`Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)\>\>
+
+#### Inherited from
+
+KVDocumentStore.docs
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L24)
+
+___
+
+### documentExists
+
+▸ **documentExists**(`docId`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `docId` | `string` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Inherited from
+
+KVDocumentStore.documentExists
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L105)
+
+___
+
+### getAllRefDocInfo
+
+▸ **getAllRefDocInfo**(): `Promise`<`undefined` \| `Record`<`string`, `RefDocInfo`\>\>
+
+#### Returns
+
+`Promise`<`undefined` \| `Record`<`string`, `RefDocInfo`\>\>
+
+#### Inherited from
+
+KVDocumentStore.getAllRefDocInfo
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L93)
+
+___
+
+### getDocument
+
+▸ **getDocument**(`docId`, `raiseError?`): `Promise`<`undefined` \| [`BaseNode`](BaseNode.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `docId` | `string` | `undefined` |
+| `raiseError` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<`undefined` \| [`BaseNode`](BaseNode.md)\>
+
+#### Inherited from
+
+KVDocumentStore.getDocument
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L73)
+
+___
+
+### getDocumentHash
+
+▸ **getDocumentHash**(`docId`): `Promise`<`undefined` \| `string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `docId` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| `string`\>
+
+#### Inherited from
+
+KVDocumentStore.getDocumentHash
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L174)
+
+___
+
+### getNode
+
+▸ **getNode**(`nodeId`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `nodeId` | `string` | `undefined` |
+| `raiseError` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<[`BaseNode`](BaseNode.md)\>
+
+#### Inherited from
+
+KVDocumentStore.getNode
+
+#### Defined in
+
+[storage/docStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/types.ts#L57)
+
+___
+
+### getNodeDict
+
+▸ **getNodeDict**(`nodeIdDict`): `Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodeIdDict` | `Object` |
+
+#### Returns
+
+`Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)\>\>
+
+#### Inherited from
+
+KVDocumentStore.getNodeDict
+
+#### Defined in
+
+[storage/docStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/types.ts#L65)
+
+___
+
+### getNodes
+
+▸ **getNodes**(`nodeIds`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `nodeIds` | `string`[] | `undefined` |
+| `raiseError` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<[`BaseNode`](BaseNode.md)[]\>
+
+#### Inherited from
+
+KVDocumentStore.getNodes
+
+#### Defined in
+
+[storage/docStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/types.ts#L51)
+
+___
+
+### getRefDocInfo
+
+▸ **getRefDocInfo**(`refDocId`): `Promise`<`undefined` \| `RefDocInfo`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| `RefDocInfo`\>
+
+#### Inherited from
+
+KVDocumentStore.getRefDocInfo
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L88)
+
+___
+
+### persist
+
+▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `persistPath` | `string` |
+| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+KVDocumentStore.persist
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L52)
+
+___
+
+### refDocExists
+
+▸ **refDocExists**(`refDocId`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Inherited from
+
+KVDocumentStore.refDocExists
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L101)
+
+___
+
+### setDocumentHash
+
+▸ **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `docId` | `string` |
+| `docHash` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVDocumentStore.setDocumentHash
+
+#### Defined in
+
+[storage/docStore/KVDocumentStore.ts:169](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/KVDocumentStore.ts#L169)
+
+___
+
+### toDict
+
+▸ **toDict**(): `SaveDict`
+
+#### Returns
+
+`SaveDict`
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L73)
+
+___
+
+### fromDict
+
+▸ `Static` **fromDict**(`saveDict`, `namespace?`): [`SimpleDocumentStore`](SimpleDocumentStore.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `saveDict` | `SaveDict` |
+| `namespace?` | `string` |
+
+#### Returns
+
+[`SimpleDocumentStore`](SimpleDocumentStore.md)
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L68)
+
+___
+
+### fromPersistDir
+
+▸ `Static` **fromPersistDir**(`persistDir?`, `namespace?`, `fsModule?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` |
+| `namespace?` | `string` | `undefined` |
+| `fsModule?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` |
+
+#### Returns
+
+`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\>
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L26)
+
+___
+
+### fromPersistPath
+
+▸ `Static` **fromPersistPath**(`persistPath`, `namespace?`, `fs?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `persistPath` | `string` |
+| `namespace?` | `string` |
+| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) |
+
+#### Returns
+
+`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\>
+
+#### Defined in
+
+[storage/docStore/SimpleDocumentStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L42)

apps/docs/docs/api/classes/SimpleIndexStore.md

@@ -0,0 +1,234 @@
+---
+id: "SimpleIndexStore"
+title: "Class: SimpleIndexStore"
+sidebar_label: "SimpleIndexStore"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Hierarchy
+
+- `KVIndexStore`
+
+  ↳ **`SimpleIndexStore`**
+
+## Constructors
+
+### constructor
+
+• **new SimpleIndexStore**(`kvStore?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `kvStore?` | `BaseInMemoryKVStore` |
+
+#### Overrides
+
+KVIndexStore.constructor
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L16)
+
+## Properties
+
+### kvStore
+
+• `Private` **kvStore**: `BaseInMemoryKVStore`
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L14)
+
+## Methods
+
+### addIndexStruct
+
+▸ **addIndexStruct**(`indexStruct`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `indexStruct` | [`IndexStruct`](IndexStruct.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVIndexStore.addIndexStruct
+
+#### Defined in
+
+[storage/indexStore/KVIndexStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/KVIndexStore.ts#L17)
+
+___
+
+### deleteIndexStruct
+
+▸ **deleteIndexStruct**(`key`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+KVIndexStore.deleteIndexStruct
+
+#### Defined in
+
+[storage/indexStore/KVIndexStore.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/KVIndexStore.ts#L23)
+
+___
+
+### getIndexStruct
+
+▸ **getIndexStruct**(`structId?`): `Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `structId?` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\>
+
+#### Inherited from
+
+KVIndexStore.getIndexStruct
+
+#### Defined in
+
+[storage/indexStore/KVIndexStore.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/KVIndexStore.ts#L27)
+
+___
+
+### getIndexStructs
+
+▸ **getIndexStructs**(): `Promise`<[`IndexStruct`](IndexStruct.md)[]\>
+
+#### Returns
+
+`Promise`<[`IndexStruct`](IndexStruct.md)[]\>
+
+#### Inherited from
+
+KVIndexStore.getIndexStructs
+
+#### Defined in
+
+[storage/indexStore/KVIndexStore.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/KVIndexStore.ts#L43)
+
+___
+
+### persist
+
+▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `persistPath` | `string` | `DEFAULT_PERSIST_DIR` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+KVIndexStore.persist
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L41)
+
+___
+
+### toDict
+
+▸ **toDict**(): `Record`<`string`, `unknown`\>
+
+#### Returns
+
+`Record`<`string`, `unknown`\>
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L53)
+
+___
+
+### fromDict
+
+▸ `Static` **fromDict**(`saveDict`): [`SimpleIndexStore`](SimpleIndexStore.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `saveDict` | `DataType` |
+
+#### Returns
+
+[`SimpleIndexStore`](SimpleIndexStore.md)
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L48)
+
+___
+
+### fromPersistDir
+
+▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\>
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L22)
+
+___
+
+### fromPersistPath
+
+▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `persistPath` | `string` | `undefined` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\>
+
+#### Defined in
+
+[storage/indexStore/SimpleIndexStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L33)

apps/docs/docs/api/classes/SimpleNodeParser.md

@@ -0,0 +1,120 @@
+---
+id: "SimpleNodeParser"
+title: "Class: SimpleNodeParser"
+sidebar_label: "SimpleNodeParser"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter
+
+## Implements
+
+- [`NodeParser`](../interfaces/NodeParser.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleNodeParser**(`init?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Object` |
+| `init.chunkOverlap?` | `number` |
+| `init.chunkSize?` | `number` |
+| `init.includeMetadata?` | `boolean` |
+| `init.includePrevNextRel?` | `boolean` |
+| `init.textSplitter?` | [`SentenceSplitter`](SentenceSplitter.md) |
+
+#### Defined in
+
+[NodeParser.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L93)
+
+## Properties
+
+### includeMetadata
+
+• **includeMetadata**: `boolean`
+
+Whether to include metadata in the nodes.
+
+#### Defined in
+
+[NodeParser.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L87)
+
+___
+
+### includePrevNextRel
+
+• **includePrevNextRel**: `boolean`
+
+Whether to include previous and next relationships in the nodes.
+
+#### Defined in
+
+[NodeParser.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L91)
+
+___
+
+### textSplitter
+
+• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md)
+
+The text splitter to use.
+
+#### Defined in
+
+[NodeParser.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L83)
+
+## Methods
+
+### getNodesFromDocuments
+
+▸ **getNodesFromDocuments**(`documents`): [`TextNode`](TextNode.md)[]
+
+Generate Node objects from documents
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+
+#### Returns
+
+[`TextNode`](TextNode.md)[]
+
+#### Implementation of
+
+[NodeParser](../interfaces/NodeParser.md).[getNodesFromDocuments](../interfaces/NodeParser.md#getnodesfromdocuments)
+
+#### Defined in
+
+[NodeParser.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L124)
+
+___
+
+### fromDefaults
+
+▸ `Static` **fromDefaults**(`init?`): [`SimpleNodeParser`](SimpleNodeParser.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Object` |
+| `init.chunkOverlap?` | `number` |
+| `init.chunkSize?` | `number` |
+| `init.includeMetadata?` | `boolean` |
+| `init.includePrevNextRel?` | `boolean` |
+
+#### Returns
+
+[`SimpleNodeParser`](SimpleNodeParser.md)
+
+#### Defined in
+
+[NodeParser.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/NodeParser.ts#L111)

apps/docs/docs/api/classes/SimpleResponseBuilder.md

@@ -0,0 +1,75 @@
+---
+id: "SimpleResponseBuilder"
+title: "Class: SimpleResponseBuilder"
+sidebar_label: "SimpleResponseBuilder"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+A response builder that just concatenates responses.
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new SimpleResponseBuilder**(`serviceContext`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L49)
+
+## Properties
+
+### llm
+
+• **llm**: [`LLM`](../interfaces/LLM.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L46)
+
+___
+
+### textQATemplate
+
+• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L47)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L54)

apps/docs/docs/api/classes/SimpleVectorStore.md

@@ -0,0 +1,283 @@
+---
+id: "SimpleVectorStore"
+title: "Class: SimpleVectorStore"
+sidebar_label: "SimpleVectorStore"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Implements
+
+- [`VectorStore`](../interfaces/VectorStore.md)
+
+## Constructors
+
+### constructor
+
+• **new SimpleVectorStore**(`data?`, `fs?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data?` | `SimpleVectorStoreData` |
+| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) |
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L37)
+
+## Properties
+
+### data
+
+• `Private` **data**: `SimpleVectorStoreData`
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L33)
+
+___
+
+### fs
+
+• `Private` **fs**: [`GenericFileSystem`](../interfaces/GenericFileSystem.md) = `DEFAULT_FS`
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L34)
+
+___
+
+### persistPath
+
+• `Private` **persistPath**: `undefined` \| `string`
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L35)
+
+___
+
+### storesText
+
+• **storesText**: `boolean` = `false`
+
+#### Implementation of
+
+[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L32)
+
+## Accessors
+
+### client
+
+• `get` **client**(): `any`
+
+#### Returns
+
+`any`
+
+#### Implementation of
+
+VectorStore.client
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L50)
+
+## Methods
+
+### add
+
+▸ **add**(`embeddingResults`): `Promise`<`string`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `embeddingResults` | [`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[] |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Implementation of
+
+[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L58)
+
+___
+
+### delete
+
+▸ **delete**(`refDocId`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refDocId` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L78)
+
+___
+
+### get
+
+▸ **get**(`textId`): `Promise`<`number`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `textId` | `string` |
+
+#### Returns
+
+`Promise`<`number`[]\>
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L54)
+
+___
+
+### persist
+
+▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `persistPath` | `string` |
+| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Implementation of
+
+[VectorStore](../interfaces/VectorStore.md).[persist](../interfaces/VectorStore.md#persist)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L147)
+
+___
+
+### query
+
+▸ **query**(`query`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) |
+
+#### Returns
+
+`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\>
+
+#### Implementation of
+
+[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L89)
+
+___
+
+### toDict
+
+▸ **toDict**(): `SimpleVectorStoreData`
+
+#### Returns
+
+`SimpleVectorStoreData`
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L197)
+
+___
+
+### fromDict
+
+▸ `Static` **fromDict**(`saveDict`): [`SimpleVectorStore`](SimpleVectorStore.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `saveDict` | `SimpleVectorStoreData` |
+
+#### Returns
+
+[`SimpleVectorStore`](SimpleVectorStore.md)
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L190)
+
+___
+
+### fromPersistDir
+
+▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` |
+| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` |
+
+#### Returns
+
+`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\>
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L42)
+
+___
+
+### fromPersistPath
+
+▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `persistPath` | `string` |
+| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) |
+
+#### Returns
+
+`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\>
+
+#### Defined in
+
+[storage/vectorStore/SimpleVectorStore.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L160)

apps/docs/docs/api/classes/SubQuestionOutputParser.md

@@ -26,8 +26,8 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
 
 #### Parameters
 
-| Name     | Type     |
-| :------- | :------- |
+| Name | Type |
+| :------ | :------ |
 | `output` | `string` |
 
 #### Returns
@@ -40,9 +40,9 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
 
 #### Defined in
 
-[packages/core/src/OutputParser.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L98)
+[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L97)
 
----
+___
 
 ### parse
 
@@ -50,8 +50,8 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
 
 #### Parameters
 
-| Name     | Type     |
-| :------- | :------- |
+| Name | Type |
+| :------ | :------ |
 | `output` | `string` |
 
 #### Returns
@@ -64,4 +64,4 @@ SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
 
 #### Defined in
 
-[packages/core/src/OutputParser.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L90)
+[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/OutputParser.ts#L89)

apps/docs/docs/api/classes/SubQuestionQueryEngine.md

@@ -0,0 +1,143 @@
+---
+id: "SubQuestionQueryEngine"
+title: "Class: SubQuestionQueryEngine"
+sidebar_label: "SubQuestionQueryEngine"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+SubQuestionQueryEngine decomposes a question into subquestions and then
+
+## Implements
+
+- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+## Constructors
+
+### constructor
+
+• **new SubQuestionQueryEngine**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+
+#### Defined in
+
+[QueryEngine.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L65)
+
+## Properties
+
+### metadatas
+
+• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[]
+
+#### Defined in
+
+[QueryEngine.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L63)
+
+___
+
+### queryEngines
+
+• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L62)
+
+___
+
+### questionGen
+
+• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
+
+#### Defined in
+
+[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L61)
+
+___
+
+### responseSynthesizer
+
+• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
+
+#### Defined in
+
+[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L60)
+
+## Methods
+
+### query
+
+▸ **query**(`query`): `Promise`<[`Response`](Response.md)\>
+
+Query the query engine and get a response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+
+#### Returns
+
+`Promise`<[`Response`](Response.md)\>
+
+#### Implementation of
+
+[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query)
+
+#### Defined in
+
+[QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L106)
+
+___
+
+### querySubQ
+
+▸ `Private` **querySubQ**(`subQ`, `parentEvent?`): `Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `subQ` | [`SubQuestion`](../interfaces/SubQuestion.md) |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<``null`` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)\>
+
+#### Defined in
+
+[QueryEngine.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L134)
+
+___
+
+### fromDefaults
+
+▸ `Static` **fromDefaults**(`init`): [`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | `Object` |
+| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] |
+| `init.questionGen?` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) |
+| `init.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) |
+| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Returns
+
+[`SubQuestionQueryEngine`](SubQuestionQueryEngine.md)
+
+#### Defined in
+
+[QueryEngine.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/QueryEngine.ts#L82)

apps/docs/docs/api/classes/TextFileReader.md

@@ -22,18 +22,18 @@ Read a .txt file
 
 ### loadData
 
-▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\>
+▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
 
 #### Parameters
 
-| Name   | Type                                           |
-| :----- | :--------------------------------------------- |
-| `file` | `string`                                       |
-| `fs`   | [`CompleteFileSystem`](../#completefilesystem) |
+| Name | Type |
+| :------ | :------ |
+| `file` | `string` |
+| `fs` | [`CompleteFileSystem`](../modules.md#completefilesystem) |
 
 #### Returns
 
-`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\>
+`Promise`<[`Document`](Document.md)[]\>
 
 #### Implementation of
 
@@ -41,4 +41,4 @@ Read a .txt file
 
 #### Defined in
 
-[packages/core/src/readers/SimpleDirectoryReader.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L29)
+[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/readers/SimpleDirectoryReader.ts#L12)

apps/docs/docs/api/classes/TextNode.md

@@ -1,6 +1,6 @@
 ---
 id: "TextNode"
-title: "Class: TextNode<T>"
+title: "Class: TextNode"
 sidebar_label: "TextNode"
 sidebar_position: 0
 custom_edit_url: null
@@ -8,15 +8,9 @@ custom_edit_url: null
 
 TextNode is the default node type for text. Most common node type in LlamaIndex.TS
 
-## Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
-
 ## Hierarchy
 
-- [`BaseNode`](BaseNode.md)<`T`\>
+- [`BaseNode`](BaseNode.md)
 
   ↳ **`TextNode`**
 
@@ -24,25 +18,17 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
   ↳↳ [`Document`](Document.md)
 
-  ↳↳ [`ImageNode`](ImageNode.md)
-
 ## Constructors
 
 ### constructor
 
-• **new TextNode**<`T`\>(`init?`)
-
-#### Type parameters
-
-| Name | Type                                                            |
-| :--- | :-------------------------------------------------------------- |
-| `T`  | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) |
+• **new TextNode**(`init?`)
 
 #### Parameters
 
-| Name    | Type                                        |
-| :------ | :------------------------------------------ |
-| `init?` | `Partial`<[`TextNode`](TextNode.md)<`T`\>\> |
+| Name | Type |
+| :------ | :------ |
+| `init?` | `Partial`<[`TextNode`](TextNode.md)\> |
 
 #### Overrides
 
@@ -50,7 +36,7 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L162)
+[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L157)
 
 ## Properties
 
@@ -64,9 +50,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51)
+[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L46)
 
----
+___
 
 ### endCharIdx
 
@@ -74,9 +60,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157)
+[Node.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L152)
 
----
+___
 
 ### excludedEmbedMetadataKeys
 
@@ -88,9 +74,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55)
+[Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L50)
 
----
+___
 
 ### excludedLlmMetadataKeys
 
@@ -102,9 +88,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56)
+[Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L51)
 
----
+___
 
 ### hash
 
@@ -116,9 +102,9 @@ TextNode is the default node type for text. Most common node type in LlamaIndex.
 
 #### Defined in
 
-[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58)
+[Node.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L53)
 
----
+___
 
 ### id\_
 
@@ -131,17 +117,17 @@ Set to a UUID by default.
 
 #### Inherited from
 
-[BaseNode](BaseNode.md).[id\_](BaseNode.md#id_)
+[BaseNode](BaseNode.md).[id_](BaseNode.md#id_)
 
 #### Defined in
 
-[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50)
+[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L45)
 
----
+___
 
 ### metadata
 
-• **metadata**: `T`
+• **metadata**: `Record`<`string`, `any`\> = `{}`
 
 #### Inherited from
 
@@ -149,9 +135,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54)
+[Node.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L49)
 
----
+___
 
 ### metadataSeparator
 
@@ -159,13 +145,13 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160)
+[Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L155)
 
----
+___
 
 ### relationships
 
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}`
+• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
 
 #### Inherited from
 
@@ -173,9 +159,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57)
+[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L52)
 
----
+___
 
 ### startCharIdx
 
@@ -183,9 +169,9 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156)
+[Node.ts:151](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L151)
 
----
+___
 
 ### text
 
@@ -193,17 +179,17 @@ Set to a UUID by default.
 
 #### Defined in
 
-[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155)
+[Node.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L150)
 
 ## Accessors
 
 ### childNodes
 
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[]
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
 
 #### Inherited from
 
@@ -211,17 +197,17 @@ BaseNode.childNodes
 
 #### Defined in
 
-[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112)
+[Node.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L107)
 
----
+___
 
 ### nextNode
 
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -229,17 +215,17 @@ BaseNode.nextNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92)
+[Node.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L87)
 
----
+___
 
 ### parentNode
 
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -247,17 +233,17 @@ BaseNode.parentNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102)
+[Node.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L97)
 
----
+___
 
 ### prevNode
 
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -265,17 +251,17 @@ BaseNode.prevNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80)
+[Node.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L75)
 
----
+___
 
 ### sourceNode
 
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -283,17 +269,17 @@ BaseNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70)
+[Node.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L65)
 
 ## Methods
 
 ### asRelatedNodeInfo
 
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Returns
 
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>
+[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
 
 #### Inherited from
 
@@ -301,9 +287,9 @@ BaseNode.sourceNode
 
 #### Defined in
 
-[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134)
+[Node.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L129)
 
----
+___
 
 ### generateHash
 
@@ -322,9 +308,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178)
+[Node.ts:173](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L173)
 
----
+___
 
 ### getContent
 
@@ -332,8 +318,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       | Default value       |
-| :------------- | :----------------------------------------- | :------------------ |
+| Name | Type | Default value |
+| :------ | :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
 
 #### Returns
@@ -346,9 +332,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192)
+[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L187)
 
----
+___
 
 ### getEmbedding
 
@@ -364,9 +350,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126)
+[Node.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L121)
 
----
+___
 
 ### getMetadataStr
 
@@ -374,8 +360,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name           | Type                                       |
-| :------------- | :----------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
 
 #### Returns
@@ -388,9 +374,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197)
+[Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L192)
 
----
+___
 
 ### getNodeInfo
 
@@ -400,16 +386,16 @@ The ID is not part of the hash as it can change independent of content.
 
 `Object`
 
-| Name    | Type                    |
-| :------ | :---------------------- |
-| `end`   | `undefined` \| `number` |
+| Name | Type |
+| :------ | :------ |
+| `end` | `undefined` \| `number` |
 | `start` | `undefined` \| `number` |
 
 #### Defined in
 
-[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224)
+[Node.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L219)
 
----
+___
 
 ### getText
 
@@ -421,9 +407,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228)
+[Node.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L223)
 
----
+___
 
 ### getType
 
@@ -439,9 +425,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L188)
+[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L183)
 
----
+___
 
 ### setContent
 
@@ -449,8 +435,8 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Parameters
 
-| Name    | Type     |
-| :------ | :------- |
+| Name | Type |
+| :------ | :------ |
 | `value` | `string` |
 
 #### Returns
@@ -463,9 +449,9 @@ The ID is not part of the hash as it can change independent of content.
 
 #### Defined in
 
-[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218)
+[Node.ts:213](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L213)
 
----
+___
 
 ### toJSON
 
@@ -483,4 +469,4 @@ Used with built in JSON.stringify
 
 #### Defined in
 
-[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146)
+[Node.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L141)

apps/docs/docs/api/classes/TreeSummarize.md

@@ -0,0 +1,65 @@
+---
+id: "TreeSummarize"
+title: "Class: TreeSummarize"
+sidebar_label: "TreeSummarize"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left.
+
+## Implements
+
+- `BaseResponseBuilder`
+
+## Constructors
+
+### constructor
+
+• **new TreeSummarize**(`serviceContext`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+
+#### Defined in
+
+[ResponseSynthesizer.ts:212](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L212)
+
+## Properties
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[ResponseSynthesizer.ts:210](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L210)
+
+## Methods
+
+### getResponse
+
+▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `textChunks` | `string`[] |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Implementation of
+
+BaseResponseBuilder.getResponse
+
+#### Defined in
+
+[ResponseSynthesizer.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/ResponseSynthesizer.ts#L216)

apps/docs/docs/api/classes/VectorIndexRetriever.md

@@ -0,0 +1,104 @@
+---
+id: "VectorIndexRetriever"
+title: "Class: VectorIndexRetriever"
+sidebar_label: "VectorIndexRetriever"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+VectorIndexRetriever retrieves nodes from a VectorIndex.
+
+## Implements
+
+- [`BaseRetriever`](../interfaces/BaseRetriever.md)
+
+## Constructors
+
+### constructor
+
+• **new VectorIndexRetriever**(`«destructured»`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `index` | [`VectorStoreIndex`](VectorStoreIndex.md) |
+| › `similarityTopK?` | `number` |
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22)
+
+## Properties
+
+### index
+
+• **index**: [`VectorStoreIndex`](VectorStoreIndex.md)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L18)
+
+___
+
+### serviceContext
+
+• `Private` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20)
+
+___
+
+### similarityTopK
+
+• **similarityTopK**: `number`
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L19)
+
+## Methods
+
+### getServiceContext
+
+▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Returns
+
+[`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L69)
+
+___
+
+### retrieve
+
+▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parentEvent?` | [`Event`](../interfaces/Event.md) |
+
+#### Returns
+
+`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)[]\>
+
+#### Implementation of
+
+[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve)
+
+#### Defined in
+
+[indices/vectorStore/VectorIndexRetriever.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35)

apps/docs/docs/api/classes/VectorStoreIndex.md

@@ -0,0 +1,347 @@
+---
+id: "VectorStoreIndex"
+title: "Class: VectorStoreIndex"
+sidebar_label: "VectorStoreIndex"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+The VectorStoreIndex, an index that stores the nodes only according to their vector embedings.
+
+## Hierarchy
+
+- [`BaseIndex`](BaseIndex.md)<[`IndexDict`](IndexDict.md)\>
+
+  ↳ **`VectorStoreIndex`**
+
+## Constructors
+
+### constructor
+
+• `Private` **new VectorStoreIndex**(`init`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `init` | [`VectorIndexConstructorProps`](../interfaces/VectorIndexConstructorProps.md) |
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L36)
+
+## Properties
+
+### docStore
+
+• **docStore**: `BaseDocumentStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:125](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L125)
+
+___
+
+### indexStore
+
+• `Optional` **indexStore**: `BaseIndexStore`
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
+
+#### Defined in
+
+[indices/BaseIndex.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L127)
+
+___
+
+### indexStruct
+
+• **indexStruct**: [`IndexDict`](IndexDict.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
+
+#### Defined in
+
+[indices/BaseIndex.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L128)
+
+___
+
+### serviceContext
+
+• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L123)
+
+___
+
+### storageContext
+
+• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
+
+#### Defined in
+
+[indices/BaseIndex.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L124)
+
+___
+
+### vectorStore
+
+• **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L34)
+
+## Methods
+
+### asQueryEngine
+
+▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+Create a new query engine from the index. It will also create a retriever
+and response synthezier if they are not provided.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer |
+| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - |
+| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - |
+
+#### Returns
+
+[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:223](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L223)
+
+___
+
+### asRetriever
+
+▸ **asRetriever**(`options?`): [`VectorIndexRetriever`](VectorIndexRetriever.md)
+
+Create a new retriever from the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `any` |
+
+#### Returns
+
+[`VectorIndexRetriever`](VectorIndexRetriever.md)
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L219)
+
+___
+
+### deleteRefDoc
+
+▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `refDocId` | `string` | `undefined` |
+| `deleteFromDocStore` | `boolean` | `true` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L259)
+
+___
+
+### insert
+
+▸ **insert**(`document`): `Promise`<`void`\>
+
+Insert a document into the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `document` | [`Document`](Document.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert)
+
+#### Defined in
+
+[indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L159)
+
+___
+
+### insertNodes
+
+▸ **insertNodes**(`nodes`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Overrides
+
+[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes)
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:234](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L234)
+
+___
+
+### buildIndexFromNodes
+
+▸ `Static` **buildIndexFromNodes**(`nodes`, `serviceContext`, `vectorStore`, `docStore`, `indexDict?`): `Promise`<[`IndexDict`](IndexDict.md)\>
+
+Get embeddings for nodes and place them into the index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) |
+| `docStore` | `BaseDocumentStore` |
+| `indexDict?` | [`IndexDict`](IndexDict.md) |
+
+#### Returns
+
+`Promise`<[`IndexDict`](IndexDict.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L147)
+
+___
+
+### fromDocuments
+
+▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+High level API: split documents, get embeddings, and build index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `documents` | [`Document`](Document.md)[] |
+| `args` | `Object` |
+| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
+| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
+
+#### Returns
+
+`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:194](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L194)
+
+___
+
+### getNodeEmbeddingResults
+
+▸ `Static` **getNodeEmbeddingResults**(`nodes`, `serviceContext`, `logProgress?`): `Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\>
+
+Get the embeddings for nodes.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `nodes` | [`BaseNode`](BaseNode.md)[] | `undefined` |  |
+| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` |  |
+| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) |
+
+#### Returns
+
+`Promise`<[`NodeWithEmbedding`](../interfaces/NodeWithEmbedding.md)[]\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L119)
+
+___
+
+### init
+
+▸ `Static` **init**(`options`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+The async init function should be called after the constructor.
+This is needed to handle persistence.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | [`VectorIndexOptions`](../interfaces/VectorIndexOptions.md) |
+
+#### Returns
+
+`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
+
+#### Defined in
+
+[indices/vectorStore/VectorStoreIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L47)

apps/docs/docs/api/enums/DeuceChatStrategy.md

@@ -0,0 +1,47 @@
+---
+id: "DeuceChatStrategy"
+title: "Enumeration: DeuceChatStrategy"
+sidebar_label: "DeuceChatStrategy"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### A16Z
+
+• **A16Z** = ``"a16z"``
+
+#### Defined in
+
+[llm/LLM.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L246)
+
+___
+
+### META
+
+• **META** = ``"meta"``
+
+#### Defined in
+
+[llm/LLM.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L247)
+
+___
+
+### METAWBOS
+
+• **METAWBOS** = ``"metawbos"``
+
+#### Defined in
+
+[llm/LLM.ts:248](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L248)
+
+___
+
+### REPLICATE4BIT
+
+• **REPLICATE4BIT** = ``"replicate4bit"``
+
+#### Defined in
+
+[llm/LLM.ts:251](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/llm/LLM.ts#L251)

apps/docs/docs/api/enums/IndexStructType.md

@@ -0,0 +1,27 @@
+---
+id: "IndexStructType"
+title: "Enumeration: IndexStructType"
+sidebar_label: "IndexStructType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### LIST
+
+• **LIST** = ``"list"``
+
+#### Defined in
+
+[indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L41)
+
+___
+
+### SIMPLE\_DICT
+
+• **SIMPLE\_DICT** = ``"simple_dict"``
+
+#### Defined in
+
+[indices/BaseIndex.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/BaseIndex.ts#L40)

apps/docs/docs/api/enums/ListRetrieverMode.md

@@ -0,0 +1,27 @@
+---
+id: "ListRetrieverMode"
+title: "Enumeration: ListRetrieverMode"
+sidebar_label: "ListRetrieverMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+[indices/list/ListIndex.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L30)
+
+___
+
+### LLM
+
+• **LLM** = ``"llm"``
+
+#### Defined in
+
+[indices/list/ListIndex.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/indices/list/ListIndex.ts#L32)

apps/docs/docs/api/enums/MetadataMode.md

@@ -0,0 +1,47 @@
+---
+id: "MetadataMode"
+title: "Enumeration: MetadataMode"
+sidebar_label: "MetadataMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### ALL
+
+• **ALL** = ``"ALL"``
+
+#### Defined in
+
+[Node.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L20)
+
+___
+
+### EMBED
+
+• **EMBED** = ``"EMBED"``
+
+#### Defined in
+
+[Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L21)
+
+___
+
+### LLM
+
+• **LLM** = ``"LLM"``
+
+#### Defined in
+
+[Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L22)
+
+___
+
+### NONE
+
+• **NONE** = ``"NONE"``
+
+#### Defined in
+
+[Node.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L23)

apps/docs/docs/api/enums/NodeRelationship.md

@@ -0,0 +1,57 @@
+---
+id: "NodeRelationship"
+title: "Enumeration: NodeRelationship"
+sidebar_label: "NodeRelationship"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### CHILD
+
+• **CHILD** = ``"CHILD"``
+
+#### Defined in
+
+[Node.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L9)
+
+___
+
+### NEXT
+
+• **NEXT** = ``"NEXT"``
+
+#### Defined in
+
+[Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L7)
+
+___
+
+### PARENT
+
+• **PARENT** = ``"PARENT"``
+
+#### Defined in
+
+[Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L8)
+
+___
+
+### PREVIOUS
+
+• **PREVIOUS** = ``"PREVIOUS"``
+
+#### Defined in
+
+[Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L6)
+
+___
+
+### SOURCE
+
+• **SOURCE** = ``"SOURCE"``
+
+#### Defined in
+
+[Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L5)

apps/docs/docs/api/enums/ObjectType.md

@@ -0,0 +1,47 @@
+---
+id: "ObjectType"
+title: "Enumeration: ObjectType"
+sidebar_label: "ObjectType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DOCUMENT
+
+• **DOCUMENT** = ``"DOCUMENT"``
+
+#### Defined in
+
+[Node.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L16)
+
+___
+
+### IMAGE
+
+• **IMAGE** = ``"IMAGE"``
+
+#### Defined in
+
+[Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L14)
+
+___
+
+### INDEX
+
+• **INDEX** = ``"INDEX"``
+
+#### Defined in
+
+[Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L15)
+
+___
+
+### TEXT
+
+• **TEXT** = ``"TEXT"``
+
+#### Defined in
+
+[Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Node.ts#L13)

apps/docs/docs/api/enums/SimilarityType.md

@@ -0,0 +1,40 @@
+---
+id: "SimilarityType"
+title: "Enumeration: SimilarityType"
+sidebar_label: "SimilarityType"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Similarity type
+Default is cosine similarity. Dot product and negative Euclidean distance are also supported.
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"cosine"``
+
+#### Defined in
+
+[Embedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L17)
+
+___
+
+### DOT\_PRODUCT
+
+• **DOT\_PRODUCT** = ``"dot_product"``
+
+#### Defined in
+
+[Embedding.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L18)
+
+___
+
+### EUCLIDEAN
+
+• **EUCLIDEAN** = ``"euclidean"``
+
+#### Defined in
+
+[Embedding.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/Embedding.ts#L19)

apps/docs/docs/api/enums/VectorStoreQueryMode.md

@@ -0,0 +1,77 @@
+---
+id: "VectorStoreQueryMode"
+title: "Enumeration: VectorStoreQueryMode"
+sidebar_label: "VectorStoreQueryMode"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Enumeration Members
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L12)
+
+___
+
+### HYBRID
+
+• **HYBRID** = ``"hybrid"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L14)
+
+___
+
+### LINEAR\_REGRESSION
+
+• **LINEAR\_REGRESSION** = ``"linear_regression"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L18)
+
+___
+
+### LOGISTIC\_REGRESSION
+
+• **LOGISTIC\_REGRESSION** = ``"logistic_regression"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L17)
+
+___
+
+### MMR
+
+• **MMR** = ``"mmr"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L20)
+
+___
+
+### SPARSE
+
+• **SPARSE** = ``"sparse"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L13)
+
+___
+
+### SVM
+
+• **SVM** = ``"svm"``
+
+#### Defined in
+
+[storage/vectorStore/types.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/core/src/storage/vectorStore/types.ts#L16)