test: add e2e test for nextjs/node with tokenizer

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

.changeset/odd-insects-vanish.md

@@ -0,0 +1,5 @@
+---
+"@llamaindex/env": patch
+---
+
+Use tiktoken instead of tiktoken/lite and disable WASM tiktoken for non-Node environments

.changeset/pink-keys-kiss.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+include node relationships when converting jsonToDoc

.eslintrc.cjs

@@ -1,3 +1,5 @@
+const { join } = require("node:path");
+
 module.exports = {
   root: true,
   extends: [
@@ -6,7 +8,7 @@ module.exports = {
     "plugin:@typescript-eslint/recommended-type-checked-only",
   ],
   parserOptions: {
-    project: true,
+    project: join(__dirname, "tsconfig.eslint.json"),
     __tsconfigRootDir: __dirname,
   },
   settings: {
@@ -23,6 +25,7 @@ module.exports = {
         ignoreIIFE: true,
       },
     ],
+    "no-debugger": "error",
     "@typescript-eslint/await-thenable": "off",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/ban-types": "off",

.github/workflows/publish.yml

@@ -31,6 +31,6 @@ jobs:
 
       - name: Publish @llamaindex/core
         run: npx jsr publish --allow-slow-types
-        working-directory: packages/core
+        working-directory: packages/llamaindex
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish_github.yml

@@ -26,12 +26,12 @@ jobs:
       - name: Build tarball
         run: |
           pnpm pack
-        working-directory: packages/core
+        working-directory: packages/llamaindex
 
       - name: Create release
         uses: ncipollo/release-action@v1
         with:
-          artifacts: "packages/core/llamaindex-*.tgz"
+          artifacts: "packages/llamaindex/llamaindex-*.tgz"
           name: Release ${{ github.ref }}
-          bodyFile: "packages/core/CHANGELOG.md"
+          bodyFile: "packages/llamaindex/CHANGELOG.md"
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -71,7 +71,7 @@ jobs:
       - name: Build
         run: pnpm run build
       - name: Use Build For Examples
-        run: pnpm link ../packages/core/
+        run: pnpm link ../packages/llamaindex/
         working-directory: ./examples
       - name: Run Type Check
         run: pnpm run type-check
@@ -81,18 +81,20 @@ jobs:
         if: failure()
         with:
           name: typecheck-build-dist
-          path: ./packages/core/dist
+          path: ./packages/llamaindex/dist
           if-no-files-found: error
-  e2e-core-examples:
+  e2e-llamaindex-examples:
     strategy:
+      fail-fast: false
       matrix:
         packages:
           - cloudflare-worker-agent
           - nextjs-agent
           - nextjs-edge-runtime
-          - waku-query-engine
+          - nextjs-node-runtime
+    #          - waku-query-engine
     runs-on: ubuntu-latest
-    name: Build Core Example (${{ matrix.packages }})
+    name: Build LlamaIndex Example (${{ matrix.packages }})
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
@@ -107,7 +109,7 @@ jobs:
         run: pnpm run build
       - name: Build ${{ matrix.packages }}
         run: pnpm run build
-        working-directory: packages/core/e2e/examples/${{ matrix.packages }}
+        working-directory: packages/llamaindex/e2e/examples/${{ matrix.packages }}
 
   typecheck-examples:
     runs-on: ubuntu-latest
@@ -131,7 +133,7 @@ jobs:
         working-directory: packages/env
       - name: Pack llamaindex
         run: pnpm pack --pack-destination ${{ runner.temp }}
-        working-directory: packages/core
+        working-directory: packages/llamaindex
       - name: Install
         run: npm add ${{ runner.temp }}/*.tgz
         working-directory: ${{ runner.temp }}/examples

CONTRIBUTING.md

@@ -6,7 +6,7 @@ This is a monorepo built with Turborepo
 
 Right now there are two packages of importance:
 
-packages/core which is the main NPM library llamaindex
+packages/llamaindex which is the main NPM library llamaindex
 
 examples is where the demo code lives
 
@@ -41,7 +41,7 @@ To run them, run
 pnpm run test
 ```
 
-To write new test cases write them in [packages/core/src/tests](/packages/core/src/tests)
+To write new test cases write them in [packages/llamaindex/tests](/packages/llamaindex/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
 
@@ -56,7 +56,7 @@ You can create new demo applications in the apps folder. Just run pnpm init in t
 To install packages for a specific package or demo application, run
 
 ```
-pnpm add [NPM Package] --filter [package or application i.e. core or docs]
+pnpm add [NPM Package] --filter [package or application i.e. llamaindex or docs]
 ```
 
 To install packages for every package or application run

README.md

@@ -194,19 +194,19 @@ Check out our NextJS playground at https://llama-playground.vercel.app/. The sou
 
 ## Core concepts for getting started:
 
-- [Document](/packages/core/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
+- [Document](/packages/llamaindex/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.
+- [Node](/packages/llamaindex/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
 
-- [Embedding](/packages/core/src/embeddings/OpenAIEmbedding.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. Because the default service context is OpenAI, the default embedding is `OpenAIEmbedding`. If using different models, say through Ollama, use this [Embedding](/packages/core/src/embeddings/OllamaEmbedding.ts) (see all [here](/packages/core/src/embeddings)).
+- [Embedding](/packages/llamaindex/src/embeddings/OpenAIEmbedding.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. Because the default service context is OpenAI, the default embedding is `OpenAIEmbedding`. If using different models, say through Ollama, use this [Embedding](/packages/llamaindex/src/embeddings/OllamaEmbedding.ts) (see all [here](/packages/llamaindex/src/embeddings)).
 
-- [Indices](/packages/core/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
+- [Indices](/packages/llamaindex/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/engines/query/RetrieverQueryEngine.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. To build a query engine from your Index (recommended), use the [`asQueryEngine`](/packages/core/src/indices/BaseIndex.ts) method on your Index. See all query engines [here](/packages/core/src/engines/query).
+- [QueryEngine](/packages/llamaindex/src/engines/query/RetrieverQueryEngine.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. To build a query engine from your Index (recommended), use the [`asQueryEngine`](/packages/llamaindex/src/indices/BaseIndex.ts) method on your Index. See all query engines [here](/packages/llamaindex/src/engines/query).
 
-- [ChatEngine](/packages/core/src/engines/chat/SimpleChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices. See all chat engines [here](/packages/core/src/engines/chat).
+- [ChatEngine](/packages/llamaindex/src/engines/chat/SimpleChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices. See all chat engines [here](/packages/llamaindex/src/engines/chat).
 
-- [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.
+- [SimplePrompt](/packages/llamaindex/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.
 
 ## Tips when using in non-Node.js environments
 

apps/docs/CHANGELOG.md

@@ -1,5 +1,88 @@
 # docs
 
+## 0.0.27
+
+### Patch Changes
+
+- Updated dependencies [3c47910]
+- Updated dependencies [ed467a9]
+- Updated dependencies [cba5406]
+  - llamaindex@0.4.1
+
+## 0.0.26
+
+### Patch Changes
+
+- b1a4a74: docs: updated Bedrock Opus region and added a basic README
+- Updated dependencies [436bc41]
+- Updated dependencies [a44e54f]
+- Updated dependencies [a51ed8d]
+- Updated dependencies [d3b635b]
+  - llamaindex@0.4.0
+  - @llamaindex/examples@0.0.5
+
+## 0.0.25
+
+### Patch Changes
+
+- Updated dependencies [6bc5bdd]
+- Updated dependencies [bf25ff6]
+- Updated dependencies [e6d6576]
+  - llamaindex@0.3.17
+
+## 0.0.24
+
+### Patch Changes
+
+- 631f000: feat: DeepInfra LLM implementation
+- 8832669: Community bedrock support added
+- a29d835: setDocumentHash should be async
+- Updated dependencies [11ae926]
+- Updated dependencies [631f000]
+- Updated dependencies [1378ec4]
+- Updated dependencies [6b1ded4]
+- Updated dependencies [4d4bd85]
+- Updated dependencies [24a9d1e]
+- Updated dependencies [45952de]
+- Updated dependencies [54230f0]
+- Updated dependencies [a29d835]
+- Updated dependencies [73819bf]
+  - llamaindex@0.3.16
+
+## 0.0.23
+
+### Patch Changes
+
+- Updated dependencies [6e156ed]
+- Updated dependencies [265976d]
+- Updated dependencies [8e26f75]
+  - llamaindex@0.3.15
+
+## 0.0.22
+
+### Patch Changes
+
+- Updated dependencies [6ff7576]
+- Updated dependencies [94543de]
+  - llamaindex@0.3.14
+
+## 0.0.21
+
+### Patch Changes
+
+- Updated dependencies [1b1081b]
+- Updated dependencies [37525df]
+- Updated dependencies [660a2b3]
+- Updated dependencies [a1f2475]
+  - llamaindex@0.3.13
+
+## 0.0.20
+
+### Patch Changes
+
+- Updated dependencies [34fb1d8]
+  - llamaindex@0.3.12
+
 ## 0.0.19
 
 ### Patch Changes

apps/docs/docs/examples/_category_.yml

@@ -1,2 +1,2 @@
 label: Examples
-position: 2
+position: 3

apps/docs/docs/examples/chat_engine.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 ---
 
 import CodeBlock from "@theme/CodeBlock";

apps/docs/docs/examples/local_llm.mdx

@@ -0,0 +1,77 @@
+# Local LLMs
+
+LlamaIndex.TS supports OpenAI and [other remote LLM APIs](other_llms). You can also run a local LLM on your machine!
+
+## Using a local model via Ollama
+
+The easiest way to run a local LLM is via the great work of our friends at [Ollama](https://ollama.com/), who provide a simple to use client that will download, install and run a [growing range of models](https://ollama.com/library) for you.
+
+### Install Ollama
+
+They provide a one-click installer for Mac, Linux and Windows on their [home page](https://ollama.com/).
+
+### Pick and run a model
+
+Since we're going to be doing agentic work, we'll need a very capable model, but the largest models are hard to run on a laptop. We think `mixtral 8x7b` is a good balance between power and resources, but `llama3` is another great option. You can run Mixtral by running
+
+```bash
+ollama run mixtral:8x7b
+```
+
+The first time you run it will also automatically download and install the model for you.
+
+### Switch the LLM in your code
+
+To tell LlamaIndex to use a local LLM, use the `Settings` object:
+
+```javascript
+Settings.llm = new Ollama({
+  model: "mixtral:8x7b",
+});
+```
+
+### Use local embeddings
+
+If you're doing retrieval-augmented generation, LlamaIndex.TS will also call out to OpenAI to index and embed your data. To be entirely local, you can use a local embedding model like this:
+
+```javascript
+Settings.embedModel = new HuggingFaceEmbedding({
+  modelType: "BAAI/bge-small-en-v1.5",
+  quantized: false,
+});
+```
+
+The first time this runs it will download the embedding model to run it.
+
+### Try it out
+
+With a local LLM and local embeddings in place, you can perform RAG as usual and everything will happen on your machine without calling an API:
+
+```typescript
+async function main() {
+  // Load essay from abramov.txt in Node
+  const path = "node_modules/llamaindex/examples/abramov.txt";
+
+  const essay = await fs.readFile(path, "utf-8");
+
+  // Create Document object with essay
+  const document = new Document({ text: essay, id_: path });
+
+  // Split text and create embeddings. Store them in a VectorStoreIndex
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // Query the index
+  const queryEngine = index.asQueryEngine();
+
+  const response = await queryEngine.query({
+    query: "What did the author do in college?",
+  });
+
+  // Output response
+  console.log(response.toString());
+}
+
+main().catch(console.error);
+```
+
+You can see the [full example file](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexLocal.ts).

apps/docs/docs/examples/more_examples.mdx

@@ -1,7 +1,23 @@
 ---
-sidebar_position: 5
+sidebar_position: 1
 ---
 
-# More examples
+# See all examples
 
-You can check out more examples in the [examples](https://github.com/run-llama/LlamaIndexTS/tree/main/examples) folder of the repository.
+Our GitHub repository has a wealth of examples to explore and try out. You can check out our [examples folder](https://github.com/run-llama/LlamaIndexTS/tree/main/examples) to see them all at once, or browse the pages in this section for some selected highlights.
+
+## Check out all examples
+
+It may be useful to check out all the examples at once so you can try them out locally. To do this into a folder called `my-new-project`, run these commands:
+
+```bash npm2yarn
+npx degit run-llama/LlamaIndexTS/examples my-new-project
+cd my-new-project
+npm install
+```
+
+Then you can run any example in the folder with `tsx`, e.g.:
+
+```bash npm2yarn
+npx tsx ./vectorIndex.ts
+```

apps/docs/docs/examples/other_llms.mdx

@@ -0,0 +1,41 @@
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../examples/mistral";
+
+# Using other LLM APIs
+
+By default LlamaIndex.TS uses OpenAI's LLMs and embedding models, but we support [lots of other LLMs](../modules/llms) including models from Mistral (Mistral, Mixtral), Anthropic (Claude) and Google (Gemini).
+
+If you don't want to use an API at all you can [run a local model](../../examples/local_llm)
+
+## Using another LLM
+
+You can specify what LLM LlamaIndex.TS will use on the `Settings` object, like this:
+
+```typescript
+import { MistralAI, Settings } from "llamaindex";
+
+Settings.llm = new MistralAI({
+  model: "mistral-tiny",
+  apiKey: "<YOUR_API_KEY>",
+});
+```
+
+You can see examples of other APIs we support by checking out "Available LLMs" in the sidebar of our [LLMs section](../modules/llms).
+
+## Using another embedding model
+
+A frequent gotcha when trying to use a different API as your LLM is that LlamaIndex will also by default index and embed your data using OpenAI's embeddings. To completely switch away from OpenAI you will need to set your embedding model as well, for example:
+
+```typescript
+import { MistralAIEmbedding, Settings } from "llamaindex";
+
+Settings.embedModel = new MistralAIEmbedding();
+```
+
+We support [many different embeddings](../modules/embeddings).
+
+## Full example
+
+This example uses Mistral's `mistral-tiny` model as the LLM and Mistral for embeddings as well.
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>

apps/docs/docs/getting_started/concepts.md

@@ -32,7 +32,7 @@ LlamaIndex.TS help you prepare the knowledge base with a suite of data connector
 
 ![](../_static/concepts/indexing.jpg)
 
-[**Data Loaders**](../modules/data_loader.md):
+[**Data Loaders**](../modules/data_loaders/index.mdx):
 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/documents_and_nodes/index.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.

apps/docs/docs/getting_started/environments.md

@@ -4,7 +4,7 @@ sidebar_position: 2
 
 # Environments
 
-LlamaIndex currently officially supports NodeJS 18 and NodeJS 20.
+We support Node.JS versions 18, 20 and 22, with experimental support for Deno, Bun and Vercel Edge functions.
 
 ## NextJS App Router
 

apps/docs/docs/getting_started/installation.mdx

@@ -4,45 +4,7 @@ sidebar_position: 0
 
 # Installation and Setup
 
-Make sure you have NodeJS v18 or higher.
-
-## Using create-llama
-
-The easiest way to get started with LlamaIndex is by using `create-llama`. This CLI tool enables you to quickly start building a new LlamaIndex application, with everything set up for you.
-
-Just run
-
-<Tabs>
-<TabItem value="1" label="npm" default>
-
-```bash
-npx create-llama@latest
-```
-
-</TabItem>
-<TabItem value="2" label="Yarn">
-
-```bash
-yarn create llama
-```
-
-</TabItem>
-<TabItem value="3" label="pnpm">
-
-```bash
-pnpm create llama@latest
-```
-
-</TabItem>
-</Tabs>
-
-to get started. Once your app is generated, run
-
-```bash npm2yarn
-npm run dev
-```
-
-to start the development server. You can then visit [http://localhost:3000](http://localhost:3000) to see your app
+We support Node.JS versions 18, 20 and 22, with experimental support for Deno, Bun and Vercel Edge functions.
 
 ## Installation from NPM
 
@@ -52,12 +14,21 @@ npm install llamaindex
 
 ### Environment variables
 
-Our examples use OpenAI by default. You'll need to set up your Open AI key like so:
+Our examples use OpenAI by default. You can use [other LLMs](../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../examples/local_llm).
+
+To use OpenAI, you'll need to [get an OpenAI API key](https://platform.openai.com/account/api-keys) and then make it available as an environment variable this way:
 
 ```bash
-export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
+export OPENAI_API_KEY="sk-......" # Replace with your key
 ```
 
 If you want to have it automatically loaded every time, add it to your `.zshrc/.bashrc`.
 
-WARNING: do not check in your OpenAI key into version control.
+**WARNING:** do not check in your OpenAI key into version control. GitHub automatically invalidates OpenAI keys checked in by accident.
+
+## What next?
+
+- The easiest way to started is to [build a full-stack chat app with `create-llama`](starter_tutorial/chatbot).
+- Try our other [getting started tutorials](starter_tutorial/retrieval_augmented_generation)
+- Learn more about the [high level concepts](concepts) behind how LlamaIndex works
+- Check out our [many examples](../examples/more_examples) of LlamaIndex.TS in action

apps/docs/docs/getting_started/starter.mdx

@@ -1,51 +0,0 @@
----
-sidebar_position: 1
----
-
-import CodeBlock from "@theme/CodeBlock";
-import CodeSource from "!raw-loader!../../../../examples/vectorIndex";
-import TSConfigSource from "!!raw-loader!../../../../examples/tsconfig.json";
-
-# Starter Tutorial
-
-Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](installation) guide.
-
-## From scratch(node.js + TypeScript):
-
-In a new folder:
-
-```bash npm2yarn
-npm init
-npm install -D typescript @types/node
-```
-
-Create the file `example.ts`. This code will load some example data, create a document, index it (which creates embeddings using OpenAI), and then creates query engine to answer questions about the data.
-
-<CodeBlock language="ts">{CodeSource}</CodeBlock>
-
-Create a `tsconfig.json` file in the same folder:
-
-<CodeBlock language="json">{TSConfigSource}</CodeBlock>
-
-Now you can run the code with
-
-```bash
-npx tsx example.ts
-```
-
-Also, you can clone our examples and try them out:
-
-```bash npm2yarn
-npx degit run-llama/LlamaIndexTS/examples my-new-project
-cd my-new-project
-npm install
-npx tsx ./vectorIndex.ts
-```
-
-## From scratch (Next.js + TypeScript):
-
-You just need one command to create a new Next.js project:
-
-```bash npm2yarn
-npx create-llama@latest
-```

apps/docs/docs/getting_started/starter_tutorial/_category_.yml

@@ -0,0 +1,2 @@
+label: Starter Tutorials
+position: 1

apps/docs/docs/getting_started/starter_tutorial/agent.mdx

@@ -0,0 +1,49 @@
+---
+sidebar_position: 4
+---
+
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../examples/agent/openai";
+
+# Agent tutorial
+
+We have a comprehensive, step-by-step [guide to building agents in LlamaIndex.TS](../../guides/agents/setup) that we recommend to learn what agents are and how to build them for production. But building a basic agent is simple:
+
+## Set up
+
+In a new folder:
+
+```bash npm2yarn
+npm init
+npm install -D typescript @types/node
+```
+
+## Run agent
+
+Create the file `example.ts`. This code will:
+
+- Create two tools for use by the agent:
+  - A `sumNumbers` tool that adds two numbers
+  - A `divideNumbers` tool that divides numbers
+-
+- Give an example of the data structure we wish to generate
+- Prompt the LLM with instructions and the example, plus a sample transcript
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+To run the code:
+
+```bash
+npx tsx example.ts
+```
+
+You should expect output something like:
+
+```
+{
+  content: 'The sum of 5 + 5 is 10. When you divide 10 by 2, you get 5.',
+  role: 'assistant',
+  options: {}
+}
+Done
+```

apps/docs/docs/getting_started/starter_tutorial/chatbot.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 2
+---
+
+# Chatbot tutorial
+
+Once you've mastered basic [retrieval-augment generation](retrieval_augmented_generation) you may want to create an interface to chat with your data. You can do this step-by-step, but we recommend getting started quickly using `create-llama`.
+
+## Using create-llama
+
+`create-llama` is a powerful but easy to use command-line tool that generates a working, full-stack web application that allows you to chat with your data. You can learn more about it on [the `create-llama` README page](https://www.npmjs.com/package/create-llama).
+
+Run it once and it will ask you a series of questions about the kind of application you want to generate. Then you can customize your application to suit your use-case. To get started, run:
+
+```bash npm2yarn
+npx create-llama@latest
+```
+
+Once your app is generated, `cd` into your app directory and run
+
+```bash npm2yarn
+npm run dev
+```
+
+to start the development server. You can then visit [http://localhost:3000](http://localhost:3000) to see your app, which should look something like this:
+
+![create-llama interface](./images/create_llama.png)

apps/docs/docs/getting_started/starter_tutorial/retrieval_augmented_generation.mdx

@@ -0,0 +1,58 @@
+---
+sidebar_position: 1
+---
+
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../examples/vectorIndex";
+import TSConfigSource from "!!raw-loader!../../../../../examples/tsconfig.json";
+
+# Retrieval Augmented Generation (RAG) Tutorial
+
+One of the most common use-cases for LlamaIndex is Retrieval-Augmented Generation or RAG, in which your data is indexed and selectively retrieved to be given to an LLM as source material for responding to a query. You can learn more about the [concepts behind RAG](../concepts).
+
+## Set up the project
+
+In a new folder, run:
+
+```bash npm2yarn
+npm init
+npm install -D typescript @types/node
+```
+
+Then, check out the [installation](../installation) steps to install LlamaIndex.TS and prepare an OpenAI key.
+
+You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm).
+
+## Run queries
+
+Create the file `example.ts`. This code will
+
+- load an example file
+- convert it into a Document object
+- index it (which creates embeddings using OpenAI)
+- create a query engine to answer questions about the data
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+Create a `tsconfig.json` file in the same folder:
+
+<CodeBlock language="json">{TSConfigSource}</CodeBlock>
+
+Now you can run the code with
+
+```bash
+npx tsx example.ts
+```
+
+You should expect output something like:
+
+```
+In college, the author studied subjects like linear algebra and physics, but did not find them particularly interesting. They started slacking off, skipping lectures, and eventually stopped attending classes altogether. They also had a negative experience with their English classes, where they were required to pay for catch-up training despite getting verbal approval to skip most of the classes. Ultimately, the author lost motivation for college due to their job as a software developer and stopped attending classes, only returning years later to pick up their papers.
+
+0: Score: 0.8305309270895813 - I started this decade as a first-year college stud...
+
+
+1: Score: 0.8286388215713089 - A short digression. I’m not saying colleges are wo...
+```
+
+Once you've mastered basic RAG, you may want to consider [chatting with your data](chatbot).

apps/docs/docs/getting_started/starter_tutorial/structured_data_extraction.mdx

@@ -0,0 +1,52 @@
+---
+sidebar_position: 3
+---
+
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../examples/jsonExtract";
+
+# Structured data extraction tutorial
+
+Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](../installation) guide.
+
+You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm).
+
+## Set up
+
+In a new folder:
+
+```bash npm2yarn
+npm init
+npm install -D typescript @types/node
+```
+
+## Extract data
+
+Create the file `example.ts`. This code will:
+
+- Set up an LLM connection to GPT-4
+- Give an example of the data structure we wish to generate
+- Prompt the LLM with instructions and the example, plus a sample transcript
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+To run the code:
+
+```bash
+npx tsx example.ts
+```
+
+You should expect output something like:
+
+```json
+{
+  "summary": "Sarah from XYZ Company called John to introduce the XYZ Widget, a tool designed to automate tasks and improve productivity. John expressed interest and requested case studies and a product demo. Sarah agreed to send the information and follow up to schedule the demo.",
+  "products": ["XYZ Widget"],
+  "rep_name": "Sarah",
+  "prospect_name": "John",
+  "action_items": [
+    "Send case studies and additional product information to John",
+    "Follow up with John to schedule a product demo"
+  ]
+}
+```

apps/docs/docs/guides/_category_.yml

@@ -0,0 +1,2 @@
+label: Guides
+position: 2

apps/docs/docs/guides/agents/1_setup.mdx

@@ -0,0 +1,41 @@
+---
+sidebar_position: 1
+---
+
+# Getting started
+
+In this guide we'll walk you through the process of building an Agent in JavaScript using the LlamaIndex.TS library, starting from nothing and adding complexity in stages.
+
+## What is an Agent?
+
+In LlamaIndex, an agent is a semi-autonomous piece of software powered by an LLM that is given a task and executes a series of steps towards solving that task. It is given a set of tools, which can be anything from arbitrary functions up to full LlamaIndex query engines, and it selects the best available tool to complete each step. When each step is completed, the agent judges whether the task is now complete, in which case it returns a result to the user, or whether it needs to take another step, in which case it loops back to the start.
+
+![agent flow](./images/agent_flow.png)
+
+## Install LlamaIndex.TS
+
+You'll need to have a recent version of [Node.js](https://nodejs.org/en) installed. Then you can install LlamaIndex.TS by running
+
+```bash
+npm install llamaindex
+```
+
+## Choose your model
+
+By default we'll be using OpenAI with GPT-4, as it's a powerful model and easy to get started with. If you'd prefer to run a local model, see [using a local model](local_model).
+
+## Get an OpenAI API key
+
+If you don't already have one, you can sign up for an [OpenAI API key](https://platform.openai.com/api-keys). You should then put the key in a `.env` file in the root of the project; the file should look like
+
+```
+OPENAI_API_KEY=sk-XXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+We'll use `dotenv` to pull the API key out of that .env file, so also run:
+
+```bash
+npm install dotenv
+```
+
+Now you're ready to [create your agent](create_agent).

apps/docs/docs/guides/agents/2_create_agent.mdx

@@ -0,0 +1,179 @@
+# Create a basic agent
+
+We want to use `await` so we're going to wrap all of our code in a `main` function, like this:
+
+```typescript
+// Your imports go here
+
+async function main() {
+  // the rest of your code goes here
+}
+
+main().catch(console.error);
+```
+
+For the rest of this guide we'll assume your code is wrapped like this so we can use `await`. You can run the code this way:
+
+```bash
+npx tsx example.ts
+```
+
+### Load your dependencies
+
+First we'll need to pull in our dependencies. These are:
+
+- The OpenAI class to use the OpenAI LLM
+- FunctionTool to provide tools to our agent
+- OpenAIAgent to create the agent itself
+- Settings to define some global settings for the library
+- Dotenv to load our API key from the .env file
+
+```javascript
+import { OpenAI, FunctionTool, OpenAIAgent, Settings } from "llamaindex";
+import "dotenv/config";
+```
+
+### Initialize your LLM
+
+We need to tell our OpenAI class where its API key is, and which of OpenAI's models to use. We'll be using `gpt-4o`, which is capable while still being pretty cheap. This is a global setting, so anywhere an LLM is needed will use the same model.
+
+```javascript
+Settings.llm = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4o",
+});
+```
+
+### Turn on logging
+
+We want to see what our agent is up to, so we're going to hook into some events that the library generates and print them out. There are several events possible, but we'll specifically tune in to `llm-tool-call` (when a tool is called) and `llm-tool-result` (when it responds).
+
+```javascript
+Settings.callbackManager.on("llm-tool-call", (event) => {
+  console.log(event.detail.payload);
+});
+Settings.callbackManager.on("llm-tool-result", (event) => {
+  console.log(event.detail.payload);
+});
+```
+
+### Create a function
+
+We're going to create a very simple function that adds two numbers together. This will be the tool we ask our agent to use.
+
+```javascript
+const sumNumbers = ({ a, b }) => {
+  return `${a + b}`;
+};
+```
+
+Note that we're passing in an object with two named parameters, `a` and `b`. This is a little unusual, but important for defining a tool that an LLM can use.
+
+### Turn the function into a tool for the agent
+
+This is the most complicated part of creating an agent. We need to define a `FunctionTool`. We have to pass in:
+
+- The function itself (`sumNumbers`)
+- A name for the function, which the LLM will use to call it
+- A description of the function. The LLM will read this description to figure out what the tool does, and if it needs to call it
+- A schema for function. We tell the LLM that the parameter is an `object`, and we tell it about the two named parameters we gave it, `a` and `b`. We describe each parameter as a `number`, and we say that both are required.
+- You can see [more examples of function schemas](https://cookbook.openai.com/examples/how_to_call_functions_with_chat_models).
+
+```javascript
+const tool = FunctionTool.from(sumNumbers, {
+  name: "sumNumbers",
+  description: "Use this function to sum two numbers",
+  parameters: {
+    type: "object",
+    properties: {
+      a: {
+        type: "number",
+        description: "First number to sum",
+      },
+      b: {
+        type: "number",
+        description: "Second number to sum",
+      },
+    },
+    required: ["a", "b"],
+  },
+});
+```
+
+We then wrap up the tools into an array. We could provide lots of tools this way, but for this example we're just using the one.
+
+```javascript
+const tools = [tool];
+```
+
+### Create the agent
+
+With your LLM already set up and your tools defined, creating an agent is simple:
+
+```javascript
+const agent = new OpenAIAgent({ tools });
+```
+
+### Ask the agent a question
+
+We can use the `chat` interface to ask our agent a question, and it will use the tools we've defined to find an answer.
+
+```javascript
+let response = await agent.chat({
+  message: "Add 101 and 303",
+});
+
+console.log(response);
+```
+
+Let's see what running this looks like using `npx tsx agent.ts`
+
+**_Output_**
+
+```javascript
+{
+  toolCall: {
+    id: 'call_ze6A8C3mOUBG4zmXO8Z4CPB5',
+    name: 'sumNumbers',
+    input: { a: 101, b: 303 }
+  },
+  toolResult: {
+    tool: FunctionTool { _fn: [Function: sumNumbers], _metadata: [Object] },
+    input: { a: 101, b: 303 },
+    output: '404',
+    isError: false
+  }
+}
+```
+
+```javascript
+{
+  response: {
+    raw: {
+      id: 'chatcmpl-9KwauZku3QOvH78MNvxJs81mDvQYK',
+      object: 'chat.completion',
+      created: 1714778824,
+      model: 'gpt-4-turbo-2024-04-09',
+      choices: [Array],
+      usage: [Object],
+      system_fingerprint: 'fp_ea6eb70039'
+    },
+    message: {
+      content: 'The sum of 101 and 303 is 404.',
+      role: 'assistant',
+      options: {}
+    }
+  },
+  sources: [Getter]
+}
+```
+
+We're seeing two pieces of output here. The first is our callback firing when the tool is called. You can see in `toolResult` that the LLM has correctly passed `101` and `303` to our `sumNumbers` function, which adds them up and returns `404`.
+
+The second piece of output is the response from the LLM itself, where the `message.content` key is giving us the answer.
+
+Great! We've built an agent with tool use! Next you can:
+
+- [See the full code](https://github.com/run-llama/ts-agents/blob/main/1_agent/agent.ts)
+- [Switch to a local LLM](local_model)
+- Move on to [add Retrieval-Augmented Generation to your agent](agentic_rag)

apps/docs/docs/guides/agents/3_local_model.mdx

@@ -0,0 +1,90 @@
+# Using a local model via Ollama
+
+If you're happy using OpenAI, you can skip this section, but many people are interested in using models they run themselves. The easiest way to do this is via the great work of our friends at [Ollama](https://ollama.com/), who provide a simple to use client that will download, install and run a [growing range of models](https://ollama.com/library) for you.
+
+### Install Ollama
+
+They provide a one-click installer for Mac, Linux and Windows on their [home page](https://ollama.com/).
+
+### Pick and run a model
+
+Since we're going to be doing agentic work, we'll need a very capable model, but the largest models are hard to run on a laptop. We think `mixtral 8x7b` is a good balance between power and resources, but `llama3` is another great option. You can run it simply by running
+
+```bash
+ollama run mixtral:8x7b
+```
+
+The first time you run it will also automatically download and install the model for you.
+
+### Switch the LLM in your code
+
+There are two changes you need to make to the code we already wrote in `1_agent` to get Mixtral 8x7b to work. First, you need to switch to that model. Replace the call to `Settings.llm` with this:
+
+```javascript
+Settings.llm = new Ollama({
+  model: "mixtral:8x7b",
+});
+```
+
+### Swap to a ReActAgent
+
+In our original code we used a specific OpenAIAgent, so we'll need to switch to a more generic agent pattern, the ReAct pattern. This is simple: change the `const agent` line in your code to read
+
+```javascript
+const agent = new ReActAgent({ tools });
+```
+
+(You will also need to bring in `Ollama` and `ReActAgent` in your imports)
+
+### Run your totally local agent
+
+Because your embeddings were already local, your agent can now run entirely locally without making any API calls.
+
+```bash
+node agent.mjs
+```
+
+Note that your model will probably run a lot slower than OpenAI, so be prepared to wait a while!
+
+**_Output_**
+
+```javascript
+{
+  response: {
+    message: {
+      role: 'assistant',
+      content: ' Thought: I need to use a tool to add the numbers 101 and 303.\n' +
+        'Action: sumNumbers\n' +
+        'Action Input: {"a": 101, "b": 303}\n' +
+        '\n' +
+        'Observation: 404\n' +
+        '\n' +
+        'Thought: I can answer without using any more tools.\n' +
+        'Answer: The sum of 101 and 303 is 404.'
+    },
+    raw: {
+      model: 'mixtral:8x7b',
+      created_at: '2024-05-09T00:24:30.339473Z',
+      message: [Object],
+      done: true,
+      total_duration: 64678371209,
+      load_duration: 57394551334,
+      prompt_eval_count: 475,
+      prompt_eval_duration: 4163981000,
+      eval_count: 94,
+      eval_duration: 3116692000
+    }
+  },
+  sources: [Getter]
+}
+```
+
+Tada! You can see all of this in the folder `1a_mixtral`.
+
+### Extending to other examples
+
+You can use a ReActAgent instead of an OpenAIAgent in any of the further examples below, but keep in mind that GPT-4 is a lot more capable than Mixtral 8x7b, so you may see more errors or failures in reasoning if you are using an entirely local setup.
+
+### Next steps
+
+Now you've got a local agent, you can [add Retrieval-Augmented Generation to your agent](agentic_rag).

apps/docs/docs/guides/agents/4_agentic_rag.mdx

@@ -0,0 +1,165 @@
+# Adding Retrieval-Augmented Generation (RAG)
+
+While an agent that can perform math is nifty (LLMs are usually not very good at math), LLM-based applications are always more interesting when they work with large amounts of data. In this case, we're going to use a 200-page PDF of the proposed budget of the city of San Francisco for fiscal years 2024-2024 and 2024-2025. It's a great example because it's extremely wordy and full of tables of figures, which present a challenge for humans and LLMs alike.
+
+To learn more about RAG, we recommend this [introduction](https://docs.llamaindex.ai/en/stable/getting_started/concepts/) from our Python docs. We'll assume you know the basics:
+
+- You need to parse your source data into chunks of text
+- You need to encode that text as numbers, called embeddings
+- You need to search your embeddings for the most relevant chunks of text
+- You feed your relevant chunks and a query to an LLM to answer a question
+
+We're going to start with the same agent we [built in step 1](https://github.com/run-llama/ts-agents/blob/main/1_agent/agent.ts), but make a few changes. You can find the finished version [in the repository](https://github.com/run-llama/ts-agents/blob/main/2_agentic_rag/agent.ts).
+
+### New dependencies
+
+We'll be bringing in `SimpleDirectoryReader`, `HuggingFaceEmbedding`, `VectorStoreIndex`, and `QueryEngineTool` from LlamaIndex.TS, as well as the dependencies we previously used.
+
+```javascript
+import {
+  OpenAI,
+  FunctionTool,
+  OpenAIAgent,
+  Settings,
+  SimpleDirectoryReader,
+  HuggingFaceEmbedding,
+  VectorStoreIndex,
+  QueryEngineTool,
+} from "llamaindex";
+```
+
+### Add an embedding model
+
+To encode our text into embeddings, we'll need an embedding model. We could use OpenAI for this but to save on API calls we're going to use a local embedding model from HuggingFace.
+
+```javascript
+Settings.embedModel = new HuggingFaceEmbedding({
+  modelType: "BAAI/bge-small-en-v1.5",
+  quantized: false,
+});
+```
+
+### Load data using SimpleDirectoryReader
+
+SimpleDirectoryReader is a flexible tool that can read a variety of file formats. We're going to point it at our data directory, which contains just the single PDF file, and get it to return a set of documents.
+
+```javascript
+const reader = new SimpleDirectoryReader();
+const documents = await reader.loadData("../data");
+```
+
+### Index our data
+
+Now we turn our text into embeddings. The `VectorStoreIndex` class takes care of this for us when we use the `fromDocuments` method (it uses the embedding model we defined in `Settings` earlier).
+
+```javascript
+const index = await VectorStoreIndex.fromDocuments(documents);
+```
+
+### Configure a retriever
+
+Before LlamaIndex can send a query to the LLM, it needs to find the most relevant chunks to send. That's the purpose of a `Retriever`. We're going to get `VectorStoreIndex` to act as a retriever for us
+
+```javascript
+const retriever = await index.asRetriever();
+```
+
+### Configure how many documents to retrieve
+
+By default LlamaIndex will retrieve just the 2 most relevant chunks of text. This document is complex though, so we'll ask for more context.
+
+```javascript
+retriever.similarityTopK = 10;
+```
+
+### Create a query engine
+
+And our final step in creating a RAG pipeline is to create a query engine that will use the retriever to find the most relevant chunks of text, and then use the LLM to answer the question.
+
+```javascript
+const queryEngine = await index.asQueryEngine({
+  retriever,
+});
+```
+
+### Define the query engine as a tool
+
+Just as before we created a `FunctionTool`, we're going to create a `QueryEngineTool` that uses our `queryEngine`.
+
+```javascript
+const tools = [
+  new QueryEngineTool({
+    queryEngine: queryEngine,
+    metadata: {
+      name: "san_francisco_budget_tool",
+      description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`,
+    },
+  }),
+];
+```
+
+As before, we've created an array of tools with just one tool in it. The metadata is slightly different: we don't need to define our parameters, we just give the tool a name and a natural-language description.
+
+### Create the agent as before
+
+Creating the agent and asking a question is exactly the same as before, but we'll ask a different question.
+
+```javascript
+// create the agent
+const agent = new OpenAIAgent({ tools });
+
+let response = await agent.chat({
+  message: "What's the budget of San Francisco in 2023-2024?",
+});
+
+console.log(response);
+```
+
+Once again we'll run `npx tsx agent.ts` and see what we get:
+
+**_Output_**
+
+```javascript
+{
+  toolCall: {
+    id: 'call_iNo6rTK4pOpOBbO8FanfWLI9',
+    name: 'san_francisco_budget_tool',
+    input: { query: 'total budget' }
+  },
+  toolResult: {
+    tool: QueryEngineTool {
+      queryEngine: [RetrieverQueryEngine],
+      metadata: [Object]
+    },
+    input: { query: 'total budget' },
+    output: 'The total budget for the City and County of San Francisco for Fiscal Year (FY) 2023-24 is $14.6 billion, which represents a $611.8 million, or 4.4 percent, increase over the FY 2022-23 budget. For FY 2024-25, the total budget is also projected to be $14.6 billion, reflecting a $40.5 million, or 0.3 percent, decrease from the FY 2023-24 proposed budget. This budget includes various expenditures across different departments and services, with significant allocations to public works, transportation, commerce, public protection, and health services.',
+    isError: false
+  }
+}
+```
+
+```javascript
+{
+  response: {
+    raw: {
+      id: 'chatcmpl-9KxUkwizVCYCmxwFQcZFSHrInzNFU',
+      object: 'chat.completion',
+      created: 1714782286,
+      model: 'gpt-4-turbo-2024-04-09',
+      choices: [Array],
+      usage: [Object],
+      system_fingerprint: 'fp_ea6eb70039'
+    },
+    message: {
+      content: "The total budget for the City and County of San Francisco for the fiscal year 2023-2024 is $14.6 billion. This represents a $611.8 million, or 4.4 percent, increase over the previous fiscal year's budget. The budget covers various expenditures across different departments and services, including significant allocations to public works, transportation, commerce, public protection, and health services.",
+      role: 'assistant',
+      options: {}
+    }
+  },
+  sources: [Getter]
+}
+```
+
+Once again we see a `toolResult`. You can see the query the LLM decided to send to the query engine ("total budget"), and the output the engine returned. In `response.message` you see that the LLM has returned the output from the tool almost verbatim, although it trimmed out the bit about 2024-2025 since we didn't ask about that year.
+
+So now we have an agent that can index complicated documents and answer questions about them. Let's [combine our math agent and our RAG agent](rag_and_tools)!

apps/docs/docs/guides/agents/5_rag_and_tools.mdx

@@ -0,0 +1,128 @@
+# A RAG agent that does math
+
+In [our third iteration of the agent](https://github.com/run-llama/ts-agents/blob/main/3_rag_and_tools/agent.ts) we've combined the two previous agents, so we've defined both `sumNumbers` and a `QueryEngineTool` and created an array of two tools:
+
+```javascript
+// define the query engine as a tool
+const tools = [
+  new QueryEngineTool({
+    queryEngine: queryEngine,
+    metadata: {
+      name: "san_francisco_budget_tool",
+      description: `This tool can answer detailed questions about the individual components of the budget of San Francisco in 2023-2024.`,
+    },
+  }),
+  FunctionTool.from(sumNumbers, {
+    name: "sumNumbers",
+    description: "Use this function to sum two numbers",
+    parameters: {
+      type: "object",
+      properties: {
+        a: {
+          type: "number",
+          description: "First number to sum",
+        },
+        b: {
+          type: "number",
+          description: "Second number to sum",
+        },
+      },
+      required: ["a", "b"],
+    },
+  }),
+];
+```
+
+These tool descriptions are identical to the ones we previously defined. Now let's ask it 3 questions in a row:
+
+```javascript
+let response = await agent.chat({
+  message:
+    "What's the budget of San Francisco for community health in 2023-24?",
+});
+console.log(response);
+
+let response2 = await agent.chat({
+  message:
+    "What's the budget of San Francisco for public protection in 2023-24?",
+});
+console.log(response2);
+
+let response3 = await agent.chat({
+  message:
+    "What's the combined budget of San Francisco for community health and public protection in 2023-24?",
+});
+console.log(response3);
+```
+
+We'll abbreviate the output, but here are the important things to spot:
+
+```javascript
+{
+  toolCall: {
+    id: 'call_ZA1LPx03gO4ABre1r6XowLWq',
+    name: 'san_francisco_budget_tool',
+    input: { query: 'community health budget 2023-2024' }
+  },
+  toolResult: {
+    tool: QueryEngineTool {
+      queryEngine: [RetrieverQueryEngine],
+      metadata: [Object]
+    },
+    input: { query: 'community health budget 2023-2024' },
+    output: 'The proposed Fiscal Year (FY) 2023-24 budget for the Department of Public Health is $3.2 billion
+  }
+}
+```
+
+This is the first tool call, where it used the query engine to get the public health budget.
+
+```javascript
+{
+  toolCall: {
+    id: 'call_oHu1KjEvA47ER6HYVfFIq9yp',
+    name: 'san_francisco_budget_tool',
+    input: { query: 'public protection budget 2023-2024' }
+  },
+  toolResult: {
+    tool: QueryEngineTool {
+      queryEngine: [RetrieverQueryEngine],
+      metadata: [Object]
+    },
+    input: { query: 'public protection budget 2023-2024' },
+    output: "The budget for Public Protection in San Francisco for Fiscal Year (FY) 2023-24 is $2,012.5 million."
+  }
+}
+```
+
+In the second tool call, it got the police budget also from the query engine.
+
+```javascript
+{
+  toolCall: {
+    id: 'call_SzG4yGUnLbv1T7IyaLAOqg3t',
+    name: 'sumNumbers',
+    input: { a: 3200, b: 2012.5 }
+  },
+  toolResult: {
+    tool: FunctionTool { _fn: [Function: sumNumbers], _metadata: [Object] },
+    input: { a: 3200, b: 2012.5 },
+    output: '5212.5',
+    isError: false
+  }
+}
+```
+
+In the final tool call, it used the `sumNumbers` function to add the two budgets together. Perfect! This leads to the final answer:
+
+```javascript
+{
+    message: {
+      content: 'The combined budget of San Francisco for community health and public protection in Fiscal Year (FY) 2023-24 is $5,212.5 million.',
+      role: 'assistant',
+      options: {}
+    }
+}
+```
+
+Great! Now let's improve accuracy by improving our parsing with [LlamaParse](llamaparse).

apps/docs/docs/guides/agents/6_llamaparse.mdx

@@ -0,0 +1,18 @@
+# Adding LlamaParse
+
+Complicated PDFs can be very tricky for LLMs to understand. To help with this, LlamaIndex provides LlamaParse, a hosted service that parses complex documents including PDFs. To use it, get a `LLAMA_CLOUD_API_KEY` by [signing up for LlamaCloud](https://cloud.llamaindex.ai/) (it's free for up to 1000 pages/day) and adding it to your `.env` file just as you did for your OpenAI key:
+
+```bash
+LLAMA_CLOUD_API_KEY=llx-XXXXXXXXXXXXXXXX
+```
+
+Then replace `SimpleDirectoryReader` with `LlamaParseReader`:
+
+```javascript
+const reader = new LlamaParseReader({ resultType: "markdown" });
+const documents = await reader.loadData("../data/sf_budget_2023_2024.pdf");
+```
+
+Now you will be able to ask more complicated questions of the same PDF and get better results. You can find this code [in our repo](https://github.com/run-llama/ts-agents/blob/main/4_llamaparse/agent.ts).
+
+Next up, let's persist our embedded data so we don't have to re-parse every time by [using a vector store](qdrant).

apps/docs/docs/guides/agents/7_qdrant.mdx

@@ -0,0 +1,75 @@
+# Adding persistent vector storage
+
+In the previous examples, we've been loading our data into memory each time we run the agent. This is fine for small datasets, but for larger datasets you'll want to store your embeddings in a database. LlamaIndex.TS provides a `VectorStore` class that can store your embeddings in a variety of databases. We're going to use [Qdrant](https://qdrant.tech/), a popular vector store, for this example.
+
+We can get a local instance of Qdrant running very simply with Docker (make sure you [install Docker](https://www.docker.com/products/docker-desktop/) first):
+
+```bash
+docker pull qdrant/qdrant
+docker run -p 6333:6333 qdrant/qdrant
+```
+
+And in our code we initialize a `VectorStore` with the Qdrant URL:
+
+```javascript
+// initialize qdrant vector store
+const vectorStore = new QdrantVectorStore({
+  url: "http://localhost:6333",
+});
+```
+
+Now once we have loaded our documents, we can instantiate an index with the vector store:
+
+```javascript
+// create a query engine from our documents
+const index = await VectorStoreIndex.fromDocuments(documents, { vectorStore });
+```
+
+In [the final iteration](https://github.com/run-llama/ts-agents/blob/main/5_qdrant/agent.ts) you can see that we have also implemented a very naive caching mechanism to avoid re-parsing the PDF each time we run the agent:
+
+```javascript
+// load cache.json and parse it
+let cache = {};
+let cacheExists = false;
+try {
+  await fs.access(PARSING_CACHE, fs.constants.F_OK);
+  cacheExists = true;
+} catch (e) {
+  console.log("No cache found");
+}
+if (cacheExists) {
+  cache = JSON.parse(await fs.readFile(PARSING_CACHE, "utf-8"));
+}
+
+const filesToParse = ["../data/sf_budget_2023_2024.pdf"];
+
+// load our data, reading only files we haven't seen before
+let documents = [];
+const reader = new LlamaParseReader({ resultType: "markdown" });
+for (let file of filesToParse) {
+  if (!cache[file]) {
+    documents = documents.concat(await reader.loadData(file));
+    cache[file] = true;
+  }
+}
+
+// write the cache back to disk
+await fs.writeFile(PARSING_CACHE, JSON.stringify(cache));
+```
+
+Since parsing a PDF can be slow, especially a large one, using the pre-parsed chunks in Qdrant can significantly speed up your agent.
+
+## Next steps
+
+In this guide you've learned how to
+
+- [Create an agent](create_agent)
+- Use remote LLMs like GPT-4
+- [Use local LLMs like Mixtral](local_model)
+- [Create a RAG query engine](agentic_rag)
+- [Turn functions and query engines into agent tools](rag_and_tools)
+- Combine those tools
+- [Enhance your parsing with LlamaParse](llamaparse)
+- Persist your data in a vector store
+
+The next steps are up to you! Try creating more complex functions and query engines, and set your agent loose on the world.

apps/docs/docs/guides/agents/_category_.yml

@@ -0,0 +1,2 @@
+label: Agents
+position: 1

apps/docs/docs/introduction.md

@@ -3,33 +3,31 @@ sidebar_position: 0
 slug: /
 ---
 
-# What is LlamaIndex.TS?
+# What is LlamaIndex?
 
-LlamaIndex.TS is a data framework for LLM applications to ingest, structure, and access private or domain-specific data. While a python package is also available (see [here](https://docs.llamaindex.ai/en/stable/)), LlamaIndex.TS offers core features in a simple package, optimized for usage with TypeScript.
+LlamaIndex is a framework for building LLM-powered applications. LlamaIndex helps you ingest, structure, and access private or domain-specific data. It's available [as a Python package](https://docs.llamaindex.ai/en/stable/) and in TypeScript (this package). LlamaIndex.TS offers the core features of LlamaIndex for popular runtimes like Node.js (official support), Vercel Edge Functions (experimental), and Deno (experimental).
 
 ## 🚀 Why LlamaIndex.TS?
 
-At their core, LLMs offer a natural language interface between humans and inferred data. Widely available models come pre-trained on huge amounts of publicly available data, from Wikipedia and mailing lists to textbooks and source code.
+LLMs offer a natural language interface between humans and inferred data. Widely available models come pre-trained on huge amounts of publicly available data, from Wikipedia and mailing lists to textbooks and source code.
 
-Applications built on top of LLMs often require augmenting these models with private or domain-specific data. Unfortunately, that data can be distributed across siloed applications and data stores. It's behind APIs, in SQL databases, or trapped in PDFs and slide decks.
+Applications built on top of LLMs often require augmenting these models with private or domain-specific data. That data is often distributed across siloed applications and data stores. It's behind APIs, in SQL databases, or trapped in PDFs and slide decks.
 
-That's where **LlamaIndex.TS** comes in.
+LlamaIndex.TS helps you unlock that data and then build powerful applications with it.
 
-## 🦙 How can LlamaIndex.TS help?
+## 🦙 What is LlamaIndex for?
 
-LlamaIndex.TS provides the following tools:
+LlamaIndex.TS handles several major use cases:
 
-- **Data loading** ingest your existing `.txt`, `.pdf`, `.csv`, `.md` and `.docx` data directly
-- **Data indexes** structure your data in intermediate representations that are easy and performant for LLMs to consume.
-- **Engines** provide natural language access to your data. For example:
-  - Query engines are powerful retrieval interfaces for knowledge-augmented output.
-  - Chat engines are conversational interfaces for multi-message, "back and forth" interactions with your data.
+- **Structured Data Extraction**: turning complex, unstructured and semi-structured data into uniform, programmatically accessible formats.
+- **Retrieval-Augmented Generation (RAG)**: answering queries across your internal data by providing LLMs with up-to-date, semantically relevant context including Question and Answer systems and chat bots.
+- **Autonomous Agents**: building software that is capable of intelligently selecting and using tools to accomplish tasks in an interative, unsupervised manner.
 
 ## 👨‍👩‍👧‍👦 Who is LlamaIndex for?
 
-LlamaIndex.TS provides a core set of tools, essential for anyone building LLM apps with JavaScript and TypeScript.
+LlamaIndex targets the "AI Engineer": developers building software in any domain that can be enhanced by LLM-powered functionality, without needing to be an expert in machine learning or natural language processing.
 
-Our high-level API allows beginner users to use LlamaIndex.TS to ingest and query their data.
+Our high-level API allows beginner users to use LlamaIndex.TS to ingest, index, and query their data in just a few lines of code.
 
 For more complex applications, our lower-level APIs allow advanced users to customize and extend any module—data connectors, indices, retrievers, and query engines, to fit their needs.
 
@@ -37,7 +35,7 @@ For more complex applications, our lower-level APIs allow advanced users to cust
 
 `npm install llamaindex`
 
-Our documentation includes [Installation Instructions](./getting_started/installation.mdx) and a [Starter Tutorial](./getting_started/starter.mdx) to build your first application.
+Our documentation includes [Installation Instructions](./getting_started/installation.mdx) and a [Starter Tutorial](./getting_started/starter_tutorial/retrieval_augmented_generation.mdx) to build your first application.
 
 Once you're up and running, [High-Level Concepts](./getting_started/concepts.md) has an overview of LlamaIndex's modular architecture. For more hands-on practical examples, look through our Examples section on the sidebar.
 

apps/docs/docs/modules/agent/index.md

@@ -18,3 +18,9 @@ LlamaIndex.TS comes with a few built-in agents, but you can also create your own
 ## Examples
 
 - [OpenAI Agent](../../examples/agent.mdx)
+
+## Api References
+
+- [OpenAIAgent](../../api/classes/OpenAIAgent.md)
+- [AnthropicAgent](../../api/classes/AnthropicAgent.md)
+- [ReActAgent](../../api/classes/ReActAgent.md)

apps/docs/docs/modules/data_loader.mdx

@@ -1,48 +0,0 @@
----
-sidebar_position: 4
----
-
-import CodeBlock from "@theme/CodeBlock";
-import CodeSource from "!raw-loader!../../../../examples/readers/src/simple-directory-reader";
-import CodeSource2 from "!raw-loader!../../../../examples/readers/src/custom-simple-directory-reader";
-import CodeSource3 from "!raw-loader!../../../../examples/readers/src/llamaparse";
-
-# Loader
-
-Before you can start indexing your documents, you need to load them into memory.
-
-### SimpleDirectoryReader
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/run-llama/LlamaIndexTS/tree/main/examples/readers?file=src/simple-directory-reader.ts&title=Simple%20Directory%20Reader)
-
-LlamaIndex.TS supports easy loading of files from folders using the `SimpleDirectoryReader` class.
-
-It is a simple reader that reads all files from a directory and its subdirectories.
-
-<CodeBlock language="ts">{CodeSource}</CodeBlock>
-
-Currently, it supports reading `.csv`, `.docx`, `.html`, `.md` and `.pdf` files,
-but support for other file types is planned.
-
-Also, you can provide a `defaultReader` as a fallback for files with unsupported extensions.
-Or pass new readers for `fileExtToReader` to support more file types.
-
-<CodeBlock language="ts" showLineNumbers metastring="{8-12,17-21}">
-  {CodeSource2}
-</CodeBlock>
-
-### LlamaParse
-
-LlamaParse is an API created by LlamaIndex to efficiently parse files, e.g. it's great at converting PDF tables into markdown.
-
-To use it, first login and get an API key from https://cloud.llamaindex.ai. Make sure to store the key in the environment variable `LLAMA_CLOUD_API_KEY`.
-
-Then, you can use the `LlamaParseReader` class to read a local PDF file and convert it into a markdown document that can be used by LlamaIndex:
-
-<CodeBlock language="ts">{CodeSource3}</CodeBlock>
-
-Alternatively, you can set the [`resultType`](../api/classes/LlamaParseReader.md#resulttype) option to `text` to get the parsed document as a text string.
-
-## API Reference
-
-- [SimpleDirectoryReader](../api/classes/SimpleDirectoryReader.md)

apps/docs/docs/modules/data_loaders/_category_.yml

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

apps/docs/docs/modules/data_loaders/index.mdx

@@ -0,0 +1,37 @@
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../examples/readers/src/simple-directory-reader";
+import CodeSource2 from "!raw-loader!../../../../../examples/readers/src/custom-simple-directory-reader";
+
+# Loader
+
+Before you can start indexing your documents, you need to load them into memory.
+
+## SimpleDirectoryReader
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/run-llama/LlamaIndexTS/tree/main/examples/readers?file=src/simple-directory-reader.ts&title=Simple%20Directory%20Reader)
+
+LlamaIndex.TS supports easy loading of files from folders using the `SimpleDirectoryReader` class.
+
+It is a simple reader that reads all files from a directory and its subdirectories.
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+Currently, it supports reading `.txt`, `.pdf`, `.csv`, `.md`, `.docx`, `.htm`, `.html`, `.jpg`, `.jpeg`, `.png` and `.gif` files, but support for other file types is planned.
+
+You can modify the reader three different ways:
+
+- `overrideReader` overrides the reader for all file types, including unsupported ones.
+- `fileExtToReader` maps a reader to a specific file type. Can override reader for existing file types or add support for new file types.
+- `defaultReader` sets a fallback reader for files with unsupported extensions. By default it is `TextFileReader`.
+
+SimpleDirectoryReader supports up to 9 concurrent requests. Use the `numWorkers` option to set the number of concurrent requests. By default it runs in sequential mode, i.e. set to 1.
+
+### Example
+
+<CodeBlock language="ts" showLineNumbers metastring="{8-12,17-21}">
+  {CodeSource2}
+</CodeBlock>
+
+## API Reference
+
+- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md)

apps/docs/docs/modules/data_loaders/llama_parse/_category_.yml

@@ -0,0 +1 @@
+label: "LlamaParse"

apps/docs/docs/modules/data_loaders/llama_parse/images.mdx

@@ -0,0 +1,117 @@
+---
+sidebar_position: 2
+---
+
+# Image Retrieval
+
+LlamaParse `json` mode supports extracting any images found in a page object by using the `getImages` function. They are downloaded to a local folder and can then be sent to a multimodal LLM for further processing.
+
+## Usage
+
+We use the `getImages` method to input our array of JSON objects, download the images to a specified folder and get a list of ImageNodes.
+
+```ts
+const reader = new LlamaParseReader();
+const jsonObjs = await reader.loadJson("../data/uber_10q_march_2022.pdf");
+const imageDicts = await reader.getImages(jsonObjs, "images");
+```
+
+### Multimodal Indexing
+
+You can create an index across both text and image nodes by requesting alternative text for the image from a multimodal LLM.
+
+```ts
+import {
+  Document,
+  ImageNode,
+  LlamaParseReader,
+  OpenAI,
+  VectorStoreIndex,
+} from "llamaindex";
+import { createMessageContent } from "llamaindex/synthesizers/utils";
+
+const reader = new LlamaParseReader();
+async function main() {
+  // Load PDF using LlamaParse JSON mode and return an array of json objects
+  const jsonObjs = await reader.loadJson("../data/uber_10q_march_2022.pdf");
+  // Access the first "pages" (=a single parsed file) object in the array
+  const jsonList = jsonObjs[0]["pages"];
+
+  const textDocs = getTextDocs(jsonList);
+  const imageTextDocs = await getImageTextDocs(jsonObjs);
+  const documents = [...textDocs, ...imageTextDocs];
+  // Split text, create embeddings and query the index
+  const index = await VectorStoreIndex.fromDocuments(documents);
+  const queryEngine = index.asQueryEngine();
+  const response = await queryEngine.query({
+    query:
+      "What does the bar graph titled 'Monthly Active Platform Consumers' show?",
+  });
+
+  console.log(response.toString());
+}
+
+main().catch(console.error);
+```
+
+We use two helper functions to create documents from the text and image nodes provided.
+
+#### Text Documents
+
+To create documents from the text nodes of the json object, we just map the needed values to a new `Document` object. In this case we assign the text as text and the page number as metadata.
+
+```ts
+function getTextDocs(jsonList: { text: string; page: number }[]): Document[] {
+  return jsonList.map(
+    (page) => new Document({ text: page.text, metadata: { page: page.page } }),
+  );
+}
+```
+
+#### Image Documents
+
+To create documents from the images, we need to use a multimodal LLM to generate alt text.
+
+For this we create `ImageNodes` and add them as part of our message.
+
+We can use the `createMessageContent` function to simplify this.
+
+```ts
+async function getImageTextDocs(
+  jsonObjs: Record<string, any>[],
+): Promise<Document[]> {
+  const llm = new OpenAI({
+    model: "gpt-4o",
+    temperature: 0.2,
+    maxTokens: 1000,
+  });
+  const imageDicts = await reader.getImages(jsonObjs, "images");
+  const imageDocs = [];
+
+  for (const imageDict of imageDicts) {
+    const imageDoc = new ImageNode({ image: imageDict.path });
+    const prompt = () => `Describe the image as alt text`;
+    const message = await createMessageContent(prompt, [imageDoc]);
+
+    const response = await llm.complete({
+      prompt: message,
+    });
+
+    const doc = new Document({
+      text: response.text,
+      metadata: { path: imageDict.path },
+    });
+    imageDocs.push(doc);
+  }
+
+  return imageDocs;
+}
+```
+
+The returned `imageDocs` have the alt text assigned as text and the image path as metadata.
+
+You can see the full example file [here](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/readers/src/llamaparse-json.ts).
+
+## API Reference
+
+- [LlamaParseReader](../../../api/classes/LlamaParseReader.md)

apps/docs/docs/modules/data_loaders/llama_parse/index.mdx

@@ -0,0 +1,58 @@
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../../examples/readers/src/llamaparse";
+import CodeSource2 from "!raw-loader!../../../../../../examples/readers/src/simple-directory-reader-with-llamaparse.ts";
+
+# LlamaParse
+
+LlamaParse is an API created by LlamaIndex to efficiently parse files, e.g. it's great at converting PDF tables into markdown.
+
+To use it, first login and get an API key from https://cloud.llamaindex.ai. Make sure to store the key as `apiKey` parameter or in the environment variable `LLAMA_CLOUD_API_KEY`.
+
+Official documentation for LlamaParse can be found [here](https://docs.cloud.llamaindex.ai/).
+
+## Usage
+
+You can then use the `LlamaParseReader` class to load local files and convert them into a parsed document that can be used by LlamaIndex.
+See [LlamaParseReader.ts](https://github.com/run-llama/LlamaIndexTS/blob/main/packages/llamaindex/src/readers/LlamaParseReader.ts) for a list of supported file types:
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+### Params
+
+All options can be set with the `LlamaParseReader` constructor.
+
+They can be divided into two groups.
+
+#### General params:
+
+- `apiKey` is required. Can be set as an environment variable `LLAMA_CLOUD_API_KEY`
+- `checkInterval` is the interval in seconds to check if the parsing is done. Default is `1`.
+- `maxTimeout` is the maximum timout to wait for parsing to finish. Default is `2000`
+- `verbose` shows progress of the parsing. Default is `true`
+- `ignoreErrors` set to false to get errors while parsing. Default is `true` and returns an empty array on error.
+
+#### Advanced params:
+
+- `resultType` can be set to `markdown`, `text` or `json`. Defaults to `text`. More information about `json` mode on the next pages.
+- `language` primarly helps with OCR recognition. Defaults to `en`. Click [here](../../../api/type-aliases/Language.md) for a list of supported languages.
+- `parsingInstructions?` Optional. Can help with complicated document structures. See this [LlamaIndex Blog Post](https://www.llamaindex.ai/blog/launching-the-first-genai-native-document-parsing-platform) for an example.
+- `skipDiagonalText?` Optional. Set to true to ignore diagonal text. (Text that is not rotated 0, 90, 180 or 270 degrees)
+- `invalidateCache?` Optional. Set to true to ignore the LlamaCloud cache. All document are kept in cache for 48hours after the job was completed to avoid processing the same document twice. Can be useful for testing when trying to re-parse the same document with, e.g. different `parsingInstructions`.
+- `doNotCache?` Optional. Set to true to not cache the document.
+- `fastMode?` Optional. Set to true to use the fast mode. This mode will skip OCR of images, and table/heading reconstruction. Note: Non-compatible with `gpt4oMode`.
+- `doNotUnrollColumns?` Optional. Set to true to keep the text according to document layout. Reduce reconstruction accuracy, and LLM's/embedings performances in most cases.
+- `pageSeperator?` Optional. The page seperator to use. Defaults is `\\n---\\n`.
+- `gpt4oMode` set to true to use GPT-4o to extract content. Default is `false`.
+- `gpt4oApiKey?` Optional. Set the GPT-4o API key. Lowers the cost of parsing by using your own API key. Your OpenAI account will be charged. Can also be set in the environment variable `LLAMA_CLOUD_GPT4O_API_KEY`.
+- `numWorkers` as in the python version, is set in `SimpleDirectoryReader`. Default is 1.
+
+### LlamaParse with SimpleDirectoryReader
+
+Below a full example of `LlamaParse` integrated in `SimpleDirectoryReader` with additional options.
+
+<CodeBlock language="ts">{CodeSource2}</CodeBlock>
+
+## API Reference
+
+- [SimpleDirectoryReader](../../../api/classes/SimpleDirectoryReader.md)
+- [LlamaParseReader](../../../api/classes/LlamaParseReader.md)

apps/docs/docs/modules/data_loaders/llama_parse/json_mode.mdx

@@ -0,0 +1,59 @@
+---
+sidebar_position: 1
+---
+
+# JSON Mode
+
+In JSON mode, LlamaParse will return a data structure representing the parsed object.
+
+## Usage
+
+For Json mode, you need to use `loadJson`. The `resultType` is automatically set with this method. Currently it can't be used with `SimpleDirectoryReader`.
+More information about indexing the results on the next page.
+
+```ts
+const reader = new LlamaParseReader();
+async function main() {
+  // Load the file and return an array of json objects
+  const jsonObjs = await reader.loadJson("../data/uber_10q_march_2022.pdf");
+  // Access the first "pages" (=a single parsed file) object in the array
+  const jsonList = jsonObjs[0]["pages"];
+  // Further process the jsonList object as needed.
+}
+```
+
+### Output
+
+The result format of the response, written to `jsonObjs` in the example, follows this structure:
+
+```json
+{
+    "pages": [
+        ..page objects..
+    ],
+    "job_metadata": {
+        "credits_used": int,
+        "credits_max": int,
+        "job_credits_usage": int,
+        "job_pages": int,
+        "job_is_cache_hit": boolean
+    },
+    "job_id": string ,
+    "file_path": string,
+    }
+}
+```
+
+#### Page objects
+
+Within page objects, the following keys may be present depending on your document.
+
+- `page`: The page number of the document.
+- `text`: The text extracted from the page.
+- `md`: The markdown version of the extracted text.
+- `images`: Any images extracted from the page.
+- `items`: An array of heading, text and table objects in the order they appear on the page.
+
+## API Reference
+
+- [LlamaParseReader](../../../api/classes/LlamaParseReader.md)

apps/docs/docs/modules/documents_and_nodes/index.md

@@ -14,5 +14,5 @@ document = new Document({ text: "text", metadata: { key: "val" } });
 
 ## API Reference
 
-- [Document](../api/classes/Document.md)
-- [TextNode](../api/classes/TextNode.md)
+- [Document](../../api/classes/Document.md)
+- [TextNode](../../api/classes/TextNode.md)

apps/docs/docs/modules/documents_and_nodes/metadata_extraction.md

@@ -43,3 +43,10 @@ async function main() {
 
 main().then(() => console.log("done"));
 ```
+
+## API Reference
+
+- [SummaryExtractor](../../api/classes/SummaryExtractor.md)
+- [QuestionsAnsweredExtractor](../../api/classes/QuestionsAnsweredExtractor.md)
+- [TitleExtractor](../../api/classes/TitleExtractor.md)
+- [KeywordExtractor](../../api/classes/KeywordExtractor.md)

apps/docs/docs/modules/embeddings/available_embeddings/deepinfra.md

@@ -0,0 +1,83 @@
+# DeepInfra
+
+To use DeepInfra embeddings, you need to import `DeepInfraEmbedding` from llamaindex.
+Check out available embedding models [here](https://deepinfra.com/models/embeddings).
+
+```ts
+import {
+  DeepInfraEmbedding,
+  Settings,
+  Document,
+  VectorStoreIndex,
+} from "llamaindex";
+
+// Update Embed Model
+Settings.embedModel = new DeepInfraEmbedding();
+
+const document = new Document({ text: essay, id_: "essay" });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+
+const queryEngine = index.asQueryEngine();
+
+const query = "What is the meaning of life?";
+
+const results = await queryEngine.query({
+  query,
+});
+```
+
+By default, DeepInfraEmbedding is using the sentence-transformers/clip-ViT-B-32 model. You can change the model by passing the model parameter to the constructor.
+For example:
+
+```ts
+import { DeepInfraEmbedding } from "llamaindex";
+
+const model = "intfloat/e5-large-v2";
+Settings.embedModel = new DeepInfraEmbedding({
+  model,
+});
+```
+
+You can also set the `maxRetries` and `timeout` parameters when initializing `DeepInfraEmbedding` for better control over the request behavior.
+
+For example:
+
+```ts
+import { DeepInfraEmbedding, Settings } from "llamaindex";
+
+const model = "intfloat/e5-large-v2";
+const maxRetries = 5;
+const timeout = 5000; // 5 seconds
+
+Settings.embedModel = new DeepInfraEmbedding({
+  model,
+  maxRetries,
+  timeout,
+});
+```
+
+Standalone usage:
+
+```ts
+import { DeepInfraEmbedding } from "llamaindex";
+import { config } from "dotenv";
+// For standalone usage, you need to configure DEEPINFRA_API_TOKEN in .env file
+config();
+
+const main = async () => {
+  const model = "intfloat/e5-large-v2";
+  const embeddings = new DeepInfraEmbedding({ model });
+  const text = "What is the meaning of life?";
+  const response = await embeddings.embed([text]);
+  console.log(response);
+};
+
+main();
+```
+
+For questions or feedback, please contact us at [feedback@deepinfra.com](mailto:feedback@deepinfra.com)
+
+## API Reference
+
+- [DeepInfraEmbedding](../../../api/classes/DeepInfraEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/gemini.md

@@ -31,3 +31,7 @@ Settings.embedModel = new GeminiEmbedding({
   model: GEMINI_MODEL.GEMINI_PRO_LATEST,
 });
 ```
+
+## API Reference
+
+- [GeminiEmbedding](../../../api/classes/GeminiEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/huggingface.md

@@ -32,3 +32,7 @@ Settings.embedModel = new HuggingFaceEmbedding({
   quantized: false,
 });
 ```
+
+## API Reference
+
+- [HuggingFaceEmbedding](../../../api/classes/HuggingFaceEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/jinaai.md

@@ -19,3 +19,7 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+## API Reference
+
+- [JinaAIEmbedding](../../../api/classes/JinaAIEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/mistral.md

@@ -22,3 +22,7 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+## API Reference
+
+- [MistralAIEmbedding](../../../api/classes/MistralAIEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/ollama.md

@@ -27,3 +27,7 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+## API Reference
+
+- [OllamaEmbedding](../../../api/classes/OllamaEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/openai.md

@@ -19,3 +19,7 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+## API Reference
+
+- [OpenAIEmbedding](../../../api/classes/OpenAIEmbedding.md)

apps/docs/docs/modules/embeddings/available_embeddings/together.md

@@ -21,3 +21,7 @@ const results = await queryEngine.query({
   query,
 });
 ```
+
+## API Reference
+
+- [TogetherEmbedding](../../../api/classes/TogetherEmbedding.md)

apps/docs/docs/modules/evaluation/modules/correctness.md

@@ -21,7 +21,7 @@ export OPENAI_API_KEY=your-api-key
 Import the required modules:
 
 ```ts
-import { CorrectnessEvaluator, OpenAI, Settings } from "llamaindex";
+import { CorrectnessEvaluator, OpenAI, Settings, Response } from "llamaindex";
 ```
 
 Let's setup gpt-4 for better results:
@@ -45,7 +45,7 @@ const evaluator = new CorrectnessEvaluator();
 
 const result = await evaluator.evaluateResponse({
   query,
-  response,
+  response: new Response(response),
 });
 
 console.log(
@@ -56,3 +56,7 @@ console.log(
 ```bash
 the response is not correct with a score of 2.5
 ```
+
+## API Reference
+
+- [CorrectnessEvaluator](../../../api/classes/CorrectnessEvaluator.md)

apps/docs/docs/modules/evaluation/modules/faithfulness.md

@@ -76,3 +76,7 @@ console.log(`the response is ${result.passing ? "faithful" : "not faithful"}`);
 ```bash
 the response is faithful
 ```
+
+## API Reference
+
+- [FaithfulnessEvaluator](../../../api/classes/FaithfulnessEvaluator.md)

apps/docs/docs/modules/evaluation/modules/relevancy.md

@@ -21,7 +21,13 @@ export OPENAI_API_KEY=your-api-key
 Import the required modules:
 
 ```ts
-import { RelevancyEvaluator, OpenAI, Settings } from "llamaindex";
+import {
+  RelevancyEvaluator,
+  OpenAI,
+  Settings,
+  Document,
+  VectorStoreIndex,
+} from "llamaindex";
 ```
 
 Let's setup gpt-4 for better results:
@@ -64,3 +70,7 @@ console.log(`the response is ${result.passing ? "relevant" : "not relevant"}`);
 ```bash
 the response is relevant
 ```
+
+## API Reference
+
+- [RelevancyEvaluator](../../../api/classes/RelevancyEvaluator.md)

apps/docs/docs/modules/ingestion_pipeline/index.md

@@ -97,3 +97,7 @@ async function main() {
 
 main().catch(console.error);
 ```
+
+## API Reference
+
+- [IngestionPipeline](../../api/classes/IngestionPipeline.md)

apps/docs/docs/modules/ingestion_pipeline/transformations.md

@@ -4,9 +4,9 @@ A transformation is something that takes a list of nodes as an input, and return
 
 Currently, the following components are Transformation objects:
 
-- [SimpleNodeParser](../api/classes/SimpleNodeParser.md)
+- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md)
 - [MetadataExtractor](../documents_and_nodes/metadata_extraction.md)
-- Embeddings
+- [Embeddings](../embeddings/index.md)
 
 ## Usage Pattern
 

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

@@ -63,3 +63,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [Anthropic](../../../api/classes/Anthropic.md)

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

@@ -74,3 +74,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [OpenAI](../../../api/classes/OpenAI.md)

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

@@ -0,0 +1,62 @@
+# Bedrock
+
+## Usage
+
+```ts
+import { BEDROCK_MODELS, Bedrock } from "@llamaindex/community";
+
+Settings.llm = new Bedrock({
+  model: BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_HAIKU,
+  region: "us-east-1", // can be provided via env AWS_REGION
+  credentials: {
+    accessKeyId: "...", // optional and can be provided via env AWS_ACCESS_KEY_ID
+    secretAccessKey: "...", // optional and can be provided via env AWS_SECRET_ACCESS_KEY
+  },
+});
+```
+
+Currently only supports Anthropic models:
+
+```ts
+ANTHROPIC_CLAUDE_INSTANT_1 = "anthropic.claude-instant-v1";
+ANTHROPIC_CLAUDE_2 = "anthropic.claude-v2";
+ANTHROPIC_CLAUDE_2_1 = "anthropic.claude-v2:1";
+ANTHROPIC_CLAUDE_3_SONNET = "anthropic.claude-3-sonnet-20240229-v1:0";
+ANTHROPIC_CLAUDE_3_HAIKU = "anthropic.claude-3-haiku-20240307-v1:0";
+ANTHROPIC_CLAUDE_3_OPUS = "anthropic.claude-3-opus-20240229-v1:0"; // available on us-west-2
+ANTHROPIC_CLAUDE_3_5_SONNET = "anthropic.claude-3-5-sonnet-20240620-v1:0";
+```
+
+Sonnet, Haiku and Opus are multimodal, image_url only supports base64 data url format, e.g. `data:image/jpeg;base64,SGVsbG8sIFdvcmxkIQ==`
+
+## Full Example
+
+```ts
+import { BEDROCK_MODELS, Bedrock } from "llamaindex";
+
+Settings.llm = new Bedrock({
+  model: BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_HAIKU,
+});
+
+async function main() {
+  const document = new Document({ text: essay, id_: "essay" });
+
+  // Load and index documents
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // Create a query engine
+  const queryEngine = index.asQueryEngine({
+    retriever,
+  });
+
+  const query = "What is the meaning of life?";
+
+  // Query
+  const response = await queryEngine.query({
+    query,
+  });
+
+  // Log the response
+  console.log(response.response);
+}
+```

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

@@ -0,0 +1,87 @@
+# DeepInfra
+
+Check out available LLMs [here](https://deepinfra.com/models/text-generation).
+
+```ts
+import { DeepInfra, Settings } from "llamaindex";
+
+// Get the API key from `DEEPINFRA_API_TOKEN` environment variable
+import { config } from "dotenv";
+config();
+Settings.llm = new DeepInfra();
+
+// Set the API key
+apiKey = "YOUR_API_KEY";
+Settings.llm = new DeepInfra({ apiKey });
+```
+
+You can setup the apiKey on the environment variables, like:
+
+```bash
+export DEEPINFRA_API_TOKEN="<YOUR_API_KEY>"
+```
+
+## Load and index documents
+
+For this example, we will use a single document. In a real-world scenario, you would have multiple documents to index.
+
+```ts
+const document = new Document({ text: essay, id_: "essay" });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+## Query
+
+```ts
+const queryEngine = index.asQueryEngine();
+
+const query = "What is the meaning of life?";
+
+const results = await queryEngine.query({
+  query,
+});
+```
+
+## Full Example
+
+```ts
+import { DeepInfra, Document, VectorStoreIndex, Settings } from "llamaindex";
+
+// Use custom LLM
+const model = "meta-llama/Meta-Llama-3-8B-Instruct";
+Settings.llm = new DeepInfra({ model, temperature: 0 });
+
+async function main() {
+  const document = new Document({ text: essay, id_: "essay" });
+
+  // Load and index documents
+  const index = await VectorStoreIndex.fromDocuments([document]);
+
+  // get retriever
+  const retriever = index.asRetriever();
+
+  // Create a query engine
+  const queryEngine = index.asQueryEngine({
+    retriever,
+  });
+
+  const query = "What is the meaning of life?";
+
+  // Query
+  const response = await queryEngine.query({
+    query,
+  });
+
+  // Log the response
+  console.log(response.response);
+}
+```
+
+## Feedback
+
+If you have any feedback, please reach out to us at [feedback@deepinfra.com](mailto:feedback@deepinfra.com)
+
+## API Reference
+
+- [DeepInfra](../../../api/classes/DeepInfra)

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

@@ -59,3 +59,7 @@ async function main() {
 
 main().catch(console.error);
 ```
+
+## API Reference
+
+- [FireworksLLM](../../../api/classes/FireworksLLM.md)

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

@@ -10,6 +10,36 @@ Settings.llm = new Gemini({
 });
 ```
 
+### Usage with Vertex AI
+
+To use Gemini via Vertex AI you can use `GeminiVertexSession`.
+
+GeminiVertexSession accepts the env variables: `GOOGLE_VERTEX_LOCATION` and `GOOGLE_VERTEX_PROJECT`
+
+```ts
+import { Gemini, GEMINI_MODEL, GeminiVertexSession } from "llamaindex";
+
+const gemini = new Gemini({
+  model: GEMINI_MODEL.GEMINI_PRO,
+  session: new GeminiVertexSession({
+    location: "us-central1",      // optional if provided by GOOGLE_VERTEX_LOCATION env variable
+    project: "project1",          // optional if provided by GOOGLE_VERTEX_PROJECT env variable
+    googleAuthOptions: {...},     // optional, but useful for production. It accepts all values from `GoogleAuthOptions`
+  }),
+});
+```
+
+[GoogleAuthOptions](https://github.com/googleapis/google-auth-library-nodejs/blob/main/src/auth/googleauth.ts)
+
+To authenticate for local development:
+
+```bash
+npm install @google-cloud/vertexai
+gcloud auth application-default login
+```
+
+To authenticate for production you'll have to use a [service account](https://cloud.google.com/docs/authentication/). `googleAuthOptions` has `credentials` which might be useful for you.
+
 ## Load and index documents
 
 For this example, we will use a single document. In a real-world scenario, you would have multiple documents to index.
@@ -69,3 +99,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [Gemini](../../../api/classes/Gemini.md)

apps/docs/docs/modules/llms/available_llms/groq.mdx

@@ -50,3 +50,7 @@ const results = await queryEngine.query({
 <CodeBlock language="ts" showLineNumbers>
   {CodeSource}
 </CodeBlock>
+
+## API Reference
+
+- [Groq](../../../api/classes/Groq.md)

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

@@ -89,3 +89,8 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [LlamaDeuce](../../../api/variables/LlamaDeuce.md)
+- [DeuceChatStrategy](../../../api/variables/DeuceChatStrategy.md)

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

@@ -3,7 +3,7 @@
 ## Usage
 
 ```ts
-import { Ollama, Settings } from "llamaindex";
+import { MistralAI, Settings } from "llamaindex";
 
 Settings.llm = new MistralAI({
   model: "mistral-tiny",
@@ -66,3 +66,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [MistralAI](../../../api/classes/MistralAI.md)

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

@@ -71,3 +71,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [Ollama](../../../api/classes/Ollama.md)

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

@@ -67,3 +67,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [OpenAI](../../../api/classes/OpenAI.md)

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

@@ -68,3 +68,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [Portkey](../../../api/classes/Portkey.md)

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

@@ -66,3 +66,7 @@ async function main() {
   console.log(response.response);
 }
 ```
+
+## API Reference
+
+- [TogetherLLM](../../../api/classes/TogetherLLM.md)

apps/docs/docs/modules/llms/index.md

@@ -32,4 +32,4 @@ For local LLMs, currently we recommend the use of [Ollama](./available_llms/olla
 
 ## API Reference
 
-- [OpenAI](../api/classes/OpenAI.md)
+- [OpenAI](../../api/classes/OpenAI.md)

apps/docs/docs/modules/node_parser.md

@@ -95,3 +95,4 @@ The output metadata will be something like:
 
 - [SimpleNodeParser](../api/classes/SimpleNodeParser.md)
 - [SentenceSplitter](../api/classes/SentenceSplitter.md)
+- [MarkdownNodeParser](../api/classes/MarkdownNodeParser.md)

apps/docs/docs/modules/node_postprocessors/cohere_reranker.md

@@ -65,3 +65,7 @@ const queryEngine = index.asQueryEngine({
 // log the response
 const response = await queryEngine.query("Where did the author grown up?");
 ```
+
+## API Reference
+
+- [CohereRerank](../../api/classes/CohereRerank.md)

apps/docs/docs/modules/node_postprocessors/index.md

@@ -103,3 +103,7 @@ const processor = new SimilarityPostprocessor({
 
 const filteredNodes = processor.postprocessNodes(nodes);
 ```
+
+## API Reference
+
+- [SimilarityPostprocessor](../../api/classes/SimilarityPostprocessor.md)

apps/docs/docs/modules/node_postprocessors/jinaai_reranker.md

@@ -69,3 +69,7 @@ const queryEngine = index.asQueryEngine({
 // log the response
 const response = await queryEngine.query("Where did the author grown up?");
 ```
+
+## API Reference
+
+- [JinaAIReranker](../../api/classes/JinaAIReranker.md)

apps/docs/docs/modules/prompt/index.md

@@ -70,3 +70,9 @@ const response = await queryEngine.query({
   query: "What did the author do in college?",
 });
 ```
+
+## API Reference
+
+- [TextQaPrompt](../../api/type-aliases/TextQaPrompt.md)
+- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md)
+- [CompactAndRefine](../../api/classes/CompactAndRefine.md)

apps/docs/docs/modules/query_engines/index.md

@@ -38,4 +38,4 @@ You can learn more about Tools by taking a look at the LlamaIndex Python documen
 
 - [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md)
 - [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md)
-- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md)
+- [QueryEngineTool](../../api/classes/QueryEngineTool.md)

apps/docs/docs/modules/query_engines/metadata_filtering.md

@@ -151,3 +151,8 @@ async function main() {
 
 main();
 ```
+
+## API Reference
+
+- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md)
+- [ChromaVectorStore](../../api/classes/ChromaVectorStore.md)

apps/docs/docs/modules/query_engines/router_query_engine.md

@@ -165,3 +165,7 @@ async function main() {
 
 main().then(() => console.log("Done"));
 ```
+
+## API Reference
+
+- [RouterQueryEngine](../../api/classes/RouterQueryEngine.md)

apps/docs/docs/modules/storage.md

@@ -23,4 +23,4 @@ const index = await VectorStoreIndex.fromDocuments([document], {
 
 ## API Reference
 
-- [StorageContext](../api/interfaces//StorageContext.md)
+- [StorageContext](../api/interfaces/StorageContext.md)

apps/docs/docs/modules/vector_stores/qdrant.md

@@ -84,3 +84,7 @@ async function main() {
 
 main().catch(console.error);
 ```
+
+## API Reference
+
+- [QdrantVectorStore](../../api/classes/QdrantVectorStore.md)

apps/docs/docusaurus.config.js

@@ -167,7 +167,7 @@ const config = {
     [
       "docusaurus-plugin-typedoc",
       {
-        entryPoints: ["../../packages/core/src/index.ts"],
+        entryPoints: ["../../packages/llamaindex/src/index.ts"],
         tsconfig: "../../tsconfig.json",
         readme: "none",
         sourceLinkTemplate:

apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md

@@ -271,7 +271,7 @@ custom_edit_url: null
 
 ### setDocumentHash
 
-▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `void`
+▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\>
 
 #### Parameters
 

apps/docs/i18n/hr/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md

@@ -271,7 +271,7 @@ custom_edit_url: null
 
 ### setDocumentHash
 
-▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `void`
+▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\>
 
 #### Parameters
 

apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md

@@ -271,7 +271,7 @@ custom_edit_url: null
 
 ### setDocumentHash
 
-▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `void`
+▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\>
 
 #### Parameters
 

apps/docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.19",
+  "version": "0.0.27",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -37,7 +37,7 @@
     "docusaurus-plugin-typedoc": "^1.0.1",
     "typedoc": "^0.25.13",
     "typedoc-plugin-markdown": "^4.0.1",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "browserslist": {
     "production": [

examples/CHANGELOG.md

@@ -1,5 +1,15 @@
 # examples
 
+## 0.0.5
+
+### Patch Changes
+
+- Updated dependencies [436bc41]
+- Updated dependencies [a44e54f]
+- Updated dependencies [a51ed8d]
+- Updated dependencies [d3b635b]
+  - llamaindex@0.4.0
+
 ## 0.0.4
 
 ### Patch Changes

examples/agent/large_toolcall.ts

@@ -0,0 +1,64 @@
+import { FunctionTool, OpenAI, OpenAIAgent } from "llamaindex";
+
+const csvData =
+  "TITLE,RELEASE_YEAR,SCORE,NUMBER_OF_VOTES,DURATION,MAIN_GENRE,MAIN_PRODUCTION\nDavid Attenborough: A Life on Our Planet,2020,9,31180,83,documentary,GB\nInception,2010,8.8,2268288,148,scifi,GB\nForrest Gump,1994,8.8,1994599,142,drama,US\nAnbe Sivam,2003,8.7,20595,160,comedy,IN\nBo Burnham: Inside,2021,8.7,44074,87,comedy,US\nSaving Private Ryan,1998,8.6,1346020,169,drama,US\nDjango Unchained,2012,8.4,1472668,165,western,US\nDangal,2016,8.4,180247,161,action,IN\nBo Burnham: Make Happy,2016,8.4,14356,60,comedy,US\nLouis C.K.: Hilarious,2010,8.4,11973,84,comedy,US\nDave Chappelle: Sticks & Stones,2019,8.4,25687,65,comedy,US\n3 Idiots,2009,8.4,385782,170,comedy,IN\nBlack Friday,2004,8.4,20611,143,crime,IN\nSuper Deluxe,2019,8.4,13680,176,thriller,IN\nWinter on Fire: Ukraine's Fight for Freedom,2015,8.3,17710,98,documentary,UA\nOnce Upon a Time in America,1984,8.3,342335,229,drama,US\nTaxi Driver,1976,8.3,795222,113,crime,US\nLike Stars on Earth,2007,8.3,188234,165,drama,IN\nBo Burnham: What.,2013,8.3,11488,60,comedy,US\nFull Metal Jacket,1987,8.3,723306,116,drama,GB\nWarrior,2011,8.2,463276,140,drama,US\nDrishyam,2015,8.2,79075,163,thriller,IN\nQueen,2014,8.2,64805,146,drama,IN\nPaan Singh Tomar,2012,8.2,35888,135,drama,IN";
+
+const userQuestion = "which are the best comedies after 2010?";
+
+(async () => {
+  // The agent will succeed if we increase `maxTokens` to 1024
+  const llm = new OpenAI({ model: "gpt-4-turbo", maxTokens: 256 });
+
+  type Input = {
+    code: string;
+  };
+  // initiate fake code interpreter
+  const interpreterTool = FunctionTool.from<Input>(
+    ({ code }) => {
+      console.log(
+        `To answer the user's question, call the following code:\n${code}`,
+      );
+      return code;
+    },
+    {
+      name: "interpreter",
+      description:
+        "Execute python code in a Jupyter notebook cell and return any result, stdout, stderr, display_data, and error.",
+      parameters: {
+        type: "object",
+        properties: {
+          code: {
+            type: "string",
+            description: "The python code to execute in a single cell.",
+          },
+        },
+        required: ["code"],
+      },
+    },
+  );
+
+  const systemPrompt =
+    "You are a Python interpreter.\n        - You are given tasks to complete and you run python code to solve them.\n        - The python code runs in a Jupyter notebook. Every time you call $(interpreter) tool, the python code is executed in a separate cell. It's okay to make multiple calls to $(interpreter).\n        - Display visualizations using matplotlib or any other visualization library directly in the notebook. Shouldn't save the visualizations to a file, just return the base64 encoded data.\n        - You can install any pip package (if it exists) if you need to but the usual packages for data analysis are already preinstalled.\n        - You can run any python code you want in a secure environment.";
+
+  const agent = new OpenAIAgent({
+    llm,
+    tools: [interpreterTool],
+    systemPrompt,
+    verbose: true,
+  });
+
+  console.log(`User question: ${userQuestion}\n`);
+
+  await agent.chat({
+    message: [
+      {
+        type: "text",
+        text: userQuestion,
+      },
+      {
+        type: "text",
+        text: `Use data from following CSV raw contents:\n${csvData}`,
+      },
+    ],
+  });
+})();

examples/agent/large_toolcall_with_gpt4o.ts

@@ -0,0 +1,74 @@
+import { FunctionTool, OpenAI, ToolCallOptions } from "llamaindex";
+
+(async () => {
+  // The tool call will generate a partial JSON for `gpt-4-turbo`
+  // See thread: https://community.openai.com/t/gpt-4o-doesnt-consistently-respect-json-schema-on-tool-use/751125/7
+
+  const models = ["gpt-4o", "gpt-4-turbo"];
+  for (const model of models) {
+    const validJSON = await callLLM({ model });
+    console.log(
+      `LLM call resulting in large tool input with '${model}': LLM generates ${validJSON ? "valid" : "invalid"} JSON.`,
+    );
+  }
+})();
+
+async function callLLM(init: Partial<OpenAI>) {
+  const csvData =
+    "Country,Average Height (cm)\nNetherlands,156\nDenmark,158\nNorway,160";
+
+  const userQuestion = "Describe data in this csv";
+
+  // fake code interpreter tool
+  const interpreterTool = FunctionTool.from(
+    ({ code }: { code: string }) => code,
+    {
+      name: "interpreter",
+      description:
+        "Execute python code in a Jupyter notebook cell and return any result, stdout, stderr, display_data, and error.",
+      parameters: {
+        type: "object",
+        properties: {
+          code: {
+            type: "string",
+            description: "The python code to execute in a single cell.",
+          },
+        },
+        required: ["code"],
+      },
+    },
+  );
+
+  const systemPrompt =
+    "You are a Python interpreter.\n- You are given tasks to complete and you run python code to solve them.\n- The python code runs in a Jupyter notebook. Every time you call $(interpreter) tool, the python code is executed in a separate cell. It's okay to make multiple calls to $(interpreter).\n- Display visualizations using matplotlib or any other visualization library directly in the notebook. Shouldn't save the visualizations to a file, just return the base64 encoded data.\n- You can install any pip package (if it exists) if you need to but the usual packages for data analysis are already preinstalled.\n- You can run any python code you want in a secure environment.";
+
+  const llm = new OpenAI(init);
+  const response = await llm.chat({
+    tools: [interpreterTool],
+    messages: [
+      { role: "system", content: systemPrompt },
+      {
+        role: "user",
+        content: [
+          {
+            type: "text",
+            text: userQuestion,
+          },
+          {
+            type: "text",
+            text: `Use data from following CSV raw contents:\n${csvData}`,
+          },
+        ],
+      },
+    ],
+  });
+
+  const options = response.message?.options as ToolCallOptions;
+  const input = options.toolCall[0].input as string;
+  try {
+    JSON.parse(input);
+    return true;
+  } catch {
+    return false;
+  }
+}

examples/agent/openai.ts

@@ -53,7 +53,7 @@ async function main() {
     message: "How much is 5 + 5? then divide by 2",
   });
 
-  console.log(response.response.message);
+  console.log(response.message);
 }
 
 void main().then(() => {

examples/agent/react_agent.ts

@@ -68,7 +68,7 @@ async function main() {
   });
 
   // Chat with the agent
-  const { response } = await agent.chat({
+  const response = await agent.chat({
     message: "Divide 16 by 2 then add 20",
   });
 

examples/agent/step_wise_query_tool.ts

@@ -31,7 +31,7 @@ async function main() {
     tools: [queryEngineTool],
   });
 
-  const { response } = await agent.chat({
+  const response = await agent.chat({
     message: "What was his salary?",
   });
 

examples/agent/stream_openai_agent.ts

@@ -68,9 +68,7 @@ async function main() {
 
   console.log("Response:");
 
-  for await (const {
-    response: { delta },
-  } of stream) {
+  for await (const { delta } of stream) {
     process.stdout.write(delta);
   }
 }

examples/agent/wiki.ts

@@ -16,9 +16,7 @@ async function main() {
     stream: true,
   });
 
-  for await (const {
-    response: { delta },
-  } of response) {
+  for await (const { delta } of response) {
     process.stdout.write(delta);
   }
 }

examples/anthropic/agent.ts

@@ -1,11 +1,17 @@
-import { FunctionTool, Settings, WikipediaTool } from "llamaindex";
+import { Anthropic, FunctionTool, Settings, WikipediaTool } from "llamaindex";
 import { AnthropicAgent } from "llamaindex/agent/anthropic";
 
 Settings.callbackManager.on("llm-tool-call", (event) => {
   console.log("llm-tool-call", event.detail.payload.toolCall);
 });
 
+const anthropic = new Anthropic({
+  apiKey: process.env.ANTHROPIC_API_KEY,
+  model: "claude-3-5-sonnet",
+});
+
 const agent = new AnthropicAgent({
+  llm: anthropic,
   tools: [
     FunctionTool.from<{ location: string }>(
       (query) => {
@@ -31,7 +37,6 @@ const agent = new AnthropicAgent({
 });
 
 async function main() {
-  // https://docs.anthropic.com/claude/docs/tool-use#tool-use-best-practices-and-limitations
   const { response } = await agent.chat({
     message:
       "What is the weather in New York? What's the history of New York from Wikipedia in 3 sentences?",

examples/anthropic/stream.ts

@@ -3,7 +3,7 @@ import { Anthropic } from "llamaindex";
 (async () => {
   const anthropic = new Anthropic({
     apiKey: process.env.ANTHROPIC_API_KEY,
-    model: "claude-instant-1.2",
+    model: "claude-3-5-sonnet",
   });
   const stream = await anthropic.chat({
     messages: [