changesets

feat: improved chat history summarizer

.changeset/README.md

@@ -0,0 +1,8 @@
+# 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/big-hairs-eat.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Streaming improvements including Anthropic (thanks @kkang2097)

.changeset/breezy-days-admire.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Portkey integration (Thank you @noble-varghese)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$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": []
+}

.changeset/honest-students-care.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Add export for PromptHelper (thanks @zigamall)

.changeset/six-hats-compare.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Publish ESM module again

.changeset/twelve-otters-wash.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Pinecone demo (thanks @Einsenhorn)

.github/ISSUE_TEMPLATE/sweep-bugfix.yml

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

.github/ISSUE_TEMPLATE/sweep-feature.yml

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

.github/ISSUE_TEMPLATE/sweep-refactor.yml

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

.github/workflows/lint_on_push_or_pull.yml

@@ -0,0 +1,25 @@
+name: Lint on push or pull request
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run lint
+        run: pnpm run lint

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
+
+      - name: Install dependencies
+        run: |
+          npm i -g pnpm
+          pnpm install
+
+      - name: Run tests
+        run: pnpm run test

.gitignore

@@ -35,4 +35,4 @@ yarn-error.log*
 # vercel
 .vercel
 
-storage/
+dist/

CONTRIBUTING.md

@@ -12,13 +12,13 @@ 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)
+You can checkout how Turborepo works using the default [README-turborepo.md](/README-turborepo.md)
 
 ## Getting Started
 
 Install NodeJS. Preferably v18 using nvm or n.
 
-Inside the llamascript directory:
+Inside the LlamaIndexTS directory:
 
 ```
 npm i -g pnpm ts-node
@@ -41,12 +41,14 @@ To run them, run
 pnpm run test
 ```
 
-To write new test cases write them in packages/core/src/tests
+To write new test cases write them in [packages/core/src/tests](/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
 
+There is an existing ["simple"](/apps/simple/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the core package with a new demo, you need to run the build command in the README.
+
 You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json
 
 ### Installing packages

README.md

@@ -1,7 +1,11 @@
 # LlamaIndex.TS
 
+LlamaIndex is a data framework for your LLM application.
+
 Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
 
+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.
@@ -13,9 +17,12 @@ LlamaIndex.TS requries Node v18 or higher. You can download it from https://node
 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
+export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
+pnpm init
+pnpm install typescript
+pnpm exec tsc --init # if needed
 pnpm install llamaindex
+pnpm install @types/node
 ```
 
 Create the file example.ts
@@ -29,7 +36,7 @@ async function main() {
   // Load essay from abramov.txt in Node
   const essay = await fs.readFile(
     "node_modules/llamaindex/examples/abramov.txt",
-    "utf-8"
+    "utf-8",
   );
 
   // Create Document object with essay
@@ -40,38 +47,52 @@ async function main() {
 
   // Query the index
   const queryEngine = index.asQueryEngine();
-  const response = await queryEngine.aquery(
-    "What did the author do in college?"
+  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
+pnpx ts-node example.ts
 ```
 
-## Core concepts:
+## Playground
 
-- [Document](packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
+Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground
 
-- [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.
+## Core concepts for getting started:
 
-- Indexes: indexes store the Nodes and the embeddings of those nodes.
+- [Document](/packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
 
-- [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.
+- [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.
 
-- [ChatEngine](packages/core/src/ChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indexes.
+- [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.
 
-- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template.
+- [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.
+
+## Supported LLMs:
+
+- OpenAI GPT-3.5-turbo and GPT-4
+- Anthropic Claude Instant and Claude 2
+- Llama2 Chat LLMs (70B, 13B, and 7B parameters)
 
 ## 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)
+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?
 

apps/docs/README-docusaurus.md

@@ -5,21 +5,27 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 ### Installation
 
 ```
-$ yarn
+$ pnpm
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ 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
 
 ```
-$ yarn build
+$ pnpm build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +35,13 @@ This command generates static content into the `build` directory and can be serv
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+$ USE_SSH=true pnpm deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+$ 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 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
 };

apps/docs/docs/.gitignore

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

apps/docs/docs/api/_category_.yml

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

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
-
-### aGetQueryEmbedding
-
-▸ `Abstract` **aGetQueryEmbedding**(`query`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Defined in
-
-[Embedding.ts:206](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L206)
-
-___
-
-### aGetTextEmbedding
-
-▸ `Abstract` **aGetTextEmbedding**(`text`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Defined in
-
-[Embedding.ts:205](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L197)

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

@@ -1,120 +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`**
-
-  ↳ [`VectorStoreIndex`](VectorStoreIndex.md)
-
-  ↳ [`ListIndex`](ListIndex.md)
-
-## Constructors
-
-### constructor
-
-• **new BaseIndex**<`T`\>(`init`)
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<`T`\> |
-
-#### Defined in
-
-[BaseIndex.ts:80](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L80)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Defined in
-
-[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L75)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[BaseIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L77)
-
-___
-
-### indexStruct
-
-• **indexStruct**: `T`
-
-#### Defined in
-
-[BaseIndex.ts:78](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L78)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L73)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L74)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[BaseIndex.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L76)
-
-## Methods
-
-### asRetriever
-
-▸ `Abstract` **asRetriever**(): [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Returns
-
-[`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Defined in
-
-[BaseIndex.ts:89](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L89)

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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L48)
-
-## Properties
-
-### embedding
-
-• `Optional` **embedding**: `number`[]
-
-#### Defined in
-
-[Node.ts:39](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L39)
-
-___
-
-### excludedEmbedMetadataKeys
-
-• **excludedEmbedMetadataKeys**: `string`[] = `[]`
-
-#### Defined in
-
-[Node.ts:43](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L43)
-
-___
-
-### excludedLlmMetadataKeys
-
-• **excludedLlmMetadataKeys**: `string`[] = `[]`
-
-#### Defined in
-
-[Node.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L44)
-
-___
-
-### hash
-
-• **hash**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:46](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L46)
-
-___
-
-### id\_
-
-• **id\_**: `string`
-
-#### Defined in
-
-[Node.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L38)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\> = `{}`
-
-#### Defined in
-
-[Node.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L84)
-
-___
-
-### nodeId
-
-• `get` **nodeId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:58](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L54)
-
-___
-
-### getEmbedding
-
-▸ **getEmbedding**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Defined in
-
-[Node.ts:116](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L66)

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

@@ -1,113 +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/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L26)
-
-## Properties
-
-### callbackManager
-
-• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
-
-#### Defined in
-
-[LLMPredictor.ts:24](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L24)
-
-___
-
-### languageModel
-
-• **languageModel**: [`OpenAI`](OpenAI.md)
-
-#### Defined in
-
-[LLMPredictor.ts:23](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L21)
-
-___
-
-### retryOnThrottling
-
-• **retryOnThrottling**: `boolean`
-
-#### Defined in
-
-[LLMPredictor.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L22)
-
-## Methods
-
-### apredict
-
-▸ **apredict**(`prompt`, `input?`, `parentEvent?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `prompt` | `string` \| [`SimplePrompt`](../modules.md#simpleprompt) |
-| `input?` | `Record`<`string`, `string`\> |
-| `parentEvent?` | [`Event`](../interfaces/Event.md) |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-[BaseLLMPredictor](../interfaces/BaseLLMPredictor.md).[apredict](../interfaces/BaseLLMPredictor.md#apredict)
-
-#### Defined in
-
-[LLMPredictor.ts:49](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L49)
-
-___
-
-### 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/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L45)

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

@@ -1,105 +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:66](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L66)
-
-## Properties
-
-### refineTemplate
-
-• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Inherited from
-
-[Refine](Refine.md).[refineTemplate](Refine.md#refinetemplate)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L64)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Inherited from
-
-[Refine](Refine.md).[serviceContext](Refine.md#servicecontext)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L62)
-
-___
-
-### textQATemplate
-
-• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Inherited from
-
-[Refine](Refine.md).[textQATemplate](Refine.md#textqatemplate)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L63)
-
-## Methods
-
-### agetResponse
-
-▸ **agetResponse**(`query`, `textChunks`, `prevResponse?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `textChunks` | `string`[] |
-| `prevResponse?` | `any` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Overrides
-
-[Refine](Refine.md).[agetResponse](Refine.md#agetresponse)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:152](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L152)

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 VectorIndex).
-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/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L75)
-
-## Properties
-
-### chatHistory
-
-• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
-
-#### Defined in
-
-[ChatEngine.ts:71](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L71)
-
-___
-
-### condenseMessagePrompt
-
-• **condenseMessagePrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ChatEngine.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L73)
-
-___
-
-### queryEngine
-
-• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-#### Defined in
-
-[ChatEngine.ts:70](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L70)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ChatEngine.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L72)
-
-## Methods
-
-### achat
-
-▸ **achat**(`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).[achat](../interfaces/ChatEngine.md#achat)
-
-#### Defined in
-
-[ChatEngine.ts:104](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L104)
-
-___
-
-### acondenseQuestion
-
-▸ `Private` **acondenseQuestion**(`chatHistory`, `question`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] |
-| `question` | `string` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Defined in
-
-[ChatEngine.ts:89](https://github.com/run-llama/llamascript/blob/6ea89db/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:123](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L123)

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

@@ -1,125 +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:138](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L138)
-
-## Properties
-
-### chatHistory
-
-• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
-
-#### Defined in
-
-[ChatEngine.ts:136](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L136)
-
-___
-
-### chatModel
-
-• **chatModel**: [`OpenAI`](OpenAI.md)
-
-#### Defined in
-
-[ChatEngine.ts:135](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L135)
-
-___
-
-### retriever
-
-• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Defined in
-
-[ChatEngine.ts:134](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L134)
-
-## Methods
-
-### achat
-
-▸ **achat**(`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).[achat](../interfaces/ChatEngine.md#achat)
-
-#### Defined in
-
-[ChatEngine.ts:153](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L153)
-
-___
-
-### chatRepl
-
-▸ **chatRepl**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[ChatEngine.ts:149](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L149)
-
-___
-
-### 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:191](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L191)

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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L104)
-
-___
-
-### docId
-
-• `get` **docId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:225](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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
-
-[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
-
-## Properties
-
-### docStore
-
-• **docStore**: `Record`<`string`, [`Document`](Document.md)\> = `{}`
-
-#### Defined in
-
-[BaseIndex.ts:36](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L36)
-
-___
-
-### indexId
-
-• **indexId**: `string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
-
-#### Defined in
-
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
-
-___
-
-### nodesDict
-
-• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)\> = `{}`
-
-#### Defined in
-
-[BaseIndex.ts:35](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L35)
-
-___
-
-### summary
-
-• `Optional` **summary**: `string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
-
-#### Defined in
-
-[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
-
-## Methods
-
-### addNode
-
-▸ **addNode**(`node`, `textId?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | [`BaseNode`](BaseNode.md) |
-| `textId?` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[BaseIndex.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L45)
-
-___
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
-
-#### Defined in
-
-[BaseIndex.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L38)

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
-
-[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
-
-## Properties
-
-### indexId
-
-• **indexId**: `string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid)
-
-#### Defined in
-
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
-
-___
-
-### nodes
-
-• **nodes**: `string`[] = `[]`
-
-#### Defined in
-
-[BaseIndex.ts:52](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L52)
-
-___
-
-### summary
-
-• `Optional` **summary**: `string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary)
-
-#### Defined in
-
-[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
-
-## Methods
-
-### addNode
-
-▸ **addNode**(`node`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `node` | [`BaseNode`](BaseNode.md) |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[BaseIndex.ts:54](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L54)
-
-___
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary)
-
-#### Defined in
-
-[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L26)

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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L38)
-
-___
-
-### indexId
-
-• **indexId**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:205](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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
-
-[BaseIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L21)
-
-## Properties
-
-### indexId
-
-• **indexId**: `string`
-
-#### Defined in
-
-[BaseIndex.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L18)
-
-___
-
-### summary
-
-• `Optional` **summary**: `string`
-
-#### Defined in
-
-[BaseIndex.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L19)
-
-## Methods
-
-### getSummary
-
-▸ **getSummary**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[BaseIndex.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L26)

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/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L34)
-
-## Properties
-
-### llmPredictor
-
-• **llmPredictor**: [`BaseLLMPredictor`](../interfaces/BaseLLMPredictor.md)
-
-#### Defined in
-
-[QuestionGenerator.ts:30](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L32)
-
-___
-
-### prompt
-
-• **prompt**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[QuestionGenerator.ts:31](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L31)
-
-## Methods
-
-### agenerate
-
-▸ **agenerate**(`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).[agenerate](../interfaces/BaseQuestionGenerator.md#agenerate)
-
-#### Defined in
-
-[QuestionGenerator.ts:40](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L40)

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

@@ -1,281 +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
-
-[index/list/ListIndex.ts:37](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L37)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
-
-#### Defined in
-
-[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L75)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
-
-#### Defined in
-
-[BaseIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L77)
-
-___
-
-### indexStruct
-
-• **indexStruct**: [`IndexList`](IndexList.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
-
-#### Defined in
-
-[BaseIndex.ts:78](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L78)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
-
-#### Defined in
-
-[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L73)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
-
-#### Defined in
-
-[BaseIndex.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L74)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
-
-#### Defined in
-
-[BaseIndex.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L76)
-
-## Methods
-
-### \_deleteNode
-
-▸ `Protected` **_deleteNode**(`nodeId`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeId` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[index/list/ListIndex.ts:140](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L140)
-
-___
-
-### \_insert
-
-▸ `Protected` **_insert**(`nodes`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodes` | [`BaseNode`](BaseNode.md)[] |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[index/list/ListIndex.ts:134](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L134)
-
-___
-
-### asQueryEngine
-
-▸ **asQueryEngine**(`mode?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | `ListRetrieverMode.DEFAULT` |
-
-#### Returns
-
-[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-#### Defined in
-
-[index/list/ListIndex.ts:113](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L113)
-
-___
-
-### asRetriever
-
-▸ **asRetriever**(`mode?`): [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `mode` | [`ListRetrieverMode`](../enums/ListRetrieverMode.md) | `ListRetrieverMode.DEFAULT` |
-
-#### Returns
-
-[`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Overrides
-
-[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
-
-#### Defined in
-
-[index/list/ListIndex.ts:100](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L100)
-
-___
-
-### getRefDocInfo
-
-▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, `RefDocInfo`\>\>
-
-#### Returns
-
-`Promise`<`Record`<`string`, `RefDocInfo`\>\>
-
-#### Defined in
-
-[index/list/ListIndex.ts:146](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L146)
-
-___
-
-### \_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
-
-[index/list/ListIndex.ts:119](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L119)
-
-___
-
-### fromDocuments
-
-▸ `Static` **fromDocuments**(`documents`, `storageContext?`, `serviceContext?`): `Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `documents` | [`Document`](Document.md)[] |
-| `storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) |
-| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) |
-
-#### Returns
-
-`Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Defined in
-
-[index/list/ListIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L77)
-
-___
-
-### init
-
-▸ `Static` **init**(`options`): `Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `options` | `ListIndexOptions` |
-
-#### Returns
-
-`Promise`<[`ListIndex`](ListIndex.md)\>
-
-#### Defined in
-
-[index/list/ListIndex.ts:41](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L41)

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
-
-[index/list/ListIndexRetriever.ts:67](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L67)
-
-## Properties
-
-### choiceBatchSize
-
-• **choiceBatchSize**: `number`
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L62)
-
-___
-
-### choiceSelectPrompt
-
-• **choiceSelectPrompt**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:61](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L61)
-
-___
-
-### formatNodeBatchFn
-
-• **formatNodeBatchFn**: `NodeFormatterFunction`
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:63](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L63)
-
-___
-
-### index
-
-• **index**: [`ListIndex`](ListIndex.md)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:60](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L60)
-
-___
-
-### parseChoiceSelectAnswerFn
-
-• **parseChoiceSelectAnswerFn**: `ChoiceSelectParserFunction`
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:64](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L64)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:65](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L65)
-
-## Methods
-
-### aretrieve
-
-▸ **aretrieve**(`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).[aretrieve](../interfaces/BaseRetriever.md#aretrieve)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:84](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L84)
-
-___
-
-### getServiceContext
-
-▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Returns
-
-[`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Implementation of
-
-[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:134](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L134)

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
-
-[index/list/ListIndexRetriever.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L22)
-
-## Properties
-
-### index
-
-• **index**: [`ListIndex`](ListIndex.md)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:20](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L20)
-
-## Methods
-
-### aretrieve
-
-▸ **aretrieve**(`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).[aretrieve](../interfaces/BaseRetriever.md#aretrieve)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L26)
-
-___
-
-### getServiceContext
-
-▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Returns
-
-[`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Implementation of
-
-[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
-
-#### Defined in
-
-[index/list/ListIndexRetriever.ts:51](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndexRetriever.ts#L51)

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

@@ -1,193 +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.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L76)
-
-## Properties
-
-### callbackManager
-
-• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md)
-
-#### Defined in
-
-[LLM.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L74)
-
-___
-
-### maxRetries
-
-• **maxRetries**: `number`
-
-#### Defined in
-
-[LLM.ts:69](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L69)
-
-___
-
-### maxTokens
-
-• `Optional` **maxTokens**: `number`
-
-#### Defined in
-
-[LLM.ts:71](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L71)
-
-___
-
-### model
-
-• **model**: ``"gpt-3.5-turbo"`` \| ``"gpt-3.5-turbo-16k"`` \| ``"gpt-4"`` \| ``"gpt-4-32k"``
-
-#### Defined in
-
-[LLM.ts:66](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L66)
-
-___
-
-### n
-
-• **n**: `number` = `1`
-
-#### Defined in
-
-[LLM.ts:70](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L70)
-
-___
-
-### openAIKey
-
-• **openAIKey**: ``null`` \| `string` = `null`
-
-#### Defined in
-
-[LLM.ts:72](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L72)
-
-___
-
-### requestTimeout
-
-• **requestTimeout**: ``null`` \| `number`
-
-#### Defined in
-
-[LLM.ts:68](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L68)
-
-___
-
-### session
-
-• **session**: `OpenAISession`
-
-#### Defined in
-
-[LLM.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L73)
-
-___
-
-### temperature
-
-• **temperature**: `number`
-
-#### Defined in
-
-[LLM.ts:67](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L67)
-
-## Methods
-
-### achat
-
-▸ **achat**(`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).[achat](../interfaces/LLM.md#achat)
-
-#### Defined in
-
-[LLM.ts:103](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L103)
-
-___
-
-### acomplete
-
-▸ **acomplete**(`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).[acomplete](../interfaces/LLM.md#acomplete)
-
-#### Defined in
-
-[LLM.ts:145](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L145)
-
-___
-
-### mapMessageType
-
-▸ **mapMessageType**(`type`): `ChatCompletionRequestMessageRoleEnum`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `type` | `MessageType` |
-
-#### Returns
-
-`ChatCompletionRequestMessageRoleEnum`
-
-#### Defined in
-
-[LLM.ts:88](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L88)

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/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L217)
-
-## Properties
-
-### model
-
-• **model**: `TEXT_EMBED_ADA_002`
-
-#### Defined in
-
-[Embedding.ts:215](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L215)
-
-___
-
-### session
-
-• **session**: `OpenAISession`
-
-#### Defined in
-
-[Embedding.ts:214](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L214)
-
-## Methods
-
-### \_aGetOpenAIEmbedding
-
-▸ `Private` **_aGetOpenAIEmbedding**(`input`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Defined in
-
-[Embedding.ts:224](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L224)
-
-___
-
-### aGetQueryEmbedding
-
-▸ **aGetQueryEmbedding**(`query`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Overrides
-
-[BaseEmbedding](BaseEmbedding.md).[aGetQueryEmbedding](BaseEmbedding.md#agetqueryembedding)
-
-#### Defined in
-
-[Embedding.ts:240](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L240)
-
-___
-
-### aGetTextEmbedding
-
-▸ **aGetTextEmbedding**(`text`): `Promise`<`number`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-
-#### Returns
-
-`Promise`<`number`[]\>
-
-#### Overrides
-
-[BaseEmbedding](BaseEmbedding.md).[aGetTextEmbedding](BaseEmbedding.md#agettextembedding)
-
-#### Defined in
-
-[Embedding.ts:236](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L197)

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

@@ -1,136 +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:66](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L66)
-
-## Properties
-
-### refineTemplate
-
-• **refineTemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:64](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L64)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L62)
-
-___
-
-### textQATemplate
-
-• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:63](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L63)
-
-## Methods
-
-### agetResponse
-
-▸ **agetResponse**(`query`, `textChunks`, `prevResponse?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `textChunks` | `string`[] |
-| `prevResponse?` | `any` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-BaseResponseBuilder.agetResponse
-
-#### Defined in
-
-[ResponseSynthesizer.ts:76](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L76)
-
-___
-
-### giveResponseSingle
-
-▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queryStr` | `string` |
-| `textChunk` | `string` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Defined in
-
-[ResponseSynthesizer.ts:95](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L95)
-
-___
-
-### refineResponseSingle
-
-▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `response` | `string` |
-| `queryStr` | `string` |
-| `textChunk` | `string` |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Defined in
-
-[ResponseSynthesizer.ts:123](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L123)

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/llamascript/blob/6ea89db/packages/core/src/Response.ts#L10)
-
-## Properties
-
-### response
-
-• **response**: `string`
-
-#### Defined in
-
-[Response.ts:7](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Response.ts#L7)
-
-___
-
-### sourceNodes
-
-• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)[]
-
-#### Defined in
-
-[Response.ts:8](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Response.ts#L8)
-
-## Methods
-
-### getFormattedSources
-
-▸ **getFormattedSources**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[Response.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Response.ts#L15)
-
-___
-
-### toString
-
-▸ **toString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Response.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/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:225](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L225)
-
-## Properties
-
-### responseBuilder
-
-• **responseBuilder**: `BaseResponseBuilder`
-
-#### Defined in
-
-[ResponseSynthesizer.ts:222](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L222)
-
-___
-
-### serviceContext
-
-• `Optional` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:223](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L223)
-
-## Methods
-
-### asynthesize
-
-▸ **asynthesize**(`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:237](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L237)

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

@@ -1,74 +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`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) |
-
-#### Defined in
-
-[QueryEngine.ts:29](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L29)
-
-## Properties
-
-### responseSynthesizer
-
-• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
-
-#### Defined in
-
-[QueryEngine.ts:27](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L27)
-
-___
-
-### retriever
-
-• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md)
-
-#### Defined in
-
-[QueryEngine.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L26)
-
-## Methods
-
-### aquery
-
-▸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parentEvent?` | [`Event`](../interfaces/Event.md) |
-
-#### Returns
-
-`Promise`<[`Response`](Response.md)\>
-
-#### Implementation of
-
-[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery)
-
-#### Defined in
-
-[QueryEngine.ts:36](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L36)

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/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L33)
-
-## Properties
-
-### chunkOverlap
-
-• `Private` **chunkOverlap**: `number`
-
-#### Defined in
-
-[TextSplitter.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L26)
-
-___
-
-### chunkSize
-
-• `Private` **chunkSize**: `number`
-
-#### Defined in
-
-[TextSplitter.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L25)
-
-___
-
-### chunkingTokenizerFn
-
-• `Private` **chunkingTokenizerFn**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:30](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L30)
-
-___
-
-### paragraphSeparator
-
-• `Private` **paragraphSeparator**: `string`
-
-#### Defined in
-
-[TextSplitter.ts:29](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L29)
-
-___
-
-### tokenizer
-
-• `Private` **tokenizer**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:27](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/TextSplitter.ts#L27)
-
-___
-
-### tokenizerDecoder
-
-• `Private` **tokenizerDecoder**: `any`
-
-#### Defined in
-
-[TextSplitter.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L40)
-
-## Properties
-
-### chatHistory
-
-• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[]
-
-#### Defined in
-
-[ChatEngine.ts:37](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L37)
-
-___
-
-### llm
-
-• **llm**: [`LLM`](../interfaces/LLM.md)
-
-#### Defined in
-
-[ChatEngine.ts:38](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L38)
-
-## Methods
-
-### achat
-
-▸ **achat**(`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).[achat](../interfaces/ChatEngine.md#achat)
-
-#### Defined in
-
-[ChatEngine.ts:45](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/ChatEngine.ts#L54)

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/llamascript/blob/6ea89db/packages/core/src/NodeParser.ts#L64)
-
-## Properties
-
-### includeMetadata
-
-• **includeMetadata**: `boolean`
-
-#### Defined in
-
-[NodeParser.ts:61](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/NodeParser.ts#L61)
-
-___
-
-### includePrevNextRel
-
-• **includePrevNextRel**: `boolean`
-
-#### Defined in
-
-[NodeParser.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/NodeParser.ts#L62)
-
-___
-
-### textSplitter
-
-• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md)
-
-#### Defined in
-
-[NodeParser.ts:60](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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:37](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L37)
-
-## Properties
-
-### llmPredictor
-
-• **llmPredictor**: [`BaseLLMPredictor`](../interfaces/BaseLLMPredictor.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:34](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L34)
-
-___
-
-### textQATemplate
-
-• **textQATemplate**: [`SimplePrompt`](../modules.md#simpleprompt)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:35](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L35)
-
-## Methods
-
-### agetResponse
-
-▸ **agetResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `textChunks` | `string`[] |
-| `parentEvent?` | [`Event`](../interfaces/Event.md) |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-BaseResponseBuilder.agetResponse
-
-#### Defined in
-
-[ResponseSynthesizer.ts:43](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L43)

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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/OutputParser.ts#L89)

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

@@ -1,141 +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:56](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L56)
-
-## Properties
-
-### metadatas
-
-• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[]
-
-#### Defined in
-
-[QueryEngine.ts:54](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L54)
-
-___
-
-### queryEngines
-
-• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\>
-
-#### Defined in
-
-[QueryEngine.ts:53](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L53)
-
-___
-
-### questionGen
-
-• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md)
-
-#### Defined in
-
-[QueryEngine.ts:52](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L52)
-
-___
-
-### responseSynthesizer
-
-• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md)
-
-#### Defined in
-
-[QueryEngine.ts:51](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L51)
-
-## Methods
-
-### aquery
-
-▸ **aquery**(`query`): `Promise`<[`Response`](Response.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-
-#### Returns
-
-`Promise`<[`Response`](Response.md)\>
-
-#### Implementation of
-
-[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[aquery](../interfaces/BaseQueryEngine.md#aquery)
-
-#### Defined in
-
-[QueryEngine.ts:97](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L97)
-
-___
-
-### aquerySubQ
-
-▸ `Private` **aquerySubQ**(`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:128](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L128)
-
-___
-
-### 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:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L73)

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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L39)
-
-___
-
-### endCharIdx
-
-• `Optional` **endCharIdx**: `number`
-
-#### Defined in
-
-[Node.ts:139](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L42)
-
-___
-
-### metadataSeparator
-
-• **metadataSeparator**: `string` = `"\n"`
-
-#### Defined in
-
-[Node.ts:142](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L45)
-
-___
-
-### startCharIdx
-
-• `Optional` **startCharIdx**: `number`
-
-#### Defined in
-
-[Node.ts:138](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L138)
-
-___
-
-### text
-
-• **text**: `string` = `""`
-
-#### Defined in
-
-[Node.ts:137](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L124)
-
-___
-
-### generateHash
-
-▸ **generateHash**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[Node.ts:149](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L187)
-
-___
-
-### getText
-
-▸ **getText**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Node.ts:191](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L183)

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

@@ -1,64 +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:177](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L177)
-
-## Properties
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:175](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L175)
-
-## Methods
-
-### agetResponse
-
-▸ **agetResponse**(`query`, `textChunks`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `textChunks` | `string`[] |
-
-#### Returns
-
-`Promise`<`string`\>
-
-#### Implementation of
-
-BaseResponseBuilder.agetResponse
-
-#### Defined in
-
-[ResponseSynthesizer.ts:181](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L181)

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

@@ -1,102 +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**(`index`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `index` | [`VectorStoreIndex`](VectorStoreIndex.md) |
-
-#### Defined in
-
-[Retriever.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L28)
-
-## Properties
-
-### index
-
-• **index**: [`VectorStoreIndex`](VectorStoreIndex.md)
-
-#### Defined in
-
-[Retriever.ts:24](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L24)
-
-___
-
-### serviceContext
-
-• `Private` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Defined in
-
-[Retriever.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L26)
-
-___
-
-### similarityTopK
-
-• **similarityTopK**: `number` = `DEFAULT_SIMILARITY_TOP_K`
-
-#### Defined in
-
-[Retriever.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L25)
-
-## Methods
-
-### aretrieve
-
-▸ **aretrieve**(`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).[aretrieve](../interfaces/BaseRetriever.md#aretrieve)
-
-#### Defined in
-
-[Retriever.ts:33](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L33)
-
-___
-
-### getServiceContext
-
-▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Returns
-
-[`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Implementation of
-
-[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext)
-
-#### Defined in
-
-[Retriever.ts:70](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L70)

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

@@ -1,253 +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` |
-
-#### Overrides
-
-[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor)
-
-#### Defined in
-
-[BaseIndex.ts:109](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L109)
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore)
-
-#### Defined in
-
-[BaseIndex.ts:75](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L75)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore)
-
-#### Defined in
-
-[BaseIndex.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L77)
-
-___
-
-### indexStruct
-
-• **indexStruct**: [`IndexDict`](IndexDict.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct)
-
-#### Defined in
-
-[BaseIndex.ts:78](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L78)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext)
-
-#### Defined in
-
-[BaseIndex.ts:73](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L73)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md)
-
-#### Inherited from
-
-[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext)
-
-#### Defined in
-
-[BaseIndex.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L74)
-
-___
-
-### vectorStore
-
-• **vectorStore**: `VectorStore`
-
-#### Overrides
-
-[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore)
-
-#### Defined in
-
-[BaseIndex.ts:107](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L107)
-
-## Methods
-
-### asQueryEngine
-
-▸ **asQueryEngine**(): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-Get a retriever query engine for this index.
-
-NOTE: if you are using a custom query engine you don't have to use this method.
-
-#### Returns
-
-[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)
-
-#### Defined in
-
-[BaseIndex.ts:252](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L252)
-
-___
-
-### asRetriever
-
-▸ **asRetriever**(): [`VectorIndexRetriever`](VectorIndexRetriever.md)
-
-Get a VectorIndexRetriever for this index.
-
-NOTE: if you want to use a custom retriever you don't have to use this method.
-
-#### Returns
-
-[`VectorIndexRetriever`](VectorIndexRetriever.md)
-
-retriever for the index
-
-#### Overrides
-
-[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever)
-
-#### Defined in
-
-[BaseIndex.ts:242](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L242)
-
-___
-
-### agetNodeEmbeddingResults
-
-▸ `Static` **agetNodeEmbeddingResults**(`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
-
-[BaseIndex.ts:159](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L159)
-
-___
-
-### buildIndexFromNodes
-
-▸ `Static` **buildIndexFromNodes**(`nodes`, `serviceContext`, `vectorStore`): `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` |
-
-#### Returns
-
-`Promise`<[`IndexDict`](IndexDict.md)\>
-
-#### Defined in
-
-[BaseIndex.ts:187](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L187)
-
-___
-
-### 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
-
-[BaseIndex.ts:214](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L214)
-
-___
-
-### init
-
-▸ `Static` **init**(`options`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `options` | [`VectorIndexOptions`](../interfaces/VectorIndexOptions.md) |
-
-#### Returns
-
-`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\>
-
-#### Defined in
-
-[BaseIndex.ts:114](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L114)

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
-
-[index/list/ListIndex.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L21)
-
-___
-
-### LLM
-
-• **LLM** = ``"llm"``
-
-#### Defined in
-
-[index/list/ListIndex.ts:23](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/index/list/ListIndex.ts#L23)

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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L19)
-
-___
-
-### EMBED
-
-• **EMBED** = ``"EMBED"``
-
-#### Defined in
-
-[Node.ts:20](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L20)
-
-___
-
-### LLM
-
-• **LLM** = ``"LLM"``
-
-#### Defined in
-
-[Node.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L21)
-
-___
-
-### NONE
-
-• **NONE** = ``"NONE"``
-
-#### Defined in
-
-[Node.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L8)
-
-___
-
-### NEXT
-
-• **NEXT** = ``"NEXT"``
-
-#### Defined in
-
-[Node.ts:6](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L6)
-
-___
-
-### PARENT
-
-• **PARENT** = ``"PARENT"``
-
-#### Defined in
-
-[Node.ts:7](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L7)
-
-___
-
-### PREVIOUS
-
-• **PREVIOUS** = ``"PREVIOUS"``
-
-#### Defined in
-
-[Node.ts:5](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L5)
-
-___
-
-### SOURCE
-
-• **SOURCE** = ``"SOURCE"``
-
-#### Defined in
-
-[Node.ts:4](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L15)
-
-___
-
-### IMAGE
-
-• **IMAGE** = ``"IMAGE"``
-
-#### Defined in
-
-[Node.ts:13](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L13)
-
-___
-
-### INDEX
-
-• **INDEX** = ``"INDEX"``
-
-#### Defined in
-
-[Node.ts:14](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L14)
-
-___
-
-### TEXT
-
-• **TEXT** = ``"TEXT"``
-
-#### Defined in
-
-[Node.ts:12](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L10)
-
-___
-
-### DOT\_PRODUCT
-
-• **DOT\_PRODUCT** = ``"dot_product"``
-
-#### Defined in
-
-[Embedding.ts:11](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L11)
-
-___
-
-### EUCLIDEAN
-
-• **EUCLIDEAN** = ``"euclidean"``
-
-#### Defined in
-
-[Embedding.ts:12](https://github.com/run-llama/llamascript/blob/6ea89db/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,86 +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.aquery(
-    "What did the author do in college?"
-  );
-
-  // Output response
-  console.log(response.toString());
-}
-```
-
-Then you can run it using
-
-```bash
-npx ts-node example.ts
-```
-
-## Core concepts:
-
-- [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.
-
-- Indexes: indexes store the Nodes and the embeddings of those nodes.
-
-- [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 Indexes.
-
-- [SimplePrompt](packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and puts them in a prebuilt template.
-
-## 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,73 +0,0 @@
----
-id: "BaseIndexInit"
-title: "Interface: BaseIndexInit<T>"
-sidebar_label: "BaseIndexInit"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-## Properties
-
-### docStore
-
-• **docStore**: `BaseDocumentStore`
-
-#### Defined in
-
-[BaseIndex.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L62)
-
-___
-
-### indexStore
-
-• `Optional` **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[BaseIndex.ts:64](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L64)
-
-___
-
-### indexStruct
-
-• **indexStruct**: `T`
-
-#### Defined in
-
-[BaseIndex.ts:65](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L65)
-
-___
-
-### serviceContext
-
-• **serviceContext**: [`ServiceContext`](ServiceContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:60](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L60)
-
-___
-
-### storageContext
-
-• **storageContext**: [`StorageContext`](StorageContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:61](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L61)
-
-___
-
-### vectorStore
-
-• `Optional` **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[BaseIndex.ts:63](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L63)

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
-
-### apredict
-
-▸ **apredict**(`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/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L10)
-
-___
-
-### getLlmMetadata
-
-▸ **getLlmMetadata**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[LLMPredictor.ts:9](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLMPredictor.ts#L9)

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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/OutputParser.ts#L7)

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

@@ -1,35 +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
-
-### aquery
-
-▸ **aquery**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<[`Response`](../classes/Response.md)\>
-
-#### Defined in
-
-[QueryEngine.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QueryEngine.ts#L19)

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
-
-### agenerate
-
-▸ **agenerate**(`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/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L23)

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

@@ -1,33 +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
-
-- [`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/llamascript/blob/6ea89db/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
-
-### aretrieve
-
-▸ **aretrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parentEvent?` | [`Event`](Event.md) |
-
-#### Returns
-
-`Promise`<[`NodeWithScore`](NodeWithScore.md)[]\>
-
-#### Defined in
-
-[Retriever.ts:16](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L16)
-
-___
-
-### getServiceContext
-
-▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md)
-
-#### Returns
-
-[`ServiceContext`](ServiceContext.md)
-
-#### Defined in
-
-[Retriever.ts:17](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Retriever.ts#L17)

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/llamascript/blob/6ea89db/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
-
-### achat
-
-▸ **achat**(`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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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.ts:14](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L14)
-
-___
-
-### role
-
-• **role**: `MessageType`
-
-#### Defined in
-
-[LLM.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/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.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L21)
-
-___
-
-### message
-
-• **message**: [`ChatMessage`](ChatMessage.md)
-
-#### Defined in
-
-[LLM.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L19)
-
-___
-
-### raw
-
-• `Optional` **raw**: `Record`<`string`, `any`\>
-
-#### Defined in
-
-[LLM.ts:20](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L14)
-
-___
-
-### parentId
-
-• `Optional` **parentId**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:17](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L16)
-
-___
-
-### type
-
-• **type**: [`EventType`](../modules.md#eventtype)
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L10)

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

@@ -1,57 +0,0 @@
----
-id: "LLM"
-title: "Interface: LLM"
-sidebar_label: "LLM"
-sidebar_position: 0
-custom_edit_url: null
----
-
-Unified language model interface
-
-## Implemented by
-
-- [`OpenAI`](../classes/OpenAI.md)
-
-## Methods
-
-### achat
-
-▸ **achat**(`messages`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-Get a chat response from the LLM
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `messages` | [`ChatMessage`](ChatMessage.md)[] |
-
-#### Returns
-
-`Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-#### Defined in
-
-[LLM.ts:35](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L35)
-
-___
-
-### acomplete
-
-▸ **acomplete**(`prompt`): `Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-Get a prompt completion from the LLM
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `prompt` | `string` | the prompt to complete |
-
-#### Returns
-
-`Promise`<[`ChatResponse`](ChatResponse.md)\>
-
-#### Defined in
-
-[LLM.ts:41](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/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/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L247)
-
-___
-
-### node
-
-• **node**: [`BaseNode`](../classes/BaseNode.md)
-
-#### Defined in
-
-[Node.ts:246](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L238)
-
-___
-
-### score
-
-• **score**: `number`
-
-#### Defined in
-
-[Node.ts:239](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Tool.ts#L12)
-
-___
-
-### queryEngine
-
-• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md)
-
-#### Defined in
-
-[Tool.ts:19](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/Node.ts#L29)
-
-___
-
-### metadata
-
-• **metadata**: `Record`<`string`, `any`\>
-
-#### Defined in
-
-[Node.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L28)
-
-___
-
-### nodeId
-
-• **nodeId**: `string`
-
-#### Defined in
-
-[Node.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L26)
-
-___
-
-### nodeType
-
-• `Optional` **nodeType**: [`ObjectType`](../enums/ObjectType.md)
-
-#### Defined in
-
-[Node.ts:27](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L21)
-
-___
-
-### nodes
-
-• **nodes**: [`NodeWithScore`](NodeWithScore.md)[]
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:47](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L47)
-
-___
-
-### query
-
-• **query**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:46](https://github.com/run-llama/llamascript/blob/6ea89db/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:16](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L16)
-
-___
-
-### embedModel
-
-• **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
-
-#### Defined in
-
-[ServiceContext.ts:14](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L14)
-
-___
-
-### llmPredictor
-
-• **llmPredictor**: [`BaseLLMPredictor`](BaseLLMPredictor.md)
-
-#### Defined in
-
-[ServiceContext.ts:12](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L12)
-
-___
-
-### nodeParser
-
-• **nodeParser**: [`NodeParser`](NodeParser.md)
-
-#### Defined in
-
-[ServiceContext.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L15)
-
-___
-
-### promptHelper
-
-• **promptHelper**: `PromptHelper`
-
-#### Defined in
-
-[ServiceContext.ts:13](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L13)

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

@@ -1,87 +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:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L26)
-
-___
-
-### chunkOverlap
-
-• `Optional` **chunkOverlap**: `number`
-
-#### Defined in
-
-[ServiceContext.ts:29](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L29)
-
-___
-
-### chunkSize
-
-• `Optional` **chunkSize**: `number`
-
-#### Defined in
-
-[ServiceContext.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L28)
-
-___
-
-### embedModel
-
-• `Optional` **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md)
-
-#### Defined in
-
-[ServiceContext.ts:24](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L24)
-
-___
-
-### llm
-
-• `Optional` **llm**: [`OpenAI`](../classes/OpenAI.md)
-
-#### Defined in
-
-[ServiceContext.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L22)
-
-___
-
-### llmPredictor
-
-• `Optional` **llmPredictor**: [`BaseLLMPredictor`](BaseLLMPredictor.md)
-
-#### Defined in
-
-[ServiceContext.ts:21](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L21)
-
-___
-
-### nodeParser
-
-• `Optional` **nodeParser**: [`NodeParser`](NodeParser.md)
-
-#### Defined in
-
-[ServiceContext.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L25)
-
-___
-
-### promptHelper
-
-• `Optional` **promptHelper**: `PromptHelper`
-
-#### Defined in
-
-[ServiceContext.ts:23](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L23)

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/llamascript/blob/6ea89db/packages/core/src/storage/StorageContext.ts#L15)
-
-___
-
-### indexStore
-
-• **indexStore**: `BaseIndexStore`
-
-#### Defined in
-
-[storage/StorageContext.ts:16](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/StorageContext.ts#L16)
-
-___
-
-### vectorStore
-
-• **vectorStore**: `VectorStore`
-
-#### Defined in
-
-[storage/StorageContext.ts:17](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L21)
-
-___
-
-### index
-
-• **index**: `number`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:40](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L40)
-
-___
-
-### isDone
-
-• `Optional` **isDone**: `boolean`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:41](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L41)
-
-___
-
-### token
-
-• `Optional` **token**: [`StreamToken`](StreamToken.md)
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/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/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L29)
-
-___
-
-### created
-
-• **created**: `number`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:27](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L27)
-
-___
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L25)
-
-___
-
-### model
-
-• **model**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L28)
-
-___
-
-### object
-
-• **object**: `string`
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L26)

apps/docs/docs/api/interfaces/StructuredOutput.md

@@ -1,35 +0,0 @@
----
-id: "StructuredOutput"
-title: "Interface: StructuredOutput<T>"
-sidebar_label: "StructuredOutput"
-sidebar_position: 0
-custom_edit_url: null
----
-
-StructuredOutput is just a combo of the raw output and the parsed output.
-
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-## Properties
-
-### parsedOutput
-
-• **parsedOutput**: `T`
-
-#### Defined in
-
-[OutputParser.ts:16](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/OutputParser.ts#L16)
-
-___
-
-### rawOutput
-
-• **rawOutput**: `string`
-
-#### Defined in
-
-[OutputParser.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/OutputParser.ts#L15)

apps/docs/docs/api/interfaces/SubQuestion.md

@@ -1,27 +0,0 @@
----
-id: "SubQuestion"
-title: "Interface: SubQuestion"
-sidebar_label: "SubQuestion"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### subQuestion
-
-• **subQuestion**: `string`
-
-#### Defined in
-
-[QuestionGenerator.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L15)
-
-___
-
-### toolName
-
-• **toolName**: `string`
-
-#### Defined in
-
-[QuestionGenerator.ts:16](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/QuestionGenerator.ts#L16)

apps/docs/docs/api/interfaces/ToolMetadata.md

@@ -1,27 +0,0 @@
----
-id: "ToolMetadata"
-title: "Interface: ToolMetadata"
-sidebar_label: "ToolMetadata"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### description
-
-• **description**: `string`
-
-#### Defined in
-
-[Tool.ts:4](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Tool.ts#L4)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[Tool.ts:5](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Tool.ts#L5)

apps/docs/docs/api/interfaces/VectorIndexOptions.md

@@ -1,47 +0,0 @@
----
-id: "VectorIndexOptions"
-title: "Interface: VectorIndexOptions"
-sidebar_label: "VectorIndexOptions"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Properties
-
-### indexStruct
-
-• `Optional` **indexStruct**: [`IndexDict`](../classes/IndexDict.md)
-
-#### Defined in
-
-[BaseIndex.ts:94](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L94)
-
-___
-
-### nodes
-
-• `Optional` **nodes**: [`BaseNode`](../classes/BaseNode.md)[]
-
-#### Defined in
-
-[BaseIndex.ts:93](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L93)
-
-___
-
-### serviceContext
-
-• `Optional` **serviceContext**: [`ServiceContext`](ServiceContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:95](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L95)
-
-___
-
-### storageContext
-
-• `Optional` **storageContext**: [`StorageContext`](StorageContext.md)
-
-#### Defined in
-
-[BaseIndex.ts:96](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/BaseIndex.ts#L96)

apps/docs/docs/api/interfaces/WalkableFileSystem.md

@@ -1,47 +0,0 @@
----
-id: "WalkableFileSystem"
-title: "Interface: WalkableFileSystem"
-sidebar_label: "WalkableFileSystem"
-sidebar_position: 0
-custom_edit_url: null
----
-
-## Methods
-
-### readdir
-
-▸ **readdir**(`path`): `Promise`<`string`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`Promise`<`string`[]\>
-
-#### Defined in
-
-[storage/FileSystem.ts:17](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L17)
-
-___
-
-### stat
-
-▸ **stat**(`path`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:18](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L18)

apps/docs/docs/api/interfaces/_category_.yml

@@ -1,2 +0,0 @@
-label: "Interfaces"
-position: 4

apps/docs/docs/api/modules.md

@@ -1,914 +0,0 @@
----
-id: "modules"
-title: "llamaindex"
-sidebar_label: "Exports"
-sidebar_position: 0.5
-custom_edit_url: null
----
-
-## Enumerations
-
-- [ListRetrieverMode](enums/ListRetrieverMode.md)
-- [MetadataMode](enums/MetadataMode.md)
-- [NodeRelationship](enums/NodeRelationship.md)
-- [ObjectType](enums/ObjectType.md)
-- [SimilarityType](enums/SimilarityType.md)
-
-## Classes
-
-- [BaseEmbedding](classes/BaseEmbedding.md)
-- [BaseIndex](classes/BaseIndex.md)
-- [BaseNode](classes/BaseNode.md)
-- [CallbackManager](classes/CallbackManager.md)
-- [ChatGPTLLMPredictor](classes/ChatGPTLLMPredictor.md)
-- [CompactAndRefine](classes/CompactAndRefine.md)
-- [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md)
-- [ContextChatEngine](classes/ContextChatEngine.md)
-- [Document](classes/Document.md)
-- [InMemoryFileSystem](classes/InMemoryFileSystem.md)
-- [IndexDict](classes/IndexDict.md)
-- [IndexList](classes/IndexList.md)
-- [IndexNode](classes/IndexNode.md)
-- [IndexStruct](classes/IndexStruct.md)
-- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md)
-- [ListIndex](classes/ListIndex.md)
-- [ListIndexLLMRetriever](classes/ListIndexLLMRetriever.md)
-- [ListIndexRetriever](classes/ListIndexRetriever.md)
-- [OpenAI](classes/OpenAI.md)
-- [OpenAIEmbedding](classes/OpenAIEmbedding.md)
-- [Refine](classes/Refine.md)
-- [Response](classes/Response.md)
-- [ResponseSynthesizer](classes/ResponseSynthesizer.md)
-- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md)
-- [SentenceSplitter](classes/SentenceSplitter.md)
-- [SimpleChatEngine](classes/SimpleChatEngine.md)
-- [SimpleNodeParser](classes/SimpleNodeParser.md)
-- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md)
-- [SubQuestionOutputParser](classes/SubQuestionOutputParser.md)
-- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md)
-- [TextFileReader](classes/TextFileReader.md)
-- [TextNode](classes/TextNode.md)
-- [TreeSummarize](classes/TreeSummarize.md)
-- [VectorIndexRetriever](classes/VectorIndexRetriever.md)
-- [VectorStoreIndex](classes/VectorStoreIndex.md)
-
-## Interfaces
-
-- [BaseIndexInit](interfaces/BaseIndexInit.md)
-- [BaseLLMPredictor](interfaces/BaseLLMPredictor.md)
-- [BaseOutputParser](interfaces/BaseOutputParser.md)
-- [BaseQueryEngine](interfaces/BaseQueryEngine.md)
-- [BaseQuestionGenerator](interfaces/BaseQuestionGenerator.md)
-- [BaseReader](interfaces/BaseReader.md)
-- [BaseRetriever](interfaces/BaseRetriever.md)
-- [BaseTool](interfaces/BaseTool.md)
-- [ChatEngine](interfaces/ChatEngine.md)
-- [ChatMessage](interfaces/ChatMessage.md)
-- [ChatResponse](interfaces/ChatResponse.md)
-- [Event](interfaces/Event.md)
-- [GenericFileSystem](interfaces/GenericFileSystem.md)
-- [LLM](interfaces/LLM.md)
-- [NodeParser](interfaces/NodeParser.md)
-- [NodeWithEmbedding](interfaces/NodeWithEmbedding.md)
-- [NodeWithScore](interfaces/NodeWithScore.md)
-- [QueryEngineTool](interfaces/QueryEngineTool.md)
-- [RelatedNodeInfo](interfaces/RelatedNodeInfo.md)
-- [RetrievalCallbackResponse](interfaces/RetrievalCallbackResponse.md)
-- [ServiceContext](interfaces/ServiceContext.md)
-- [ServiceContextOptions](interfaces/ServiceContextOptions.md)
-- [StorageContext](interfaces/StorageContext.md)
-- [StreamCallbackResponse](interfaces/StreamCallbackResponse.md)
-- [StreamToken](interfaces/StreamToken.md)
-- [StructuredOutput](interfaces/StructuredOutput.md)
-- [SubQuestion](interfaces/SubQuestion.md)
-- [ToolMetadata](interfaces/ToolMetadata.md)
-- [VectorIndexOptions](interfaces/VectorIndexOptions.md)
-- [WalkableFileSystem](interfaces/WalkableFileSystem.md)
-
-## Type Aliases
-
-### CompleteFileSystem
-
-Ƭ **CompleteFileSystem**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) & [`WalkableFileSystem`](interfaces/WalkableFileSystem.md)
-
-#### Defined in
-
-[storage/FileSystem.ts:49](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L49)
-
-___
-
-### CompletionResponse
-
-Ƭ **CompletionResponse**: [`ChatResponse`](interfaces/ChatResponse.md)
-
-#### Defined in
-
-[LLM.ts:25](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L25)
-
-___
-
-### EventTag
-
-Ƭ **EventTag**: ``"intermediate"`` \| ``"final"``
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:11](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L11)
-
-___
-
-### EventType
-
-Ƭ **EventType**: ``"retrieve"`` \| ``"llmPredict"`` \| ``"wrapper"``
-
-#### Defined in
-
-[callbacks/CallbackManager.ts:12](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/callbacks/CallbackManager.ts#L12)
-
-___
-
-### RelatedNodeType
-
-Ƭ **RelatedNodeType**: [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md) \| [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md)[]
-
-#### Defined in
-
-[Node.ts:32](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Node.ts#L32)
-
-___
-
-### SimpleDirectoryReaderLoadDataProps
-
-Ƭ **SimpleDirectoryReaderLoadDataProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `defaultReader?` | [`BaseReader`](interfaces/BaseReader.md) \| ``null`` |
-| `directoryPath` | `string` |
-| `fileExtToReader?` | `Record`<`string`, [`BaseReader`](interfaces/BaseReader.md)\> |
-| `fs?` | [`CompleteFileSystem`](modules.md#completefilesystem) |
-
-#### Defined in
-
-[readers/SimpleDirectoryReader.ts:26](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/readers/SimpleDirectoryReader.ts#L26)
-
-___
-
-### SimplePrompt
-
-Ƭ **SimplePrompt**: (`input`: `Record`<`string`, `string`\>) => `string`
-
-#### Type declaration
-
-▸ (`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-##### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-## Variables
-
-### ALL\_AVAILABLE\_MODELS
-
-• `Const` **ALL\_AVAILABLE\_MODELS**: `Object`
-
-We currently support GPT-3.5 and GPT-4 models
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `gpt-3.5-turbo` | `number` |
-| `gpt-3.5-turbo-16k` | `number` |
-| `gpt-4` | `number` |
-| `gpt-4-32k` | `number` |
-
-#### Defined in
-
-[LLM.ts:57](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L57)
-
-___
-
-### DEFAULT\_CHUNK\_OVERLAP
-
-• `Const` **DEFAULT\_CHUNK\_OVERLAP**: ``20``
-
-#### Defined in
-
-[constants.ts:5](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L5)
-
-___
-
-### DEFAULT\_CHUNK\_OVERLAP\_RATIO
-
-• `Const` **DEFAULT\_CHUNK\_OVERLAP\_RATIO**: ``0.1``
-
-#### Defined in
-
-[constants.ts:6](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L6)
-
-___
-
-### DEFAULT\_CHUNK\_SIZE
-
-• `Const` **DEFAULT\_CHUNK\_SIZE**: ``1024``
-
-#### Defined in
-
-[constants.ts:4](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L4)
-
-___
-
-### DEFAULT\_COLLECTION
-
-• `Const` **DEFAULT\_COLLECTION**: ``"data"``
-
-#### Defined in
-
-[storage/constants.ts:1](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L1)
-
-___
-
-### DEFAULT\_CONTEXT\_WINDOW
-
-• `Const` **DEFAULT\_CONTEXT\_WINDOW**: ``3900``
-
-#### Defined in
-
-[constants.ts:1](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L1)
-
-___
-
-### DEFAULT\_DOC\_STORE\_PERSIST\_FILENAME
-
-• `Const` **DEFAULT\_DOC\_STORE\_PERSIST\_FILENAME**: ``"docstore.json"``
-
-#### Defined in
-
-[storage/constants.ts:4](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L4)
-
-___
-
-### DEFAULT\_EMBEDDING\_DIM
-
-• `Const` **DEFAULT\_EMBEDDING\_DIM**: ``1536``
-
-#### Defined in
-
-[constants.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L10)
-
-___
-
-### DEFAULT\_FS
-
-• `Const` **DEFAULT\_FS**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) \| [`CompleteFileSystem`](modules.md#completefilesystem)
-
-#### Defined in
-
-[storage/FileSystem.ts:62](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L62)
-
-___
-
-### DEFAULT\_GRAPH\_STORE\_PERSIST\_FILENAME
-
-• `Const` **DEFAULT\_GRAPH\_STORE\_PERSIST\_FILENAME**: ``"graph_store.json"``
-
-#### Defined in
-
-[storage/constants.ts:6](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L6)
-
-___
-
-### DEFAULT\_INDEX\_STORE\_PERSIST\_FILENAME
-
-• `Const` **DEFAULT\_INDEX\_STORE\_PERSIST\_FILENAME**: ``"index_store.json"``
-
-#### Defined in
-
-[storage/constants.ts:3](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L3)
-
-___
-
-### DEFAULT\_NAMESPACE
-
-• `Const` **DEFAULT\_NAMESPACE**: ``"docstore"``
-
-#### Defined in
-
-[storage/constants.ts:7](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L7)
-
-___
-
-### DEFAULT\_NUM\_OUTPUTS
-
-• `Const` **DEFAULT\_NUM\_OUTPUTS**: ``256``
-
-#### Defined in
-
-[constants.ts:2](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L2)
-
-___
-
-### DEFAULT\_PADDING
-
-• `Const` **DEFAULT\_PADDING**: ``5``
-
-#### Defined in
-
-[constants.ts:11](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L11)
-
-___
-
-### DEFAULT\_PERSIST\_DIR
-
-• `Const` **DEFAULT\_PERSIST\_DIR**: ``"./storage"``
-
-#### Defined in
-
-[storage/constants.ts:2](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L2)
-
-___
-
-### DEFAULT\_SIMILARITY\_TOP\_K
-
-• `Const` **DEFAULT\_SIMILARITY\_TOP\_K**: ``2``
-
-#### Defined in
-
-[constants.ts:7](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/constants.ts#L7)
-
-___
-
-### DEFAULT\_VECTOR\_STORE\_PERSIST\_FILENAME
-
-• `Const` **DEFAULT\_VECTOR\_STORE\_PERSIST\_FILENAME**: ``"vector_store.json"``
-
-#### Defined in
-
-[storage/constants.ts:5](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/constants.ts#L5)
-
-___
-
-### GPT4\_MODELS
-
-• `Const` **GPT4\_MODELS**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `gpt-4` | `number` |
-| `gpt-4-32k` | `number` |
-
-#### Defined in
-
-[LLM.ts:44](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L44)
-
-___
-
-### TURBO\_MODELS
-
-• `Const` **TURBO\_MODELS**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `gpt-3.5-turbo` | `number` |
-| `gpt-3.5-turbo-16k` | `number` |
-
-#### Defined in
-
-[LLM.ts:49](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/LLM.ts#L49)
-
-___
-
-### globalsHelper
-
-• `Const` **globalsHelper**: `GlobalsHelper`
-
-#### Defined in
-
-[GlobalsHelper.ts:42](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/GlobalsHelper.ts#L42)
-
-## Functions
-
-### buildToolsText
-
-▸ **buildToolsText**(`tools`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `tools` | [`ToolMetadata`](interfaces/ToolMetadata.md)[] |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:198](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L198)
-
-___
-
-### contextSystemPrompt
-
-▸ **contextSystemPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultChoiceSelectPrompt
-
-▸ **defaultChoiceSelectPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultCondenseQuestionPrompt
-
-▸ **defaultCondenseQuestionPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultRefinePrompt
-
-▸ **defaultRefinePrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultSubQuestionPrompt
-
-▸ **defaultSubQuestionPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultSummaryPrompt
-
-▸ **defaultSummaryPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### defaultTextQaPrompt
-
-▸ **defaultTextQaPrompt**(`input`): `string`
-
-A SimplePrompt is a function that takes a dictionary of inputs and returns a string.
-NOTE this is a different interface compared to LlamaIndex Python
-NOTE 2: we default to empty string to make it easy to calculate prompt sizes
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `input` | `Record`<`string`, `string`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:10](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L10)
-
-___
-
-### exists
-
-▸ **exists**(`fs`, `path`): `Promise`<`boolean`\>
-
-Checks if a file exists.
-Analogous to the os.path.exists function from Python.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fs` | [`GenericFileSystem`](interfaces/GenericFileSystem.md) | The filesystem to use. |
-| `path` | `string` | The path to the file to check. |
-
-#### Returns
-
-`Promise`<`boolean`\>
-
-A promise that resolves to true if the file exists, false otherwise.
-
-#### Defined in
-
-[storage/FileSystem.ts:74](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L74)
-
-___
-
-### getNodeFS
-
-▸ **getNodeFS**(): [`CompleteFileSystem`](modules.md#completefilesystem)
-
-#### Returns
-
-[`CompleteFileSystem`](modules.md#completefilesystem)
-
-#### Defined in
-
-[storage/FileSystem.ts:51](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L51)
-
-___
-
-### getNodesFromDocument
-
-▸ **getNodesFromDocument**(`document`, `textSplitter`, `includeMetadata?`, `includePrevNextRel?`): [`TextNode`](classes/TextNode.md)[]
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `document` | [`Document`](classes/Document.md) | `undefined` |
-| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) | `undefined` |
-| `includeMetadata` | `boolean` | `true` |
-| `includePrevNextRel` | `boolean` | `true` |
-
-#### Returns
-
-[`TextNode`](classes/TextNode.md)[]
-
-#### Defined in
-
-[NodeParser.ts:15](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/NodeParser.ts#L15)
-
-___
-
-### getResponseBuilder
-
-▸ **getResponseBuilder**(`serviceContext?`): [`SimpleResponseBuilder`](classes/SimpleResponseBuilder.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `serviceContext?` | [`ServiceContext`](interfaces/ServiceContext.md) |
-
-#### Returns
-
-[`SimpleResponseBuilder`](classes/SimpleResponseBuilder.md)
-
-#### Defined in
-
-[ResponseSynthesizer.ts:212](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ResponseSynthesizer.ts#L212)
-
-___
-
-### getTextSplitsFromDocument
-
-▸ **getTextSplitsFromDocument**(`document`, `textSplitter`): `string`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `document` | [`Document`](classes/Document.md) |
-| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) |
-
-#### Returns
-
-`string`[]
-
-#### Defined in
-
-[NodeParser.ts:5](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/NodeParser.ts#L5)
-
-___
-
-### getTopKEmbeddings
-
-▸ **getTopKEmbeddings**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingIds?`, `similarityCutoff?`): [`number`[], `any`[]]
-
-Get the top K embeddings from a list of embeddings ordered by similarity to the query.
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `queryEmbedding` | `number`[] | `undefined` |  |
-| `embeddings` | `number`[][] | `undefined` | list of embeddings to consider |
-| `similarityTopK` | `number` | `DEFAULT_SIMILARITY_TOP_K` | max number of embeddings to return, default 2 |
-| `embeddingIds` | ``null`` \| `any`[] | `null` | ids of embeddings in the embeddings list |
-| `similarityCutoff` | ``null`` \| `number` | `null` | minimum similarity score |
-
-#### Returns
-
-[`number`[], `any`[]]
-
-#### Defined in
-
-[Embedding.ts:77](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L77)
-
-___
-
-### getTopKEmbeddingsLearner
-
-▸ **getTopKEmbeddingsLearner**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingsIds?`, `queryMode?`): [`number`[], `any`[]]
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `queryEmbedding` | `number`[] | `undefined` |
-| `embeddings` | `number`[][] | `undefined` |
-| `similarityTopK?` | `number` | `undefined` |
-| `embeddingsIds?` | `any`[] | `undefined` |
-| `queryMode` | `VectorStoreQueryMode` | `VectorStoreQueryMode.SVM` |
-
-#### Returns
-
-[`number`[], `any`[]]
-
-#### Defined in
-
-[Embedding.ts:119](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L119)
-
-___
-
-### getTopKMMREmbeddings
-
-▸ **getTopKMMREmbeddings**(`queryEmbedding`, `embeddings`, `similarityFn?`, `similarityTopK?`, `embeddingIds?`, `_similarityCutoff?`, `mmrThreshold?`): [`number`[], `any`[]]
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `queryEmbedding` | `number`[] | `undefined` |
-| `embeddings` | `number`[][] | `undefined` |
-| `similarityFn` | ``null`` \| (...`args`: `any`[]) => `number` | `null` |
-| `similarityTopK` | ``null`` \| `number` | `null` |
-| `embeddingIds` | ``null`` \| `any`[] | `null` |
-| `_similarityCutoff` | ``null`` \| `number` | `null` |
-| `mmrThreshold` | ``null`` \| `number` | `null` |
-
-#### Returns
-
-[`number`[], `any`[]]
-
-#### Defined in
-
-[Embedding.ts:131](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L131)
-
-___
-
-### messagesToHistoryStr
-
-▸ **messagesToHistoryStr**(`messages`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `messages` | [`ChatMessage`](interfaces/ChatMessage.md)[] |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[Prompt.ts:300](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Prompt.ts#L300)
-
-___
-
-### serviceContextFromDefaults
-
-▸ **serviceContextFromDefaults**(`options?`): [`ServiceContext`](interfaces/ServiceContext.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `options?` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) |
-
-#### Returns
-
-[`ServiceContext`](interfaces/ServiceContext.md)
-
-#### Defined in
-
-[ServiceContext.ts:32](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L32)
-
-___
-
-### serviceContextFromServiceContext
-
-▸ **serviceContextFromServiceContext**(`serviceContext`, `options`): `Object`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) |
-| `options` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) |
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `callbackManager` | [`CallbackManager`](classes/CallbackManager.md) |
-| `embedModel` | [`BaseEmbedding`](classes/BaseEmbedding.md) |
-| `llmPredictor` | [`BaseLLMPredictor`](interfaces/BaseLLMPredictor.md) |
-| `nodeParser` | [`NodeParser`](interfaces/NodeParser.md) |
-| `promptHelper` | `PromptHelper` |
-
-#### Defined in
-
-[ServiceContext.ts:52](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/ServiceContext.ts#L52)
-
-___
-
-### similarity
-
-▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number`
-
-The similarity between two embeddings.
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `embedding1` | `number`[] | `undefined` |
-| `embedding2` | `number`[] | `undefined` |
-| `mode` | [`SimilarityType`](enums/SimilarityType.md) | `SimilarityType.DEFAULT` |
-
-#### Returns
-
-`number`
-
-similartiy score with higher numbers meaning the two embeddings are more similar
-
-#### Defined in
-
-[Embedding.ts:22](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/Embedding.ts#L22)
-
-___
-
-### storageContextFromDefaults
-
-▸ **storageContextFromDefaults**(`«destructured»`): `Promise`<[`StorageContext`](interfaces/StorageContext.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `«destructured»` | `BuilderParams` |
-
-#### Returns
-
-`Promise`<[`StorageContext`](interfaces/StorageContext.md)\>
-
-#### Defined in
-
-[storage/StorageContext.ts:28](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/StorageContext.ts#L28)
-
-___
-
-### walk
-
-▸ **walk**(`fs`, `dirPath`): `AsyncIterable`<`string`\>
-
-Recursively traverses a directory and yields all the paths to the files in it.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fs` | [`WalkableFileSystem`](interfaces/WalkableFileSystem.md) | The filesystem to use. |
-| `dirPath` | `string` | The path to the directory to traverse. |
-
-#### Returns
-
-`AsyncIterable`<`string`\>
-
-#### Defined in
-
-[storage/FileSystem.ts:91](https://github.com/run-llama/llamascript/blob/6ea89db/packages/core/src/storage/FileSystem.ts#L91)

apps/docs/docs/concepts.md

@@ -1,33 +1,78 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 ---
 
-# Concepts
+# High-Level Concepts
 
-## High Level API
+LlamaIndex.TS helps you build LLM-powered applications (e.g. Q&A, chatbot) over custom data.
 
-- Document: A document represents a text file, PDF file or other contiguous piece of data.
+In this high-level concepts guide, you will learn:
 
-- Node: 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.
+- how an LLM can answer questions using your own data.
+- key concepts and modules in LlamaIndex.TS for composing your own query pipeline.
 
-- Indexes: indexes store the Nodes and the embeddings of those nodes.
+## Answering Questions Across Your Data
 
-- QueryEngine: 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.
+LlamaIndex uses a two stage method when using an LLM with your data:
 
-- ChatEngine: A ChatEngine helps you build a chatbot that will interact with your Indexes.
+1. **indexing stage**: preparing a knowledge base, and
+2. **querying stage**: retrieving relevant context from the knowledge to assist the LLM in responding to a question
 
-## Low Level API
+![](./_static/concepts/rag.jpg)
 
-- SimplePrompt: A simple standardized function call definition that takes in inputs and puts them in a prebuilt template.
+This process is also known as Retrieval Augmented Generation (RAG).
 
-- LLM: The LLM class is a unified interface over a large language model provider such as OpenAI GPT-4, Anthropic Claude, or Meta LLaMA. You can subclass it to write a connector to your own large language model.
+LlamaIndex.TS provides the essential toolkit for making both steps super easy.
 
-- Embedding: An embedding is represented as a vector of floating point numbers. OpenAI's text-embedding-ada-002 is our default embedding model and each embedding it generates consists of 1,536 floating point numbers. Another popular embedding model is BERT which uses 768 floating point numbers to represent each Node. We provide a number of utilities to work with embeddings including 3 similarity calculation options and Maximum Marginal Relevance
+Let's explore each stage in detail.
 
-- Reader/Loader: A reader or loader is something that takes in a document in the real world and transforms into a Document class that can then be used in your Index and queries. We currently support plain text files and PDFs with many many more to come.
+### Indexing Stage
 
-- TextSplitter: Text splitting strategies are incredibly important to the overall efficacy of the embedding search. Currently, while we do have a default, there's no one size fits all solution. Depending on the source documents, you may want to use different splitting sizes and strategies. Currently we support spliltting by fixed size, splitting by fixed size with overlapping sections, splitting by sentence, and splitting by paragraph.
+LlamaIndex.TS help you prepare the knowledge base with a suite of data connectors and indexes.
 
-- Retriever: The Retriever is what actually chooses the Nodes to retrieve from the index. Here, you may wish to try retrieving more or fewer Nodes per query, changing your similarity function, or creating your own retriever for each individual use case in your application. For example, you may wish to have a separate retriever for code content vs. text content.
+![](./_static/concepts/indexing.jpg)
 
-- Storage: At some point you're going to want to store your indexes, data and vectors instead of re-running the embedding models every time. IndexStore, DocStore, VectorStore, and KVStore are abstractions that let you do that. Combined, they form the StorageContext. Currently, we allow you to persist your embeddings in files on the filesystem (or a virtual in memory file system), but we are also actively adding integrations to Vector Databases.
+[**Data Loaders**](./modules/high_level/data_loader.md):
+A data connector (i.e. `Reader`) ingest data from different data sources and data formats into a simple `Document` representation (text and simple metadata).
+
+[**Documents / Nodes**](./modules/high_level/documents_and_nodes.md): A `Document` is a generic container around any data source - for instance, a PDF, an API output, or retrieved data from a database. A `Node` is the atomic unit of data in LlamaIndex and represents a "chunk" of a source `Document`. It's a rich representation that includes metadata and relationships (to other nodes) to enable accurate and expressive retrieval operations.
+
+[**Data Indexes**](./modules/high_level/data_index.md):
+Once you've ingested your data, LlamaIndex helps you index data into a format that's easy to retrieve.
+
+Under the hood, LlamaIndex parses the raw documents into intermediate representations, calculates vector embeddings, and stores your data in-memory or to disk.
+
+### Querying Stage
+
+In the querying stage, the query pipeline retrieves the most relevant context given a user query,
+and pass that to the LLM (along with the query) to synthesize a response.
+
+This gives the LLM up-to-date knowledge that is not in its original training data,
+(also reducing hallucination).
+
+The key challenge in the querying stage is retrieval, orchestration, and reasoning over (potentially many) knowledge bases.
+
+LlamaIndex provides composable modules that help you build and integrate RAG pipelines for Q&A (query engine), chatbot (chat engine), or as part of an agent.
+
+These building blocks can be customized to reflect ranking preferences, as well as composed to reason over multiple knowledge bases in a structured way.
+
+![](./_static/concepts/querying.jpg)
+
+#### Building Blocks
+
+[**Retrievers**](./modules/low_level/retriever.md):
+A retriever defines how to efficiently retrieve relevant context from a knowledge base (i.e. index) when given a query.
+The specific retrieval logic differs for difference indices, the most popular being dense retrieval against a vector index.
+
+[**Response Synthesizers**](./modules/low_level/response_synthesizer.md):
+A response synthesizer generates a response from an LLM, using a user query and a given set of retrieved text chunks.
+
+#### Pipelines
+
+[**Query Engines**](./modules/high_level/query_engine.md):
+A query engine is an end-to-end pipeline that allow you to ask question over your data.
+It takes in a natural language query, and returns a response, along with reference context retrieved and passed to the LLM.
+
+[**Chat Engines**](./modules/high_level/chat_engine.md):
+A chat engine is an end-to-end pipeline for having a conversation with your data
+(multiple back-and-forth instead of a single question & answer).

apps/docs/docs/end_to_end.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 4
+---
+
+# End to End Examples
+
+We include several end-to-end examples using LlamaIndex.TS in the repository
+
+## [Chat Engine](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/chatEngine.ts)
+
+Read a file and chat about it with the LLM.
+
+## [Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndex.ts)
+
+Create a vector index and query it. The vector index will use embeddings to fetch the top k most relevant nodes. By default, the top k is 2.
+
+## [Summary Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/summaryIndex.ts)
+
+Create a list index and query it. This example also use the `LLMRetriever`, which will use the LLM to select the best nodes to use when generating answer.
+
+## [Save / Load an Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/storageContext.ts)
+
+Create and load a vector index. Persistance to disk in LlamaIndex.TS happens automatically once a storage context object is created.
+
+## [Customized Vector Index](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/vectorIndexCustomize.ts)
+
+Create a vector index and query it, while also configuring the the `LLM`, the `ServiceContext`, and the `similarity_top_k`.
+
+## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/openai.ts)
+
+Create an OpenAI LLM and directly use it for chat.
+
+## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/llamadeuce.ts)
+
+Create a Llama-2 LLM and directly use it for chat.
+
+## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/subquestion.ts)
+
+Uses the `SubQuestionQueryEngine`, which breaks complex queries into multiple questions, and then aggreates a response across the answers to all sub-questions.
+
+## [Low Level Modules](https://github.com/run-llama/LlamaIndexTS/blob/main/apps/simple/lowlevel.ts)
+
+This example uses several low-level components, which removes the need for an actual query engine. These components can be used anywhere, in any application, or customized and sub-classed to meet your own needs.

apps/docs/docs/installation.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 0
+sidebar_position: 1
 ---
 
 # Installation and Setup