chore: bump version

.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

.devcontainer/devcontainer.json

@@ -1,9 +0,0 @@
-{
-  "image": "mcr.microsoft.com/devcontainers/universal:2",
-  "features": {
-    "ghcr.io/devcontainers/features/node:1": {},
-    "ghcr.io/devcontainers-contrib/features/turborepo-npm:1": {},
-    "ghcr.io/devcontainers-contrib/features/typescript:2": {},
-    "ghcr.io/devcontainers-contrib/features/pnpm:2": {}
-  }
-}

.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-  root: true,
-  // This tells ESLint to load the config from the package `eslint-config-custom`
-  extends: ["custom"],
-  settings: {
-    next: {
-      rootDir: ["apps/*/"],
-    },
-  },
-};

.gitignore

@@ -1,40 +1,28 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# deps
+/node_modules
 
-# dependencies
-node_modules
-.pnp
-.pnp.js
+# generated content
+.contentlayer
+.content-collections
+.source
 
-# testing
-coverage
-
-# next.js
-.next/
-out/
-build
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
 
 # misc
 .DS_Store
 *.pem
-
-# debug
+/.pnp
+.pnp.js
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-# local env files
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-# turbo
-.turbo
-
-# vercel
+# others
+.env*.local
 .vercel
-
-storage/
-
-dist/
+next-env.d.ts

.husky/pre-commit

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

.husky/pre-push

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-pnpm test

.npmrc

@@ -1 +0,0 @@
-auto-install-peers = true

.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-  "editor.tabSize": 2,
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "[xml]": {
-    "editor.defaultFormatter": "redhat.vscode-xml"
-  }
-}

CONTRIBUTING.md

@@ -1,78 +0,0 @@
-# Contributing
-
-## Structure
-
-This is a monorepo built with Turborepo
-
-Right now there are two packages of importance:
-
-packages/core which is the main NPM library llamaindex
-
-apps/simple is where the demo code lives
-
-### Turborepo docs
-
-You can checkout how Turborepo works using the built in [README-turborepo.md](README-turborepo.md)
-
-## Getting Started
-
-Install NodeJS. Preferably v18 using nvm or n.
-
-Inside the LlamaIndexTS directory:
-
-```
-npm i -g pnpm ts-node
-pnpm install
-```
-
-Note: we use pnpm in this repo, which has a lot of the same functionality and CLI options as npm but it does do some things better in a monorepo, like centralizing dependencies and caching.
-
-PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces) and Turborepo had some [useful documentation also](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks).
-
-### Running Typescript
-
-When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
-
-### Test cases
-
-To run them, run
-
-```
-pnpm run test
-```
-
-To write new test cases write them in packages/core/src/tests
-
-We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch of built in assertions using the expect function: https://jestjs.io/docs/expect
-
-### Demo applications
-
-You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
-
-### Installing packages
-
-To install packages for a specific package or demo application, run
-
-```
-pnpm add [NPM Package] --filter [package or application i.e. core or simple]
-```
-
-To install packages for every package or application run
-
-```
-pnpm add -w [NPM Package]
-```
-
-### Docs
-
-To contribute to the docs, go to the docs website folder and run the Docusaurus instance.
-
-```bash
-cd apps/docs
-pnpm install
-pnpm start
-```
-
-That should start a webserver which will serve the docs on https://localhost:3000
-
-Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.

LICENSE

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) LlamaIndex 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

README-turborepo.md

@@ -1,81 +0,0 @@
-# Turborepo starter
-
-This is an official starter Turborepo.
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest
-```
-
-## What's inside?
-
-This Turborepo includes the following packages/apps:
-
-### Apps and Packages
-
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `ui`: a stub React component library shared by both `web` and `docs` applications
-- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `tsconfig`: `tsconfig.json`s used throughout the monorepo
-
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
-
-### Utilities
-
-This Turborepo has some additional tools already setup for you:
-
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
-
-### Build
-
-To build all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm build
-```
-
-### Develop
-
-To develop all apps and packages, run the following command:
-
-```
-cd my-turborepo
-pnpm dev
-```
-
-### Remote Caching
-
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
-
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
-
-```
-cd my-turborepo
-npx turbo login
-```
-
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
-
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
-
-```
-npx turbo link
-```
-
-## Useful Links
-
-Learn more about the power of Turborepo:
-
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

README.md

@@ -1,89 +1,26 @@
-# LlamaIndex.TS
+# llamaindex-ts-doc
 
-LlamaIndex is a data framework for your LLM application.
+This is a Next.js application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
 
-Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
-
-Documentation: https://ts.llamaindex.ai/
-
-## What is LlamaIndex.TS?
-
-LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you integrate large language models into your applications with your own data.
-
-## Getting started with an example:
-
-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:
+Run development server:
 
 ```bash
-export OPEN_AI_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 install llamaindex
-pnpm install @types/node
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
 ```
 
-Create the file example.ts
+Open http://localhost:3000 with your browser to see the result.
 
-```ts
-// example.ts
-import fs from "fs/promises";
-import { Document, VectorStoreIndex } from "llamaindex";
+## Learn More
 
-async function main() {
-  // Load essay from abramov.txt in Node
-  const essay = await fs.readFile(
-    "node_modules/llamaindex/examples/abramov.txt",
-    "utf-8"
-  );
+To learn more about Next.js and Fumadocs, take a look at the following
+resources:
 
-  // Create Document object with essay
-  const document = new Document({ text: essay });
-
-  // Split text and create embeddings. Store them in a VectorStoreIndex
-  const index = await VectorStoreIndex.fromDocuments([document]);
-
-  // Query the index
-  const queryEngine = index.asQueryEngine();
-  const response = await queryEngine.query(
-    "What did the author do in college?"
-  );
-
-  // Output response
-  console.log(response.toString());
-}
-
-main();
-```
-
-Then you can run it using
-
-```bash
-pnpm dlx ts-node example.ts
-```
-
-## Core concepts for getting started:
-
-- [Document](packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
-
-- [Node](packages/core/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
-
-- [Embedding](packages/core/src/Embedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that quesiton.
-
-- [Indices](packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
-
-- [QueryEngine](packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query.
-
-- [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices.
-
-- [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.
-
-## Contributing:
-
-We are in the very early days of LlamaIndex.TS. If you’re interested in hacking on it with us check out our [contributing guide](CONTRIBUTING.md)
-
-## Bugs? Questions?
-
-Please join our Discord! https://discord.com/invite/eN6D2HQ4aX
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs

app/(home)/layout.tsx

@@ -0,0 +1,11 @@
+import type { ReactNode } from 'react';
+import { HomeLayout } from 'fumadocs-ui/home-layout';
+import { baseOptions } from '../layout.config';
+
+export default function Layout({
+  children,
+}: {
+  children: ReactNode;
+}): React.ReactElement {
+  return <HomeLayout {...baseOptions}>{children}</HomeLayout>;
+}

app/(home)/page.tsx

@@ -0,0 +1,19 @@
+import Link from 'next/link';
+
+export default function HomePage() {
+  return (
+    <main className="flex h-screen flex-col justify-center text-center">
+      <h1 className="mb-4 text-2xl font-bold">Hello World</h1>
+      <p className="text-fd-muted-foreground">
+        You can open{' '}
+        <Link
+          href="/docs"
+          className="text-fd-foreground font-semibold underline"
+        >
+          /docs
+        </Link>{' '}
+        and see the documentation.
+      </p>
+    </main>
+  );
+}

app/api/search/route.ts

@@ -0,0 +1,12 @@
+import { source } from '@/app/source';
+import { createSearchAPI } from 'fumadocs-core/search/server';
+
+export const { GET } = createSearchAPI('advanced', {
+  indexes: source.getPages().map((page) => ({
+    title: page.data.title,
+    description: page.data.description,
+    structuredData: page.data.structuredData,
+    id: page.url,
+    url: page.url,
+  })),
+});

app/docs/[[...slug]]/page.tsx

@@ -0,0 +1,45 @@
+import { source } from '@/app/source';
+import type { Metadata } from 'next';
+import {
+  DocsPage,
+  DocsBody,
+  DocsDescription,
+  DocsTitle,
+} from 'fumadocs-ui/page';
+import { notFound } from 'next/navigation';
+import defaultMdxComponents from 'fumadocs-ui/mdx';
+
+export default async function Page({
+  params,
+}: {
+  params: { slug?: string[] };
+}) {
+  const page = source.getPage(params.slug);
+  if (!page) notFound();
+
+  const MDX = page.data.body;
+
+  return (
+    <DocsPage toc={page.data.toc} full={page.data.full}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDX components={{ ...defaultMdxComponents }} />
+      </DocsBody>
+    </DocsPage>
+  );
+}
+
+export async function generateStaticParams() {
+  return source.generateParams();
+}
+
+export function generateMetadata({ params }: { params: { slug?: string[] } }) {
+  const page = source.getPage(params.slug);
+  if (!page) notFound();
+
+  return {
+    title: page.data.title,
+    description: page.data.description,
+  } satisfies Metadata;
+}

app/docs/layout.tsx

@@ -0,0 +1,12 @@
+import { DocsLayout } from 'fumadocs-ui/layout';
+import type { ReactNode } from 'react';
+import { baseOptions } from '../layout.config';
+import { source } from '@/app/source';
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <DocsLayout tree={source.pageTree} {...baseOptions}>
+      {children}
+    </DocsLayout>
+  );
+}

app/global.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

app/layout.config.tsx

@@ -0,0 +1,21 @@
+import { type HomeLayoutProps } from 'fumadocs-ui/home-layout';
+
+/**
+ * Shared layout configurations
+ *
+ * you can configure layouts individually from:
+ * Home Layout: app/(home)/layout.tsx
+ * Docs Layout: app/docs/layout.tsx
+ */
+export const baseOptions: HomeLayoutProps = {
+  nav: {
+    title: 'My App',
+  },
+  links: [
+    {
+      text: 'Documentation',
+      url: '/docs',
+      active: 'nested-url',
+    },
+  ],
+};

app/layout.tsx

@@ -0,0 +1,18 @@
+import './global.css';
+import { RootProvider } from 'fumadocs-ui/provider';
+import { Inter } from 'next/font/google';
+import type { ReactNode } from 'react';
+
+const inter = Inter({
+  subsets: ['latin'],
+});
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <html lang="en" className={inter.className} suppressHydrationWarning>
+      <body>
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  );
+}

app/source.ts

@@ -0,0 +1,8 @@
+import { docs, meta } from '@/.source';
+import { createMDXSource } from 'fumadocs-mdx';
+import { loader } from 'fumadocs-core/source';
+
+export const source = loader({
+  baseUrl: '/docs',
+  source: createMDXSource(docs, meta),
+});

apps/docs/.gitignore

@@ -1,20 +0,0 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*

apps/docs/README-docusaurus.md

@@ -1,47 +0,0 @@
-# Website
-
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```
-$ pnpm
-```
-
-### Local Development
-
-```
-$ pnpm start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-However, the searchbar may not function with `yarn start`. Instead, run `yarn build` and launch a server:
-
-```
-$ npx http-server ./build
-```
-
-### Build
-
-```
-$ pnpm build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true pnpm deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> pnpm deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

apps/docs/babel.config.js

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

apps/docs/docs/api/_category_.yml

@@ -1,2 +0,0 @@
-label: "API"
-position: 6

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

@@ -1,81 +0,0 @@
----
-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:206](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L206)
-
-___
-
-### getTextEmbedding
-
-▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Defined in
-
-[Embedding.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L205)
-
-___
-
-### 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:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197)

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

@@ -1,153 +0,0 @@
----
-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:78](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L78)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
-
-___
-
-### indexStruct
-
-• **indexStruct**: `T`
-
-#### Defined in
-
-[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Defined in
-
-[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74)
-
-## 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:98](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L98)
-
-___
-
-### 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:91](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L91)

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

@@ -1,287 +0,0 @@
----
-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:48](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L48)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
-
-___
-
-### getContent
-
-▸ `Abstract` **getContent**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L54)
-
-___
-
-### getEmbedding
-
-▸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-▸ `Abstract` **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L55)
-
-___
-
-### getType
-
-▸ `Abstract` **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Defined in
-
-[Node.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L52)
-
-___
-
-### setContent
-
-▸ `Abstract` **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L56)

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

@@ -1,83 +0,0 @@
----
-id: "CallbackManager"
-title: "Class: CallbackManager"
-sidebar_label: "CallbackManager"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Implements
-
-- `CallbackManagerMethods`
-
-## Constructors
-
-### constructor
-
-• **new CallbackManager**(`handlers?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `handlers?` | `CallbackManagerMethods` |
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L68)
-
-## Properties
-
-### onLLMStream
-
-• `Optional` **onLLMStream**: (`params`: [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md)) => `void` \| `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (`params`): `void` \| `Promise`<`void`\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `params` | [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md) |
-
-##### Returns
-
-`void` \| `Promise`<`void`\>
-
-#### Implementation of
-
-CallbackManagerMethods.onLLMStream
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L65)
-
-___
-
-### onRetrieve
-
-• `Optional` **onRetrieve**: (`params`: [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md)) => `void` \| `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (`params`): `void` \| `Promise`<`void`\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `params` | [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md) |
-
-##### Returns
-
-`void` \| `Promise`<`void`\>
-
-#### Implementation of
-
-CallbackManagerMethods.onRetrieve
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L66)

apps/docs/docs/api/classes/ChatGPTLLMPredictor.md

@@ -1,114 +0,0 @@
----
-id: "ChatGPTLLMPredictor"
-title: "Class: ChatGPTLLMPredictor"
-sidebar_label: "ChatGPTLLMPredictor"
-sidebar_position: 0
-custom_edit_url: null
----
-
-ChatGPTLLMPredictor is a predictor that uses GPT.
-
-## Implements
-
-- [`BaseLLMPredictor`](../interfaces/BaseLLMPredictor.md)
-
-## Constructors
-
-### constructor
-
-• **new ChatGPTLLMPredictor**(`props?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `props?` | `Partial`<[`ChatGPTLLMPredictor`](ChatGPTLLMPredictor.md)\> |
-
-#### Defined in
-
-[LLMPredictor.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L26)
-
-## Properties
-
-### callbackManager
-
-• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
-
-#### Defined in
-
-[LLMPredictor.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L24)
-
-___
-
-### languageModel
-
-• **languageModel**: [`OpenAI`](OpenAI.md)
-
-#### Defined in
-
-[LLMPredictor.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L23)
-
-___
-
-### model
-
-• **model**: ``"gpt-3.5-turbo"`` \| ``"gpt-3.5-turbo-16k"`` \| ``"gpt-4"`` \| ``"gpt-4-32k"``
-
-#### Defined in
-
-[LLMPredictor.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L21)
-
-___
-
-### retryOnThrottling
-
-• **retryOnThrottling**: `boolean`
-
-#### Defined in
-
-[LLMPredictor.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L22)
-
-## Methods
-
-### getLlmMetadata
-
-▸ **getLlmMetadata**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[getLlmMetadata](../interfaces/BaseLLMPredictor.md#getllmmetadata)
-
-#### Defined in
-
-[LLMPredictor.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L45)
-
-___
-
-### predict
-
-▸ **predict**(`prompt`, `input?`, `parentEvent?`, `logProgress?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) | `undefined` |
-| `input?` | `Record`<`string`, `string`\> | `undefined` |
-| `parentEvent?` | [`Event`](../interfaces/Event.md) | `undefined` |
-| `logProgress` | `boolean` | `false` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[predict](../interfaces/BaseLLMPredictor.md#predict)
-
-#### Defined in
-
-[LLMPredictor.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L49)

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

@@ -1,106 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L181)

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

@@ -1,148 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L71)
-
-___
-
-### condenseMessagePrompt
-
-• **condenseMessagePrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ChatEngine.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L73)
-
-___
-
-### queryEngine
-
-• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-#### Defined in
-
-[ChatEngine.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L70)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ChatEngine.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L118)

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

@@ -1,111 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L131)
-
-___
-
-### chatModel
-
-• **chatModel**: [`OpenAI`](OpenAI.md)
-
-#### Defined in
-
-[ChatEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L130)
-
-___
-
-### retriever
-
-• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Defined in
-
-[ChatEngine.ts:129](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L182)

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

@@ -1,496 +0,0 @@
----
-id: "Document"
-title: "Class: Document"
-sidebar_label: "Document"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A document is just a special text node with a docId.
-
-## Hierarchy
-
-- [`TextNode`](TextNode.md)
-
-  ↳ **`Document`**
-
-## Constructors
-
-### constructor
-
-• **new Document**(`init?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init?` | `Partial`<[`Document`](Document.md)\> |
-
-#### Overrides
-
-[TextNode](TextNode.md).[constructor](TextNode.md#constructor)
-
-#### Defined in
-
-[Node.ts:216](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L216)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[embedding](TextNode.md#embedding)
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx)
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys)
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys)
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[hash](TextNode.md#hash)
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[id_](TextNode.md#id_)
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadata](TextNode.md#metadata)
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator)
-
-#### Defined in
-
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[relationships](TextNode.md#relationships)
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx)
-
-#### Defined in
-
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[text](TextNode.md#text)
-
-#### Defined in
-
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Inherited from
-
-TextNode.childNodes
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
-
-___
-
-### docId
-
-• `get` **docId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L225)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.nextNode
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-TextNode.nodeId
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.parentNode
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.prevNode
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.sourceNode
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-▸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash)
-
-#### Defined in
-
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
-
-___
-
-### getContent
-
-▸ **getContent**(`metadataMode?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getContent](TextNode.md#getcontent)
-
-#### Defined in
-
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
-
-___
-
-### getEmbedding
-
-▸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding)
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-▸ **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr)
-
-#### Defined in
-
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
-
-___
-
-### getNodeInfo
-
-▸ **getNodeInfo**(): `Object`
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `end` | `undefined` \| `number` |
-| `start` | `undefined` \| `number` |
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo)
-
-#### Defined in
-
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
-
-___
-
-### getText
-
-▸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getText](TextNode.md#gettext)
-
-#### Defined in
-
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
-
-___
-
-### getType
-
-▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Overrides
-
-[TextNode](TextNode.md).[getType](TextNode.md#gettype)
-
-#### Defined in
-
-[Node.ts:221](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L221)
-
-___
-
-### setContent
-
-▸ **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[setContent](TextNode.md#setcontent)
-
-#### Defined in
-
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)

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

@@ -1,129 +0,0 @@
----
-id: "InMemoryFileSystem"
-title: "Class: InMemoryFileSystem"
-sidebar_label: "InMemoryFileSystem"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A filesystem implementation that stores files in memory.
-
-## Implements
-
-- [`GenericFileSystem`](../interfaces/GenericFileSystem.md)
-
-## Constructors
-
-### constructor
-
-• **new InMemoryFileSystem**()
-
-## Properties
-
-### files
-
-• `Private` **files**: `Record`<`string`, `any`\> = `{}`
-
-#### Defined in
-
-[storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L25)
-
-## Methods
-
-### access
-
-▸ **access**(`path`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[GenericFileSystem](../interfaces/GenericFileSystem.md).[access](../interfaces/GenericFileSystem.md#access)
-
-#### Defined in
-
-[storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L38)
-
-___
-
-### mkdir
-
-▸ **mkdir**(`path`, `options?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[GenericFileSystem](../interfaces/GenericFileSystem.md).[mkdir](../interfaces/GenericFileSystem.md#mkdir)
-
-#### Defined in
-
-[storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L44)
-
-___
-
-### readFile
-
-▸ **readFile**(`path`, `options?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-[GenericFileSystem](../interfaces/GenericFileSystem.md).[readFile](../interfaces/GenericFileSystem.md#readfile)
-
-#### Defined in
-
-[storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L31)
-
-___
-
-### writeFile
-
-▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `content` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[GenericFileSystem](../interfaces/GenericFileSystem.md).[writeFile](../interfaces/GenericFileSystem.md#writefile)
-
-#### Defined in
-
-[storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L27)

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

@@ -1,123 +0,0 @@
----
-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/5a765aa/packages/core/src/indices/BaseIndex.ts#L19)
-
-## Properties
-
-### docStore
-
-• **docStore**: `Record`<`string`, [`Document`](Document.md)\> = `{}`
-
-#### Defined in
-
-[indices/BaseIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L34)
-
-___
-
-### 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/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
-
-___
-
-### nodesDict
-
-• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)\> = `{}`
-
-#### Defined in
-
-[indices/BaseIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L33)
-
-___
-
-### 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/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
-
-## Methods
-
-### addNode
-
-▸ **addNode**(`node`, `textId?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | [`BaseNode`](BaseNode.md) |
-| `textId?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[indices/BaseIndex.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L43)
-
-___
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
-
-#### Defined in
-
-[indices/BaseIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L36)

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

@@ -1,112 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
-
-___
-
-### nodes
-
-• **nodes**: `string`[] = `[]`
-
-#### Defined in
-
-[indices/BaseIndex.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L50)
-
-___
-
-### 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/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
-
-## Methods
-
-### addNode
-
-▸ **addNode**(`node`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | [`BaseNode`](BaseNode.md) |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[indices/BaseIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L52)
-
-___
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
-
-#### Defined in
-
-[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24)

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

@@ -1,492 +0,0 @@
----
-id: "IndexNode"
-title: "Class: IndexNode"
-sidebar_label: "IndexNode"
-sidebar_position: 0
-custom_edit_url: null
----
-
-TextNode is the default node type for text. Most common node type in LlamaIndex.TS
-
-## Hierarchy
-
-- [`TextNode`](TextNode.md)
-
-  ↳ **`IndexNode`**
-
-## Constructors
-
-### constructor
-
-• **new IndexNode**(`init?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init?` | `Partial`<[`TextNode`](TextNode.md)\> |
-
-#### Inherited from
-
-[TextNode](TextNode.md).[constructor](TextNode.md#constructor)
-
-#### Defined in
-
-[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L144)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[embedding](TextNode.md#embedding)
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx)
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys)
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys)
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[hash](TextNode.md#hash)
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[id_](TextNode.md#id_)
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
-
-___
-
-### indexId
-
-• **indexId**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L205)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadata](TextNode.md#metadata)
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator)
-
-#### Defined in
-
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[relationships](TextNode.md#relationships)
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx)
-
-#### Defined in
-
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[text](TextNode.md#text)
-
-#### Defined in
-
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Inherited from
-
-TextNode.childNodes
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.nextNode
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-TextNode.nodeId
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.parentNode
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.prevNode
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-TextNode.sourceNode
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-▸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash)
-
-#### Defined in
-
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
-
-___
-
-### getContent
-
-▸ **getContent**(`metadataMode?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getContent](TextNode.md#getcontent)
-
-#### Defined in
-
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
-
-___
-
-### getEmbedding
-
-▸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding)
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-▸ **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr)
-
-#### Defined in
-
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
-
-___
-
-### getNodeInfo
-
-▸ **getNodeInfo**(): `Object`
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `end` | `undefined` \| `number` |
-| `start` | `undefined` \| `number` |
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo)
-
-#### Defined in
-
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
-
-___
-
-### getText
-
-▸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[getText](TextNode.md#gettext)
-
-#### Defined in
-
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
-
-___
-
-### getType
-
-▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Overrides
-
-[TextNode](TextNode.md).[getType](TextNode.md#gettype)
-
-#### Defined in
-
-[Node.ts:207](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L207)
-
-___
-
-### setContent
-
-▸ **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[TextNode](TextNode.md).[setContent](TextNode.md#setcontent)
-
-#### Defined in
-
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)

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

@@ -1,68 +0,0 @@
----
-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/5a765aa/packages/core/src/indices/BaseIndex.ts#L19)
-
-## Properties
-
-### indexId
-
-• **indexId**: `string`
-
-#### Defined in
-
-[indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L16)
-
-___
-
-### summary
-
-• `Optional` **summary**: `string`
-
-#### Defined in
-
-[indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L17)
-
-## Methods
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L24)

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

@@ -1,84 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/QuestionGenerator.ts#L32)
-
-___
-
-### prompt
-
-• **prompt**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/packages/core/src/QuestionGenerator.ts#L40)

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

@@ -1,294 +0,0 @@
----
-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:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L41)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
-
-#### Defined in
-
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
-
-#### Defined in
-
-[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
-
-___
-
-### indexStruct
-
-• **indexStruct**: [`IndexList`](IndexList.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
-
-#### Defined in
-
-[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
-
-#### Defined in
-
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
-
-#### Defined in
-
-[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
-
-#### Defined in
-
-[indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L74)
-
-## Methods
-
-### \_deleteNode
-
-▸ `Protected` **_deleteNode**(`nodeId`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeId` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[indices/list/ListIndex.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L160)
-
-___
-
-### \_insert
-
-▸ `Protected` **_insert**(`nodes`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodes` | [`BaseNode`](BaseNode.md)[] |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[indices/list/ListIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L154)
-
-___
-
-### 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:118](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L118)
-
-___
-
-### 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:105](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L105)
-
-___
-
-### getRefDocInfo
-
-▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, `RefDocInfo`\>\>
-
-#### Returns
-
-`Promise`<`Record`<`string`, `RefDocInfo`\>\>
-
-#### Defined in
-
-[indices/list/ListIndex.ts:166](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L166)
-
-___
-
-### \_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:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L139)
-
-___
-
-### fromDocuments
-
-▸ `Static` **fromDocuments**(`args`): `Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `args` | `Object` |
-| `args.documents` | [`Document`](Document.md)[] |
-| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
-| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
-
-#### Returns
-
-`Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Defined in
-
-[indices/list/ListIndex.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L81)
-
-___
-
-### init
-
-▸ `Static` **init**(`options`): `Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `options` | `ListIndexOptions` |
-
-#### Returns
-
-`Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Defined in
-
-[indices/list/ListIndex.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L45)

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

@@ -1,137 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L81)

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

@@ -1,82 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/indices/list/ListIndexRetriever.ts#L26)

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

@@ -1,143 +0,0 @@
----
-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:179](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L179)
-
-## Properties
-
-### maxTokens
-
-• `Optional` **maxTokens**: `number`
-
-#### Defined in
-
-[llm/LLM.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L176)
-
-___
-
-### model
-
-• **model**: ``"Llama-2-70b-chat"`` \| ``"Llama-2-13b-chat"`` \| ``"Llama-2-7b-chat"``
-
-#### Defined in
-
-[llm/LLM.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L174)
-
-___
-
-### replicateSession
-
-• **replicateSession**: `ReplicateSession`
-
-#### Defined in
-
-[llm/LLM.ts:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L177)
-
-___
-
-### temperature
-
-• **temperature**: `number`
-
-#### Defined in
-
-[llm/LLM.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L175)
-
-## 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:199](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L199)
-
-___
-
-### 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:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L224)
-
-___
-
-### mapMessageType
-
-▸ **mapMessageType**(`messageType`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `messageType` | `MessageType` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[llm/LLM.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L186)

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

@@ -1,183 +0,0 @@
----
-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)\> |
-
-#### Defined in
-
-[llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L75)
-
-## Properties
-
-### callbackManager
-
-• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
-
-#### Defined in
-
-[llm/LLM.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L73)
-
-___
-
-### maxRetries
-
-• **maxRetries**: `number`
-
-#### Defined in
-
-[llm/LLM.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L71)
-
-___
-
-### maxTokens
-
-• `Optional` **maxTokens**: `number`
-
-#### Defined in
-
-[llm/LLM.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L69)
-
-___
-
-### model
-
-• **model**: ``"gpt-3.5-turbo"`` \| ``"gpt-3.5-turbo-16k"`` \| ``"gpt-4"`` \| ``"gpt-4-32k"``
-
-#### Defined in
-
-[llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L66)
-
-___
-
-### n
-
-• **n**: `number` = `1`
-
-#### Defined in
-
-[llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L68)
-
-___
-
-### requestTimeout
-
-• **requestTimeout**: ``null`` \| `number`
-
-#### Defined in
-
-[llm/LLM.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L72)
-
-___
-
-### session
-
-• **session**: `OpenAISession`
-
-#### Defined in
-
-[llm/LLM.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L70)
-
-___
-
-### temperature
-
-• **temperature**: `number`
-
-#### Defined in
-
-[llm/LLM.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L67)
-
-## 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:102](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L102)
-
-___
-
-### 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:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L144)
-
-___
-
-### mapMessageType
-
-▸ **mapMessageType**(`messageType`): `ChatCompletionRequestMessageRoleEnum`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `messageType` | `MessageType` |
-
-#### Returns
-
-`ChatCompletionRequestMessageRoleEnum`
-
-#### Defined in
-
-[llm/LLM.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L85)

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

@@ -1,141 +0,0 @@
----
-id: "OpenAIEmbedding"
-title: "Class: OpenAIEmbedding"
-sidebar_label: "OpenAIEmbedding"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Hierarchy
-
-- [`BaseEmbedding`](BaseEmbedding.md)
-
-  ↳ **`OpenAIEmbedding`**
-
-## Constructors
-
-### constructor
-
-• **new OpenAIEmbedding**()
-
-#### Overrides
-
-[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor)
-
-#### Defined in
-
-[Embedding.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L217)
-
-## Properties
-
-### model
-
-• **model**: `TEXT_EMBED_ADA_002`
-
-#### Defined in
-
-[Embedding.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L215)
-
-___
-
-### session
-
-• **session**: `OpenAISession`
-
-#### Defined in
-
-[Embedding.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L214)
-
-## Methods
-
-### getOpenAIEmbedding
-
-▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Defined in
-
-[Embedding.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L224)
-
-___
-
-### 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:240](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L240)
-
-___
-
-### 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:236](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L236)
-
-___
-
-### 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:197](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L197)

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

@@ -1,44 +0,0 @@
----
-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:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/PDFReader.ts#L12)

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

@@ -1,139 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L76)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L74)
-
-___
-
-### textQATemplate
-
-• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L149)

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

@@ -1,74 +0,0 @@
----
-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/5a765aa/packages/core/src/Response.ts#L10)
-
-## Properties
-
-### response
-
-• **response**: `string`
-
-#### Defined in
-
-[Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L7)
-
-___
-
-### sourceNodes
-
-• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)[]
-
-#### Defined in
-
-[Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L8)
-
-## Methods
-
-### getFormattedSources
-
-▸ **getFormattedSources**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L15)
-
-___
-
-### toString
-
-▸ **toString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Response.ts#L19)

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

@@ -1,69 +0,0 @@
----
-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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L285)
-
-## Properties
-
-### responseBuilder
-
-• **responseBuilder**: `BaseResponseBuilder`
-
-#### Defined in
-
-[ResponseSynthesizer.ts:282](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ResponseSynthesizer.ts#L282)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:283](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L297)

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

@@ -1,77 +0,0 @@
----
-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/5a765aa/packages/core/src/QueryEngine.ts#L34)
-
-## Properties
-
-### responseSynthesizer
-
-• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
-
-#### Defined in
-
-[QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L32)
-
-___
-
-### retriever
-
-• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Defined in
-
-[QueryEngine.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/packages/core/src/QueryEngine.ts#L45)

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

@@ -1,236 +0,0 @@
----
-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.
-
-## 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:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L33)
-
-## Properties
-
-### chunkOverlap
-
-• `Private` **chunkOverlap**: `number`
-
-#### Defined in
-
-[TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L26)
-
-___
-
-### chunkSize
-
-• `Private` **chunkSize**: `number`
-
-#### Defined in
-
-[TextSplitter.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L25)
-
-___
-
-### chunkingTokenizerFn
-
-• `Private` **chunkingTokenizerFn**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L30)
-
-___
-
-### paragraphSeparator
-
-• `Private` **paragraphSeparator**: `string`
-
-#### Defined in
-
-[TextSplitter.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L29)
-
-___
-
-### tokenizer
-
-• `Private` **tokenizer**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L27)
-
-___
-
-### tokenizerDecoder
-
-• `Private` **tokenizerDecoder**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L28)
-
-## Methods
-
-### combineTextSplits
-
-▸ **combineTextSplits**(`newSentenceSplits`, `effectiveChunkSize`): `TextSplit`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `newSentenceSplits` | `SplitRep`[] |
-| `effectiveChunkSize` | `number` |
-
-#### Returns
-
-`TextSplit`[]
-
-#### Defined in
-
-[TextSplitter.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L153)
-
-___
-
-### getEffectiveChunkSize
-
-▸ `Private` **getEffectiveChunkSize**(`extraInfoStr?`): `number`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `extraInfoStr?` | `string` |
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[TextSplitter.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L72)
-
-___
-
-### getParagraphSplits
-
-▸ **getParagraphSplits**(`text`, `effectiveChunkSize?`): `string`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-| `effectiveChunkSize?` | `number` |
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[TextSplitter.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L89)
-
-___
-
-### getSentenceSplits
-
-▸ **getSentenceSplits**(`text`, `effectiveChunkSize?`): `string`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-| `effectiveChunkSize?` | `number` |
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[TextSplitter.ts:115](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L115)
-
-___
-
-### processSentenceSplits
-
-▸ `Private` **processSentenceSplits**(`sentenceSplits`, `effectiveChunkSize`): `SplitRep`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `sentenceSplits` | `string`[] |
-| `effectiveChunkSize` | `number` |
-
-#### Returns
-
-`SplitRep`[]
-
-#### Defined in
-
-[TextSplitter.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L128)
-
-___
-
-### splitText
-
-▸ **splitText**(`text`, `extraInfoStr?`): `string`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-| `extraInfoStr?` | `string` |
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[TextSplitter.ts:233](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L233)
-
-___
-
-### splitTextWithOverlaps
-
-▸ **splitTextWithOverlaps**(`text`, `extraInfoStr?`): `TextSplit`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-| `extraInfoStr?` | `string` |
-
-#### Returns
-
-`TextSplit`[]
-
-#### Defined in
-
-[TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/TextSplitter.ts#L205)

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

@@ -1,96 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L37)
-
-___
-
-### llm
-
-• **llm**: [`LLM`](../interfaces/LLM.md)
-
-#### Defined in
-
-[ChatEngine.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ChatEngine.ts#L54)

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

@@ -1,43 +0,0 @@
----
-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/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L37)

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

@@ -1,114 +0,0 @@
----
-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:64](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L64)
-
-## Properties
-
-### includeMetadata
-
-• **includeMetadata**: `boolean`
-
-#### Defined in
-
-[NodeParser.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L61)
-
-___
-
-### includePrevNextRel
-
-• **includePrevNextRel**: `boolean`
-
-#### Defined in
-
-[NodeParser.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L62)
-
-___
-
-### textSplitter
-
-• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md)
-
-#### Defined in
-
-[NodeParser.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L60)
-
-## 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:95](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L95)
-
-___
-
-### 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:82](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L82)

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

@@ -1,75 +0,0 @@
----
-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/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L46)
-
-___
-
-### textQATemplate
-
-• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L54)

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

@@ -1,67 +0,0 @@
----
-id: "SubQuestionOutputParser"
-title: "Class: SubQuestionOutputParser"
-sidebar_label: "SubQuestionOutputParser"
-sidebar_position: 0
-custom_edit_url: null
----
-
-SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator.
-
-## Implements
-
-- [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\>
-
-## Constructors
-
-### constructor
-
-• **new SubQuestionOutputParser**()
-
-## Methods
-
-### format
-
-▸ **format**(`output`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `output` | `string` |
-
-#### Returns
-
-`string`
-
-#### Implementation of
-
-[BaseOutputParser](../interfaces/BaseOutputParser.md).[format](../interfaces/BaseOutputParser.md#format)
-
-#### Defined in
-
-[OutputParser.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L97)
-
-___
-
-### parse
-
-▸ **parse**(`output`): [`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `output` | `string` |
-
-#### Returns
-
-[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>
-
-#### Implementation of
-
-[BaseOutputParser](../interfaces/BaseOutputParser.md).[parse](../interfaces/BaseOutputParser.md#parse)
-
-#### Defined in
-
-[OutputParser.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L89)

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

@@ -1,143 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/QueryEngine.ts#L62)
-
-___
-
-### questionGen
-
-• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
-
-#### Defined in
-
-[QueryEngine.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L61)
-
-___
-
-### responseSynthesizer
-
-• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
-
-#### Defined in
-
-[QueryEngine.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/QueryEngine.ts#L82)

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

@@ -1,44 +0,0 @@
----
-id: "TextFileReader"
-title: "Class: TextFileReader"
-sidebar_label: "TextFileReader"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Read a .txt file
-
-## Implements
-
-- [`BaseReader`](../interfaces/BaseReader.md)
-
-## Constructors
-
-### constructor
-
-• **new TextFileReader**()
-
-## Methods
-
-### loadData
-
-▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `file` | `string` |
-| `fs` | [`CompleteFileSystem`](../modules.md#completefilesystem) |
-
-#### Returns
-
-`Promise`<[`Document`](Document.md)[]\>
-
-#### Implementation of
-
-[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata)
-
-#### Defined in
-
-[readers/SimpleDirectoryReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/SimpleDirectoryReader.ts#L12)

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

@@ -1,458 +0,0 @@
----
-id: "TextNode"
-title: "Class: TextNode"
-sidebar_label: "TextNode"
-sidebar_position: 0
-custom_edit_url: null
----
-
-TextNode is the default node type for text. Most common node type in LlamaIndex.TS
-
-## Hierarchy
-
-- [`BaseNode`](BaseNode.md)
-
-  ↳ **`TextNode`**
-
-  ↳↳ [`IndexNode`](IndexNode.md)
-
-  ↳↳ [`Document`](Document.md)
-
-## Constructors
-
-### constructor
-
-• **new TextNode**(`init?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init?` | `Partial`<[`TextNode`](TextNode.md)\> |
-
-#### Overrides
-
-[BaseNode](BaseNode.md).[constructor](BaseNode.md#constructor)
-
-#### Defined in
-
-[Node.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L144)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[embedding](BaseNode.md#embedding)
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L139)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[excludedEmbedMetadataKeys](BaseNode.md#excludedembedmetadatakeys)
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[excludedLlmMetadataKeys](BaseNode.md#excludedllmmetadatakeys)
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[hash](BaseNode.md#hash)
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[id_](BaseNode.md#id_)
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L38)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[metadata](BaseNode.md#metadata)
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Defined in
-
-[Node.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L142)
-
-___
-
-### relationships
-
-• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../modules.md#relatednodetype)\>\> = `{}`
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[relationships](BaseNode.md#relationships)
-
-#### Defined in
-
-[Node.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Defined in
-
-[Node.ts:138](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L138)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L137)
-
-## Accessors
-
-### childNodes
-
-• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)[]
-
-#### Inherited from
-
-BaseNode.childNodes
-
-#### Defined in
-
-[Node.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L104)
-
-___
-
-### nextNode
-
-• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-BaseNode.nextNode
-
-#### Defined in
-
-[Node.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-BaseNode.nodeId
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L58)
-
-___
-
-### parentNode
-
-• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-BaseNode.parentNode
-
-#### Defined in
-
-[Node.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L94)
-
-___
-
-### prevNode
-
-• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-BaseNode.prevNode
-
-#### Defined in
-
-[Node.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L72)
-
-___
-
-### sourceNode
-
-• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-BaseNode.sourceNode
-
-#### Defined in
-
-[Node.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L62)
-
-## Methods
-
-### asRelatedNodeInfo
-
-▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Returns
-
-[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[asRelatedNodeInfo](BaseNode.md#asrelatednodeinfo)
-
-#### Defined in
-
-[Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-▸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[Node.ts:149](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L149)
-
-___
-
-### getContent
-
-▸ **getContent**(`metadataMode?`): `string`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[BaseNode](BaseNode.md).[getContent](BaseNode.md#getcontent)
-
-#### Defined in
-
-[Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L157)
-
-___
-
-### getEmbedding
-
-▸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[BaseNode](BaseNode.md).[getEmbedding](BaseNode.md#getembedding)
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L116)
-
-___
-
-### getMetadataStr
-
-▸ **getMetadataStr**(`metadataMode`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[BaseNode](BaseNode.md).[getMetadataStr](BaseNode.md#getmetadatastr)
-
-#### Defined in
-
-[Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L162)
-
-___
-
-### getNodeInfo
-
-▸ **getNodeInfo**(): `Object`
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `end` | `undefined` \| `number` |
-| `start` | `undefined` \| `number` |
-
-#### Defined in
-
-[Node.ts:187](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L187)
-
-___
-
-### getText
-
-▸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L191)
-
-___
-
-### getType
-
-▸ **getType**(): [`ObjectType`](../enums/ObjectType.md)
-
-#### Returns
-
-[`ObjectType`](../enums/ObjectType.md)
-
-#### Overrides
-
-[BaseNode](BaseNode.md).[getType](BaseNode.md#gettype)
-
-#### Defined in
-
-[Node.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L153)
-
-___
-
-### setContent
-
-▸ **setContent**(`value`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `string` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[BaseNode](BaseNode.md).[setContent](BaseNode.md#setcontent)
-
-#### Defined in
-
-[Node.ts:183](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L183)

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

@@ -1,65 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/ResponseSynthesizer.ts#L216)

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

@@ -1,104 +0,0 @@
----
-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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/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/5a765aa/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L35)

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

@@ -1,270 +0,0 @@
----
-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:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L35)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
-
-#### Defined in
-
-[indices/BaseIndex.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L73)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
-
-#### Defined in
-
-[indices/BaseIndex.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L75)
-
-___
-
-### indexStruct
-
-• **indexStruct**: [`IndexDict`](IndexDict.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
-
-#### Defined in
-
-[indices/BaseIndex.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L76)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
-
-#### Defined in
-
-[indices/BaseIndex.ts:71](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L71)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
-
-#### Defined in
-
-[indices/BaseIndex.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L72)
-
-___
-
-### vectorStore
-
-• **vectorStore**: `VectorStore`
-
-#### Overrides
-
-[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
-
-#### Defined in
-
-[indices/vectorStore/VectorStoreIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L33)
-
-## 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:181](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L181)
-
-___
-
-### 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:177](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L177)
-
-___
-
-### buildIndexFromNodes
-
-▸ `Static` **buildIndexFromNodes**(`nodes`, `serviceContext`, `vectorStore`, `docStore`): `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` |
-| `docStore` | `BaseDocumentStore` |
-
-#### Returns
-
-`Promise`<[`IndexDict`](IndexDict.md)\>
-
-#### Defined in
-
-[indices/vectorStore/VectorStoreIndex.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L120)
-
-___
-
-### fromDocuments
-
-▸ `Static` **fromDocuments**(`documents`, `storageContext?`, `serviceContext?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
-
-High level API: split documents, get embeddings, and build index.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `documents` | [`Document`](Document.md)[] |
-| `storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
-| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
-
-#### Returns
-
-`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
-
-#### Defined in
-
-[indices/vectorStore/VectorStoreIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L155)
-
-___
-
-### 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:92](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L92)
-
-___
-
-### 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:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L46)

apps/docs/docs/api/classes/_category_.yml

@@ -1,2 +0,0 @@
-label: "Classes"
-position: 3

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

@@ -1,27 +0,0 @@
----
-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:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L25)
-
-___
-
-### LLM
-
-• **LLM** = ``"llm"``
-
-#### Defined in
-
-[indices/list/ListIndex.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/list/ListIndex.ts#L27)

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

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

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

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

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

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

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

@@ -1,40 +0,0 @@
----
-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:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L10)
-
-___
-
-### DOT\_PRODUCT
-
-• **DOT\_PRODUCT** = ``"dot_product"``
-
-#### Defined in
-
-[Embedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L11)
-
-___
-
-### EUCLIDEAN
-
-• **EUCLIDEAN** = ``"euclidean"``
-
-#### Defined in
-
-[Embedding.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Embedding.ts#L12)

apps/docs/docs/api/enums/_category_.yml

@@ -1,2 +0,0 @@
-label: "Enumerations"
-position: 2

apps/docs/docs/api/index.md

@@ -1,90 +0,0 @@
----
-id: "index"
-title: "llamaindex"
-sidebar_label: "Readme"
-sidebar_position: 0
-custom_edit_url: null
----
-
-# LlamaIndex.TS
-
-Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
-
-## What is LlamaIndex.TS?
-
-LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you integrate large language models into your applications with your own data.
-
-## Getting started with an example:
-
-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:
-
-```bash
-export OPEN_AI_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
-npx tsc –-init # if needed
-pnpm install llamaindex
-```
-
-Create the file example.ts
-
-```ts
-// example.ts
-import fs from "fs/promises";
-import { Document, VectorStoreIndex } from "llamaindex";
-
-async function main() {
-  // Load essay from abramov.txt in Node
-  const essay = await fs.readFile(
-    "node_modules/llamaindex/examples/abramov.txt",
-    "utf-8"
-  );
-
-  // Create Document object with essay
-  const document = new Document({ text: essay });
-
-  // Split text and create embeddings. Store them in a VectorStoreIndex
-  const index = await VectorStoreIndex.fromDocuments([document]);
-
-  // Query the index
-  const queryEngine = index.asQueryEngine();
-  const response = await queryEngine.query(
-    "What did the author do in college?"
-  );
-
-  // Output response
-  console.log(response.toString());
-}
-
-main();
-```
-
-Then you can run it using
-
-```bash
-npx ts-node example.ts
-```
-
-## Core concepts for getting started:
-
-- [Document](packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
-
-- [Node](packages/core/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
-
-- [Embedding](packages/core/src/Embedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that quesiton.
-
-- [Indices](packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
-
-- [QueryEngine](packages/core/src/QueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query.
-
-- [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices.
-
-- [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.
-
-## Contributing:
-
-We are in the very early days of LlamaIndex.TS. If you’re interested in hacking on it with us check out our [contributing guide](CONTRIBUTING.md)
-
-## Bugs? Questions?
-
-Please join our Discord! https://discord.com/invite/eN6D2HQ4aX

apps/docs/docs/api/interfaces/BaseIndexInit.md

@@ -1,79 +0,0 @@
----
-id: "BaseIndexInit"
-title: "Interface: BaseIndexInit<T>"
-sidebar_label: "BaseIndexInit"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-## Hierarchy
-
-- **`BaseIndexInit`**
-
-  ↳ [`VectorIndexConstructorProps`](VectorIndexConstructorProps.md)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L60)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L62)
-
-___
-
-### indexStruct
-
-• **indexStruct**: `T`
-
-#### Defined in
-
-[indices/BaseIndex.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L63)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](ServiceContext.md)
-
-#### Defined in
-
-[indices/BaseIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L58)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](StorageContext.md)
-
-#### Defined in
-
-[indices/BaseIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L59)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/indices/BaseIndex.ts#L61)

apps/docs/docs/api/interfaces/BaseLLMPredictor.md

@@ -1,49 +0,0 @@
----
-id: "BaseLLMPredictor"
-title: "Interface: BaseLLMPredictor"
-sidebar_label: "BaseLLMPredictor"
-sidebar_position: 0
-custom_edit_url: null
----
-
-LLM Predictors are an abstraction to predict the response to a prompt.
-
-## Implemented by
-
-- [`ChatGPTLLMPredictor`](../classes/ChatGPTLLMPredictor.md)
-
-## Methods
-
-### getLlmMetadata
-
-▸ **getLlmMetadata**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[LLMPredictor.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L9)
-
-___
-
-### predict
-
-▸ **predict**(`prompt`, `input?`, `parentEvent?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) |
-| `input?` | `Record`<`string`, `string`\> |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Defined in
-
-[LLMPredictor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/9d0cadf/packages/core/src/LLMPredictor.ts#L10)

apps/docs/docs/api/interfaces/BaseOutputParser.md

@@ -1,59 +0,0 @@
----
-id: "BaseOutputParser"
-title: "Interface: BaseOutputParser<T>"
-sidebar_label: "BaseOutputParser"
-sidebar_position: 0
-custom_edit_url: null
----
-
-An OutputParser is used to extract structured data from the raw output of the LLM.
-
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-## Implemented by
-
-- [`SubQuestionOutputParser`](../classes/SubQuestionOutputParser.md)
-
-## Methods
-
-### format
-
-▸ **format**(`output`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `output` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L8)
-
-___
-
-### parse
-
-▸ **parse**(`output`): `T`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `output` | `string` |
-
-#### Returns
-
-`T`
-
-#### Defined in
-
-[OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/OutputParser.ts#L7)

apps/docs/docs/api/interfaces/BaseQueryEngine.md

@@ -1,37 +0,0 @@
----
-id: "BaseQueryEngine"
-title: "Interface: BaseQueryEngine"
-sidebar_label: "BaseQueryEngine"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A query engine is a question answerer that can use one or more steps.
-
-## Implemented by
-
-- [`RetrieverQueryEngine`](../classes/RetrieverQueryEngine.md)
-- [`SubQuestionQueryEngine`](../classes/SubQuestionQueryEngine.md)
-
-## Methods
-
-### query
-
-▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\>
-
-Query the query engine and get a response.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<[`Response`](../classes/Response.md)\>
-
-#### Defined in
-
-[QueryEngine.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QueryEngine.ts#L24)

apps/docs/docs/api/interfaces/BaseQuestionGenerator.md

@@ -1,34 +0,0 @@
----
-id: "BaseQuestionGenerator"
-title: "Interface: BaseQuestionGenerator"
-sidebar_label: "BaseQuestionGenerator"
-sidebar_position: 0
-custom_edit_url: null
----
-
-QuestionGenerators generate new questions for the LLM using tools and a user query.
-
-## Implemented by
-
-- [`LLMQuestionGenerator`](../classes/LLMQuestionGenerator.md)
-
-## Methods
-
-### generate
-
-▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `tools` | [`ToolMetadata`](ToolMetadata.md)[] |
-| `query` | `string` |
-
-#### Returns
-
-`Promise`<[`SubQuestion`](SubQuestion.md)[]\>
-
-#### Defined in
-
-[QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/QuestionGenerator.ts#L23)

apps/docs/docs/api/interfaces/BaseReader.md

@@ -1,35 +0,0 @@
----
-id: "BaseReader"
-title: "Interface: BaseReader"
-sidebar_label: "BaseReader"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A reader takes imports data into Document objects.
-
-## Implemented by
-
-- [`PDFReader`](../classes/PDFReader.md)
-- [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md)
-- [`TextFileReader`](../classes/TextFileReader.md)
-
-## Methods
-
-### loadData
-
-▸ **loadData**(`...args`): `Promise`<[`Document`](../classes/Document.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `...args` | `any`[] |
-
-#### Returns
-
-`Promise`<[`Document`](../classes/Document.md)[]\>
-
-#### Defined in
-
-[readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/readers/base.ts#L7)

apps/docs/docs/api/interfaces/BaseRetriever.md

@@ -1,50 +0,0 @@
----
-id: "BaseRetriever"
-title: "Interface: BaseRetriever"
-sidebar_label: "BaseRetriever"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Retrievers retrieve the nodes that most closely match our query in similarity.
-
-## Implemented by
-
-- [`ListIndexLLMRetriever`](../classes/ListIndexLLMRetriever.md)
-- [`ListIndexRetriever`](../classes/ListIndexRetriever.md)
-- [`VectorIndexRetriever`](../classes/VectorIndexRetriever.md)
-
-## Methods
-
-### getServiceContext
-
-▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md)
-
-#### Returns
-
-[`ServiceContext`](ServiceContext.md)
-
-#### Defined in
-
-[Retriever.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L10)
-
-___
-
-### retrieve
-
-▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
-
-#### Defined in
-
-[Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Retriever.ts#L9)

apps/docs/docs/api/interfaces/BaseTool.md

@@ -1,25 +0,0 @@
----
-id: "BaseTool"
-title: "Interface: BaseTool"
-sidebar_label: "BaseTool"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Simple Tool interface. Likely to change.
-
-## Hierarchy
-
-- **`BaseTool`**
-
-  ↳ [`QueryEngineTool`](QueryEngineTool.md)
-
-## Properties
-
-### metadata
-
-• **metadata**: [`ToolMetadata`](ToolMetadata.md)
-
-#### Defined in
-
-[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L12)

apps/docs/docs/api/interfaces/ChatEngine.md

@@ -1,54 +0,0 @@
----
-id: "ChatEngine"
-title: "Interface: ChatEngine"
-sidebar_label: "ChatEngine"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A ChatEngine is used to handle back and forth chats between the application and the LLM.
-
-## Implemented by
-
-- [`CondenseQuestionChatEngine`](../classes/CondenseQuestionChatEngine.md)
-- [`ContextChatEngine`](../classes/ContextChatEngine.md)
-- [`SimpleChatEngine`](../classes/SimpleChatEngine.md)
-
-## Methods
-
-### chat
-
-▸ **chat**(`message`, `chatHistory?`): `Promise`<[`Response`](../classes/Response.md)\>
-
-Send message along with the class's current chat history to the LLM.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `message` | `string` |  |
-| `chatHistory?` | [`ChatMessage`](ChatMessage.md)[] | optional chat history if you want to customize the chat history |
-
-#### Returns
-
-`Promise`<[`Response`](../classes/Response.md)\>
-
-#### Defined in
-
-[ChatEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L25)
-
-___
-
-### reset
-
-▸ **reset**(): `void`
-
-Resets the chat history so that it's empty.
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[ChatEngine.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ChatEngine.ts#L30)

apps/docs/docs/api/interfaces/ChatMessage.md

@@ -1,27 +0,0 @@
----
-id: "ChatMessage"
-title: "Interface: ChatMessage"
-sidebar_label: "ChatMessage"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### content
-
-• **content**: `string`
-
-#### Defined in
-
-[llm/LLM.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L14)
-
-___
-
-### role
-
-• **role**: `MessageType`
-
-#### Defined in
-
-[llm/LLM.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L15)

apps/docs/docs/api/interfaces/ChatResponse.md

@@ -1,37 +0,0 @@
----
-id: "ChatResponse"
-title: "Interface: ChatResponse"
-sidebar_label: "ChatResponse"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### delta
-
-• `Optional` **delta**: `string`
-
-#### Defined in
-
-[llm/LLM.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L21)
-
-___
-
-### message
-
-• **message**: [`ChatMessage`](ChatMessage.md)
-
-#### Defined in
-
-[llm/LLM.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L19)
-
-___
-
-### raw
-
-• `Optional` **raw**: `Record`<`string`, `any`\>
-
-#### Defined in
-
-[llm/LLM.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L20)

apps/docs/docs/api/interfaces/Event.md

@@ -1,47 +0,0 @@
----
-id: "Event"
-title: "Interface: Event"
-sidebar_label: "Event"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L14)
-
-___
-
-### parentId
-
-• `Optional` **parentId**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L17)
-
-___
-
-### tags
-
-• `Optional` **tags**: [`EventTag`](../modules.md#eventtag)[]
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L16)
-
-___
-
-### type
-
-• **type**: [`EventType`](../modules.md#eventtype)
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L15)

apps/docs/docs/api/interfaces/GenericFileSystem.md

@@ -1,100 +0,0 @@
----
-id: "GenericFileSystem"
-title: "Interface: GenericFileSystem"
-sidebar_label: "GenericFileSystem"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A filesystem interface that is meant to be compatible with
-the 'fs' module from Node.js.
-Allows for the use of similar inteface implementation on
-browsers.
-
-## Implemented by
-
-- [`InMemoryFileSystem`](../classes/InMemoryFileSystem.md)
-
-## Methods
-
-### access
-
-▸ **access**(`path`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L12)
-
-___
-
-### mkdir
-
-▸ **mkdir**(`path`, `options?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L13)
-
-___
-
-### readFile
-
-▸ **readFile**(`path`, `options?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L11)
-
-___
-
-### writeFile
-
-▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-| `content` | `string` |
-| `options?` | `any` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/FileSystem.ts#L10)

apps/docs/docs/api/interfaces/LLM.md

@@ -1,60 +0,0 @@
----
-id: "LLM"
-title: "Interface: LLM"
-sidebar_label: "LLM"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Unified language model interface
-
-## Implemented by
-
-- [`LlamaDeuce`](../classes/LlamaDeuce.md)
-- [`OpenAI`](../classes/OpenAI.md)
-
-## Methods
-
-### chat
-
-▸ **chat**(`messages`, `parentEvent?`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-Get a chat response from the LLM
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `messages` | [`ChatMessage`](ChatMessage.md)[] |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-#### Defined in
-
-[llm/LLM.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L35)
-
-___
-
-### complete
-
-▸ **complete**(`prompt`, `parentEvent?`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-Get a prompt completion from the LLM
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `prompt` | `string` | the prompt to complete |
-| `parentEvent?` | [`Event`](Event.md) | - |
-
-#### Returns
-
-`Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-#### Defined in
-
-[llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/llm/LLM.ts#L41)

apps/docs/docs/api/interfaces/NodeParser.md

@@ -1,33 +0,0 @@
----
-id: "NodeParser"
-title: "Interface: NodeParser"
-sidebar_label: "NodeParser"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A node parser generates TextNodes from Documents
-
-## Implemented by
-
-- [`SimpleNodeParser`](../classes/SimpleNodeParser.md)
-
-## Methods
-
-### getNodesFromDocuments
-
-▸ **getNodesFromDocuments**(`documents`): [`TextNode`](../classes/TextNode.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `documents` | [`Document`](../classes/Document.md)[] |
-
-#### Returns
-
-[`TextNode`](../classes/TextNode.md)[]
-
-#### Defined in
-
-[NodeParser.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/NodeParser.ts#L53)

apps/docs/docs/api/interfaces/NodeWithEmbedding.md

@@ -1,29 +0,0 @@
----
-id: "NodeWithEmbedding"
-title: "Interface: NodeWithEmbedding"
-sidebar_label: "NodeWithEmbedding"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A node with an embedding
-
-## Properties
-
-### embedding
-
-• **embedding**: `number`[]
-
-#### Defined in
-
-[Node.ts:247](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L247)
-
-___
-
-### node
-
-• **node**: [`BaseNode`](../classes/BaseNode.md)
-
-#### Defined in
-
-[Node.ts:246](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L246)

apps/docs/docs/api/interfaces/NodeWithScore.md

@@ -1,29 +0,0 @@
----
-id: "NodeWithScore"
-title: "Interface: NodeWithScore"
-sidebar_label: "NodeWithScore"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A node with a similarity score
-
-## Properties
-
-### node
-
-• **node**: [`BaseNode`](../classes/BaseNode.md)
-
-#### Defined in
-
-[Node.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L238)
-
-___
-
-### score
-
-• **score**: `number`
-
-#### Defined in
-
-[Node.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L239)

apps/docs/docs/api/interfaces/QueryEngineTool.md

@@ -1,39 +0,0 @@
----
-id: "QueryEngineTool"
-title: "Interface: QueryEngineTool"
-sidebar_label: "QueryEngineTool"
-sidebar_position: 0
-custom_edit_url: null
----
-
-A Tool that uses a QueryEngine.
-
-## Hierarchy
-
-- [`BaseTool`](BaseTool.md)
-
-  ↳ **`QueryEngineTool`**
-
-## Properties
-
-### metadata
-
-• **metadata**: [`ToolMetadata`](ToolMetadata.md)
-
-#### Inherited from
-
-[BaseTool](BaseTool.md).[metadata](BaseTool.md#metadata)
-
-#### Defined in
-
-[Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L12)
-
-___
-
-### queryEngine
-
-• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md)
-
-#### Defined in
-
-[Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Tool.ts#L19)

apps/docs/docs/api/interfaces/RelatedNodeInfo.md

@@ -1,47 +0,0 @@
----
-id: "RelatedNodeInfo"
-title: "Interface: RelatedNodeInfo"
-sidebar_label: "RelatedNodeInfo"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### hash
-
-• `Optional` **hash**: `string`
-
-#### Defined in
-
-[Node.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L29)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\>
-
-#### Defined in
-
-[Node.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L28)
-
-___
-
-### nodeId
-
-• **nodeId**: `string`
-
-#### Defined in
-
-[Node.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L26)
-
-___
-
-### nodeType
-
-• `Optional` **nodeType**: [`ObjectType`](../enums/ObjectType.md)
-
-#### Defined in
-
-[Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/Node.ts#L27)

apps/docs/docs/api/interfaces/RetrievalCallbackResponse.md

@@ -1,47 +0,0 @@
----
-id: "RetrievalCallbackResponse"
-title: "Interface: RetrievalCallbackResponse"
-sidebar_label: "RetrievalCallbackResponse"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Hierarchy
-
-- `BaseCallbackResponse`
-
-  ↳ **`RetrievalCallbackResponse`**
-
-## Properties
-
-### event
-
-• **event**: [`Event`](Event.md)
-
-#### Inherited from
-
-BaseCallbackResponse.event
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21)
-
-___
-
-### nodes
-
-• **nodes**: [`NodeWithScore`](NodeWithScore.md)[]
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L47)
-
-___
-
-### query
-
-• **query**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L46)

apps/docs/docs/api/interfaces/ServiceContext.md

@@ -1,59 +0,0 @@
----
-id: "ServiceContext"
-title: "Interface: ServiceContext"
-sidebar_label: "ServiceContext"
-sidebar_position: 0
-custom_edit_url: null
----
-
-The ServiceContext is a collection of components that are used in different parts of the application.
-
-## Properties
-
-### callbackManager
-
-• **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md)
-
-#### Defined in
-
-[ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L15)
-
-___
-
-### embedModel
-
-• **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
-
-#### Defined in
-
-[ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L13)
-
-___
-
-### llm
-
-• **llm**: [`LLM`](LLM.md)
-
-#### Defined in
-
-[ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L11)
-
-___
-
-### nodeParser
-
-• **nodeParser**: [`NodeParser`](NodeParser.md)
-
-#### Defined in
-
-[ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L14)
-
-___
-
-### promptHelper
-
-• **promptHelper**: `PromptHelper`
-
-#### Defined in
-
-[ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L12)

apps/docs/docs/api/interfaces/ServiceContextOptions.md

@@ -1,77 +0,0 @@
----
-id: "ServiceContextOptions"
-title: "Interface: ServiceContextOptions"
-sidebar_label: "ServiceContextOptions"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### callbackManager
-
-• `Optional` **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md)
-
-#### Defined in
-
-[ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L24)
-
-___
-
-### chunkOverlap
-
-• `Optional` **chunkOverlap**: `number`
-
-#### Defined in
-
-[ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L27)
-
-___
-
-### chunkSize
-
-• `Optional` **chunkSize**: `number`
-
-#### Defined in
-
-[ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L26)
-
-___
-
-### embedModel
-
-• `Optional` **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
-
-#### Defined in
-
-[ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L22)
-
-___
-
-### llm
-
-• `Optional` **llm**: [`OpenAI`](../classes/OpenAI.md)
-
-#### Defined in
-
-[ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L20)
-
-___
-
-### nodeParser
-
-• `Optional` **nodeParser**: [`NodeParser`](NodeParser.md)
-
-#### Defined in
-
-[ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L23)
-
-___
-
-### promptHelper
-
-• `Optional` **promptHelper**: `PromptHelper`
-
-#### Defined in
-
-[ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/ServiceContext.ts#L21)

apps/docs/docs/api/interfaces/StorageContext.md

@@ -1,37 +0,0 @@
----
-id: "StorageContext"
-title: "Interface: StorageContext"
-sidebar_label: "StorageContext"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Defined in
-
-[storage/StorageContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L15)
-
-___
-
-### indexStore
-
-• **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[storage/StorageContext.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L16)
-
-___
-
-### vectorStore
-
-• **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[storage/StorageContext.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/storage/StorageContext.ts#L17)

apps/docs/docs/api/interfaces/StreamCallbackResponse.md

@@ -1,57 +0,0 @@
----
-id: "StreamCallbackResponse"
-title: "Interface: StreamCallbackResponse"
-sidebar_label: "StreamCallbackResponse"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Hierarchy
-
-- `BaseCallbackResponse`
-
-  ↳ **`StreamCallbackResponse`**
-
-## Properties
-
-### event
-
-• **event**: [`Event`](Event.md)
-
-#### Inherited from
-
-BaseCallbackResponse.event
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L21)
-
-___
-
-### index
-
-• **index**: `number`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L40)
-
-___
-
-### isDone
-
-• `Optional` **isDone**: `boolean`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L41)
-
-___
-
-### token
-
-• `Optional` **token**: [`StreamToken`](StreamToken.md)
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L42)

apps/docs/docs/api/interfaces/StreamToken.md

@@ -1,57 +0,0 @@
----
-id: "StreamToken"
-title: "Interface: StreamToken"
-sidebar_label: "StreamToken"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### choices
-
-• **choices**: { `delta`: { `content?`: `string` ; `role?`: `ChatCompletionResponseMessageRoleEnum`  } ; `finish_reason`: ``null`` \| `string` ; `index`: `number`  }[]
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L29)
-
-___
-
-### created
-
-• **created**: `number`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L27)
-
-___
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L25)
-
-___
-
-### model
-
-• **model**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L28)
-
-___
-
-### object
-
-• **object**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/5a765aa/packages/core/src/callbacks/CallbackManager.ts#L26)