Release 0.5.9 (#1070)

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

.github/workflows/lint_on_push_or_pull.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:

.github/workflows/preview.yml

@@ -0,0 +1,28 @@
+name: Publish Preview
+on: [pull_request]
+
+jobs:
+  pre_release:
+    name: Pre Release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Pre Release
+        run: pnpx pkg-pr-new publish ./packages/*

.github/workflows/publish_github.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v4
 
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 
       - name: Setup Node.js
         uses: actions/setup-node@v4

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v4
 
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -67,3 +67,4 @@ jobs:
         with:
           commit_message: "chore: update lock file"
           branch: changeset-release/main
+          file_pattern: "pnpm-lock.yaml"

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -45,7 +45,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -60,7 +60,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -97,7 +97,7 @@ jobs:
     name: Build LlamaIndex Example (${{ matrix.packages }})
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -116,7 +116,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:

README.md

@@ -76,7 +76,7 @@ main();
 node --import tsx ./main.ts
 ```
 
-### Next.js
+### React Server Component (Next.js, Waku, Redwood.JS...)
 
 First, you will need to add a llamaindex plugin to your Next.js project.
 
@@ -154,40 +154,6 @@ export async function chatWithAgent(
 }
 ```
 
-### Cloudflare Workers
-
-```ts
-// src/index.ts
-export default {
-  async fetch(
-    request: Request,
-    env: Env,
-    ctx: ExecutionContext,
-  ): Promise<Response> {
-    const { setEnvs } = await import("@llamaindex/env");
-    // set environment variables so that the OpenAIAgent can use them
-    setEnvs(env);
-    const { OpenAIAgent } = await import("llamaindex");
-    const agent = new OpenAIAgent({
-      tools: [],
-    });
-    const responseStream = await agent.chat({
-      stream: true,
-      message: "Hello? What is the weather today?",
-    });
-    const textEncoder = new TextEncoder();
-    const response = responseStream.pipeThrough(
-      new TransformStream({
-        transform: (chunk, controller) => {
-          controller.enqueue(textEncoder.encode(chunk.response.delta));
-        },
-      }),
-    );
-    return new Response(response);
-  },
-};
-```
-
 ## Playground
 
 Check out our NextJS playground at https://llama-playground.vercel.app/. The source is available at https://github.com/run-llama/ts-playground

apps/docs/CHANGELOG.md

@@ -1,5 +1,145 @@
 # docs
 
+## 0.0.50
+
+### Patch Changes
+
+- Updated dependencies [15962b3]
+  - llamaindex@0.5.9
+
+## 0.0.49
+
+### Patch Changes
+
+- Updated dependencies [3d5ba08]
+- Updated dependencies [d917cdc]
+  - llamaindex@0.5.8
+
+## 0.0.48
+
+### Patch Changes
+
+- Updated dependencies [ec59acd]
+  - llamaindex@0.5.7
+
+## 0.0.47
+
+### Patch Changes
+
+- Updated dependencies [2562244]
+- Updated dependencies [325aa51]
+- Updated dependencies [ab700ea]
+- Updated dependencies [92f0782]
+- Updated dependencies [6cf6ae6]
+- Updated dependencies [b7cfe5b]
+  - llamaindex@0.5.6
+
+## 0.0.46
+
+### Patch Changes
+
+- Updated dependencies [b974eea]
+  - llamaindex@0.5.5
+
+## 0.0.45
+
+### Patch Changes
+
+- Updated dependencies [1a65ead]
+  - llamaindex@0.5.4
+
+## 0.0.44
+
+### Patch Changes
+
+- Updated dependencies [9bbbc67]
+- Updated dependencies [b3681bf]
+  - llamaindex@0.5.3
+
+## 0.0.43
+
+### Patch Changes
+
+- llamaindex@0.5.2
+
+## 0.0.42
+
+### Patch Changes
+
+- 2774681: Add mixedbread's embeddings and reranking API
+- Updated dependencies [2774681]
+- Updated dependencies [a0f424e]
+  - llamaindex@0.5.1
+
+## 0.0.41
+
+### Patch Changes
+
+- 36ddec4: fix: typo in custom page separator parameter for LlamaParse
+- Updated dependencies [16ef5dd]
+- Updated dependencies [16ef5dd]
+- Updated dependencies [36ddec4]
+  - llamaindex@0.5.0
+  - @llamaindex/examples@0.0.7
+
+## 0.0.40
+
+### Patch Changes
+
+- llamaindex@0.4.14
+
+## 0.0.39
+
+### Patch Changes
+
+- Updated dependencies [e8f8bea]
+- Updated dependencies [304484b]
+  - llamaindex@0.4.13
+
+## 0.0.38
+
+### Patch Changes
+
+- Updated dependencies [f326ab8]
+  - llamaindex@0.4.12
+
+## 0.0.37
+
+### Patch Changes
+
+- Updated dependencies [8bf5b4a]
+  - llamaindex@0.4.11
+
+## 0.0.36
+
+### Patch Changes
+
+- Updated dependencies [7dce3d2]
+  - llamaindex@0.4.10
+
+## 0.0.35
+
+### Patch Changes
+
+- Updated dependencies [3a96a48]
+  - llamaindex@0.4.9
+
+## 0.0.34
+
+### Patch Changes
+
+- Updated dependencies [83ebdfb]
+  - llamaindex@0.4.8
+
+## 0.0.33
+
+### Patch Changes
+
+- Updated dependencies [41fe871]
+- Updated dependencies [321c39d]
+- Updated dependencies [f7f1af0]
+  - llamaindex@0.4.7
+
 ## 0.0.32
 
 ### Patch Changes

apps/docs/docs/getting_started/concepts.md

@@ -62,7 +62,7 @@ These building blocks can be customized to reflect ranking preferences, as well
 
 [**Retrievers**](../modules/retriever.md):
 A retriever defines how to efficiently retrieve relevant context from a knowledge base (i.e. index) when given a query.
-The specific retrieval logic differs for difference indices, the most popular being dense retrieval against a vector index.
+The specific retrieval logic differs for different indices, the most popular being dense retrieval against a vector index.
 
 [**Response Synthesizers**](../modules/response_synthesizer.md):
 A response synthesizer generates a response from an LLM, using a user query and a given set of retrieved text chunks.

apps/docs/docs/modules/data_loaders/discord.mdx

@@ -0,0 +1,34 @@
+import CodeBlock from "@theme/CodeBlock";
+import CodeSource from "!raw-loader!../../../../../examples/readers/src/discord";
+
+# DiscordReader
+
+DiscordReader is a simple data loader that reads all messages in a given Discord channel and returns them as Document objects.
+It uses the [@discordjs/rest](https://github.com/discordjs/discord.js/tree/main/packages/rest) library to fetch the messages.
+
+## Usage
+
+First step is to create a Discord Application and generating a bot token [here](https://discord.com/developers/applications).
+In your Discord Application, go to the `OAuth2` tab and generate an invite URL by selecting `bot` and click `Read Messages/View Channels` as wells as `Read Message History`.
+This will invite the bot with the necessary permissions to read messages.
+Copy the URL in your browser and select the server you want your bot to join.
+
+<CodeBlock language="ts">{CodeSource}</CodeBlock>
+
+### Params
+
+#### DiscordReader()
+
+- `discordToken?`: The Discord bot token.
+- `makeRequest?`: Optionally provide a custom request function for edge environments, e.g. `fetch`. See discord.js for more info.
+
+#### DiscordReader.loadData
+
+- `channelIDs`: The ID(s) of discord channels as an array of strings.
+- `limit?`: Optionally limit the number of messages to read
+- `additionalInfo?`: An optional flag to include embedded messages and attachment urls in the document.
+- `oldestFirst?`: An optional flag to return the oldest messages first.
+
+## API Reference
+
+- [DiscordReader](../../api/classes/DiscordReader.md)

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

@@ -27,23 +27,28 @@ They can be divided into two groups.
 
 - `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`
+- `maxTimeout` is the maximum timeout 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.
+- `language` primarily 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`.
+- `doNotUnrollColumns?` Optional. Set to true to keep the text according to document layout. Reduce reconstruction accuracy, and LLMs/embeddings performances in most cases.
+- `pageSeparator?` Optional. The page separator to use. Defaults is `\\n---\\n`.
+- `gpt4oMode` Deprecated. Use vendorMultimodal params. Set to true to use GPT-4o to extract content. Default is `false`.
+- `gpt4oApiKey?` Deprecated. Use vendorMultimodal params. 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`.
+- `boundingBox?` Optional. Specify an area of the document to parse. Expects the bounding box margins as a string in clockwise order, e.g. `boundingBox = "0.1,0,0,0"` to not parse the top 10% of the document.
+- `targetPages?` Optional. Specify which pages to parse by specifying them as a comma-separated list. First page is `0`.
+- `useVendorMultimodalModel` set to true to use a multimodal model. Default is `false`.
+- `vendorMultimodalModel?` Optional. Specify which multimodal model to use. Default is GPT4o. See [here](https://docs.cloud.llamaindex.ai/llamaparse/features/multimodal) for a list of available models and cost.
+- `vendorMultimodalApiKey?` Optional. Set the multimodal model API key. Can also be set in the environment variable `LLAMA_CLOUD_VENDOR_MULTIMODAL_API_KEY`.
 - `numWorkers` as in the python version, is set in `SimpleDirectoryReader`. Default is 1.
 
 ### LlamaParse with SimpleDirectoryReader

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

@@ -8,7 +8,7 @@ In JSON mode, LlamaParse will return a data structure representing the parsed ob
 
 ## 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`.
+For Json mode, you need to use `loadJson`. The `resultType` is automatically set with this method.
 More information about indexing the results on the next page.
 
 ```ts

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

@@ -0,0 +1,100 @@
+# MixedbreadAI
+
+Welcome to the mixedbread embeddings guide! This guide will help you use the mixedbread ai's API to generate embeddings for your text documents, ensuring you get the most relevant information, just like picking the freshest bread from the bakery.
+
+To find out more about the latest features, updates, and available models, visit [mixedbread.ai](https://mixedbread-ai.com/).
+
+## Table of Contents
+
+1. [Setup](#setup)
+2. [Usage with LlamaIndex](#integration-with-llamaindex)
+3. [Embeddings with Custom Parameters](#embeddings-with-custom-parameters)
+
+## Setup
+
+First, you will need to install the `llamaindex` package.
+
+```bash
+pnpm install llamaindex
+```
+
+Next, sign up for an API key at [mixedbread.ai](https://mixedbread.ai/). Once you have your API key, you can import the necessary modules and create a new instance of the `MixedbreadAIEmbeddings` class.
+
+```ts
+import { MixedbreadAIEmbeddings, Document, Settings } from "llamaindex";
+```
+
+## Usage with LlamaIndex
+
+This section will guide you through integrating mixedbread embeddings with LlamaIndex for more advanced usage.
+
+### Step 1: 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, like a variety of breads in a bakery.
+
+```ts
+Settings.embedModel = new MixedbreadAIEmbeddings({
+  apiKey: "<MIXEDBREAD_API_KEY>",
+  model: "mixedbread-ai/mxbai-embed-large-v1",
+});
+
+const document = new Document({
+  text: "The true source of happiness.",
+  id_: "bread",
+});
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+### Step 2: Create a Query Engine
+
+Combine the retriever and the embed model to create a query engine. This setup ensures that your queries are processed to provide the best results, like arranging the bread in the order of freshness and quality.
+
+Models can require prompts to generate embeddings for queries, in the 'mixedbread-ai/mxbai-embed-large-v1' model's case, the prompt is `Represent this sentence for searching relevant passages:`.
+
+```ts
+const queryEngine = index.asQueryEngine();
+
+const query =
+  "Represent this sentence for searching relevant passages: What is bread?";
+
+// Log the response
+const results = await queryEngine.query(query);
+console.log(results); // Serving up the freshest, most relevant results.
+```
+
+## Embeddings with Custom Parameters
+
+This section will guide you through generating embeddings with custom parameters and usage with f.e. matryoshka and binary embeddings.
+
+### Step 1: Create an Instance of MixedbreadAIEmbeddings
+
+Create a new instance of the `MixedbreadAIEmbeddings` class with custom parameters. For example, to use the `mixedbread-ai/mxbai-embed-large-v1` model with a batch size of 64, normalized embeddings, and binary encoding format:
+
+```ts
+const embeddings = new MixedbreadAIEmbeddings({
+  apiKey: "<MIXEDBREAD_API_KEY>",
+  model: "mixedbread-ai/mxbai-embed-large-v1",
+  batchSize: 64,
+  normalized: true,
+  dimensions: 512,
+  encodingFormat: MixedbreadAI.EncodingFormat.Binary,
+});
+```
+
+### Step 2: Define Texts
+
+Define the texts you want to generate embeddings for.
+
+```ts
+const texts = ["Bread is life", "Bread is love"];
+```
+
+### Step 3: Generate Embeddings
+
+Use the `embedDocuments` method to generate embeddings for the texts.
+
+```ts
+const result = await embeddings.embedDocuments(texts);
+console.log(result); // Perfectly customized embeddings, ready to serve.
+```

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

@@ -15,7 +15,7 @@ Settings.llm = new Bedrock({
 });
 ```
 
-Currently only supports Anthropic models:
+Currently only supports Anthropic and Meta models:
 
 ```ts
 ANTHROPIC_CLAUDE_INSTANT_1 = "anthropic.claude-instant-v1";
@@ -25,6 +25,13 @@ 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";
+META_LLAMA2_13B_CHAT = "meta.llama2-13b-chat-v1";
+META_LLAMA2_70B_CHAT = "meta.llama2-70b-chat-v1";
+META_LLAMA3_8B_INSTRUCT = "meta.llama3-8b-instruct-v1:0";
+META_LLAMA3_70B_INSTRUCT = "meta.llama3-70b-instruct-v1:0";
+META_LLAMA3_1_8B_INSTRUCT = "meta.llama3-1-8b-instruct-v1:0"; // available on us-west-2
+META_LLAMA3_1_70B_INSTRUCT = "meta.llama3-1-70b-instruct-v1:0"; // available on us-west-2
+META_LLAMA3_1_405B_INSTRUCT = "meta.llama3-1-405b-instruct-v1:0"; // preview only, available on us-west-2
 ```
 
 Sonnet, Haiku and Opus are multimodal, image_url only supports base64 data url format, e.g. `data:image/jpeg;base64,SGVsbG8sIFdvcmxkIQ==`

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

@@ -39,8 +39,9 @@ const index = await VectorStoreIndex.fromDocuments([document]);
 The default value for `similarityTopK` is 2. This means that only the most similar document will be returned. To retrieve more results, you can increase the value of `similarityTopK`.
 
 ```ts
-const retriever = index.asRetriever();
-retriever.similarityTopK = 5;
+const retriever = index.asRetriever({
+  similarityTopK: 5,
+});
 ```
 
 ## Create a new instance of the CohereRerank class

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

@@ -39,8 +39,9 @@ const index = await VectorStoreIndex.fromDocuments([document]);
 The default value for `similarityTopK` is 2. This means that only the most similar document will be returned. To retrieve more results, you can increase the value of `similarityTopK`.
 
 ```ts
-const retriever = index.asRetriever();
-retriever.similarityTopK = 5;
+const retriever = index.asRetriever({
+  similarityTopK: 5,
+});
 ```
 
 ## Create a new instance of the JinaAIReranker class

apps/docs/docs/modules/node_postprocessors/mixedbreadiai_reranker.md

@@ -0,0 +1,165 @@
+# MixedbreadAI
+
+Welcome to the mixedbread ai reranker guide! This guide will help you use mixedbread ai's API to rerank search query results, ensuring you get the most relevant information, just like picking the freshest bread from the bakery.
+
+To find out more about the latest features and updates, visit the [mixedbread.ai](https://mixedbread.ai/).
+
+## Table of Contents
+
+1. [Setup](#setup)
+2. [Usage with LlamaIndex](#integration-with-llamaindex)
+3. [Simple Reranking Guide](#simple-reranking-guide)
+4. [Reranking with Objects](#reranking-with-objects)
+
+## Setup
+
+First, you will need to install the `llamaindex` package.
+
+```bash
+pnpm install llamaindex
+```
+
+Next, sign up for an API key at [mixedbread.ai](https://mixedbread.ai/). Once you have your API key, you can import the necessary modules and create a new instance of the `MixedbreadAIReranker` class.
+
+```ts
+import {
+  MixedbreadAIReranker,
+  Document,
+  OpenAI,
+  VectorStoreIndex,
+  Settings,
+} from "llamaindex";
+```
+
+## Usage with LlamaIndex
+
+This section will guide you through integrating mixedbread's reranker with LlamaIndex.
+
+### Step 1: 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, like a variety of breads in a bakery.
+
+```ts
+const document = new Document({
+  text: "This is a sample document.",
+  id_: "sampleDoc",
+});
+
+Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });
+
+const index = await VectorStoreIndex.fromDocuments([document]);
+```
+
+### Step 2: Increase Similarity TopK
+
+The default value for `similarityTopK` is 2, which means only the most similar document will be returned. To get more results, like picking a variety of fresh breads, you can increase the value of `similarityTopK`.
+
+```ts
+const retriever = index.asRetriever({
+  similarityTopK: 5,
+});
+```
+
+### Step 3: Create a MixedbreadAIReranker Instance
+
+Create a new instance of the `MixedbreadAIReranker` class.
+
+```ts
+const nodePostprocessor = new MixedbreadAIReranker({
+  apiKey: "<MIXEDBREAD_API_KEY>",
+  topN: 4,
+});
+```
+
+### Step 4: Create a Query Engine
+
+Combine the retriever and node postprocessor to create a query engine. This setup ensures that your queries are processed and reranked to provide the best results, like arranging the bread in the order of freshness and quality.
+
+```ts
+const queryEngine = index.asQueryEngine({
+  retriever,
+  nodePostprocessors: [nodePostprocessor],
+});
+
+// Log the response
+const response = await queryEngine.query("Where did the author grow up?");
+console.log(response);
+```
+
+With mixedbread's Reranker, you're all set to serve up the most relevant and well-ordered results, just like a skilled baker arranging their best breads for eager customers. Enjoy the perfect blend of technology and culinary delight!
+
+## Simple Reranking Guide
+
+This section will guide you through a simple reranking process using mixedbread ai.
+
+### Step 1: Create an Instance of MixedbreadAIReranker
+
+Create a new instance of the `MixedbreadAIReranker` class, passing in your API key and the number of results you want to return. It's like setting up your bakery to offer a specific number of freshly baked items.
+
+```ts
+const reranker = new MixedbreadAIReranker({
+  apiKey: "<MIXEDBREAD_API_KEY>",
+  topN: 4,
+});
+```
+
+### Step 2: Define Nodes and Query
+
+Define the nodes (documents) you want to rerank and the query.
+
+```ts
+const nodes = [
+  { node: new BaseNode("To bake bread you need flour") },
+  { node: new BaseNode("To bake bread you need yeast") },
+];
+const query = "What do you need to bake bread?";
+```
+
+### Step 3: Perform Reranking
+
+Use the `postprocessNodes` method to rerank the nodes based on the query.
+
+```ts
+const result = await reranker.postprocessNodes(nodes, query);
+console.log(result); // Like pulling freshly baked nodes out of the oven.
+```
+
+## Reranking with Objects
+
+This section will guide you through reranking when working with objects.
+
+### Step 1: Create an Instance of MixedbreadAIReranker
+
+Create a new instance of the `MixedbreadAIReranker` class, just like before.
+
+```ts
+const reranker = new MixedbreadAIReranker({
+  apiKey: "<MIXEDBREAD_API_KEY>",
+  model: "mixedbread-ai/mxbai-rerank-large-v1",
+  topK: 5,
+  rankFields: ["title", "content"],
+  returnInput: true,
+  maxRetries: 5,
+});
+```
+
+### Step 2: Define Documents and Query
+
+Define the documents (objects) you want to rerank and the query.
+
+```ts
+const documents = [
+  { title: "Bread Recipe", content: "To bake bread you need flour" },
+  { title: "Bread Recipe", content: "To bake bread you need yeast" },
+];
+const query = "What do you need to bake bread?";
+```
+
+### Step 3: Perform Reranking
+
+Use the `rerank` method to reorder the documents based on the query.
+
+```ts
+const result = await reranker.rerank(documents, query);
+console.log(result); // Perfectly customized results, ready to serve.
+```

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

@@ -75,7 +75,7 @@ const queryEngine = index.asQueryEngine({
       {
         key: "dogId",
         value: "2",
-        filterType: "ExactMatch",
+        operator: "==",
       },
     ],
   },
@@ -88,6 +88,8 @@ const response = await queryEngine.query({
 console.log(response.toString());
 ```
 
+Besides using the equal operator (`==`), you can also use a whole set of different [operators](../../api/interfaces/MetadataFilter.md#operator) to filter your documents.
+
 ## Full Code
 
 ```ts
@@ -135,7 +137,7 @@ async function main() {
           {
             key: "dogId",
             value: "2",
-            filterType: "ExactMatch",
+            operator: "==",
           },
         ],
       },
@@ -156,3 +158,4 @@ main();
 
 - [VectorStoreIndex](../../api/classes/VectorStoreIndex.md)
 - [ChromaVectorStore](../../api/classes/ChromaVectorStore.md)
+- [MetadataFilter](../../api/interfaces/MetadataFilter.md)

apps/docs/docs/modules/retriever.md

@@ -7,8 +7,9 @@ sidebar_position: 5
 A retriever in LlamaIndex is what is used to fetch `Node`s from an index using a query string. Aa `VectorIndexRetriever` will fetch the top-k most similar nodes. Meanwhile, a `SummaryIndexRetriever` will fetch all nodes no matter the query.
 
 ```typescript
-const retriever = vector_index.asRetriever();
-retriever.similarityTopK = 3;
+const retriever = vectorIndex.asRetriever({
+  similarityTopK: 3,
+});
 
 // Fetch nodes!
 const nodesWithScore = await retriever.retrieve({ query: "query string" });

apps/docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.32",
+  "version": "0.0.50",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,29 +15,29 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.3.2",
-    "@docusaurus/remark-plugin-npm2yarn": "^3.3.2",
+    "@docusaurus/core": "3.4.0",
+    "@docusaurus/remark-plugin-npm2yarn": "3.4.0",
     "@llamaindex/examples": "workspace:*",
-    "@mdx-js/react": "^3.0.1",
-    "clsx": "^2.1.1",
+    "@mdx-js/react": "3.0.1",
+    "clsx": "2.1.1",
     "llamaindex": "workspace:*",
-    "postcss": "^8.4.38",
-    "prism-react-renderer": "^2.3.1",
-    "raw-loader": "^4.0.2",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "postcss": "8.4.39",
+    "prism-react-renderer": "2.3.1",
+    "raw-loader": "4.0.2",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.3.2",
-    "@docusaurus/preset-classic": "^3.3.2",
-    "@docusaurus/theme-classic": "^3.3.2",
-    "@docusaurus/types": "^3.3.2",
-    "@tsconfig/docusaurus": "^2.0.3",
+    "@docusaurus/module-type-aliases": "3.4.0",
+    "@docusaurus/preset-classic": "3.4.0",
+    "@docusaurus/theme-classic": "3.4.0",
+    "@docusaurus/types": "3.4.0",
+    "@tsconfig/docusaurus": "2.0.3",
     "@types/node": "^20.12.11",
-    "docusaurus-plugin-typedoc": "^1.0.1",
-    "typedoc": "^0.25.13",
-    "typedoc-plugin-markdown": "^4.0.1",
-    "typescript": "^5.5.2"
+    "docusaurus-plugin-typedoc": "1.0.3",
+    "typedoc": "0.26.4",
+    "typedoc-plugin-markdown": "4.1.2",
+    "typescript": "^5.5.3"
   },
   "browserslist": {
     "production": [

examples/CHANGELOG.md

@@ -1,5 +1,15 @@
 # examples
 
+## 0.0.7
+
+### Patch Changes
+
+- Updated dependencies [16ef5dd]
+- Updated dependencies [16ef5dd]
+- Updated dependencies [36ddec4]
+  - llamaindex@0.5.0
+  - @llamaindex/core@0.1.0
+
 ## 0.0.6
 
 ### Patch Changes

examples/README.md

@@ -9,7 +9,7 @@ make sure you have basic knowledge of the [LlamaIndexTS](https://ts.llamaindex.a
 # export your API key
 export OPENAI_API_KEY="sk-..."
 
-npx ts-node ./chatEngine.ts
+npx tsx ./chatEngine.ts
 ```
 
 ## Build your own RAG app

examples/agent/azure_dynamic_session.ts

@@ -0,0 +1,54 @@
+import "dotenv/config";
+
+import {
+  DefaultAzureCredential,
+  getBearerTokenProvider,
+} from "@azure/identity";
+import { AzureDynamicSessionTool, OpenAI, ReActAgent } from "llamaindex";
+
+async function main() {
+  const credential = new DefaultAzureCredential();
+  const azureADTokenProvider = getBearerTokenProvider(
+    credential,
+    "https://cognitiveservices.azure.com/.default",
+  );
+
+  const azure = {
+    azureADTokenProvider,
+    deployment: process.env.AZURE_OPENAI_DEPLOYMENT ?? "gpt-35-turbo",
+  };
+
+  // configure LLM model
+  const llm = new OpenAI({
+    azure,
+  });
+
+  const azureDynamicSession = new AzureDynamicSessionTool();
+
+  // Create an ReActAgent with the azure dynamic session tool
+  const agent = new ReActAgent({
+    llm,
+    tools: [azureDynamicSession],
+    // verbose: true,
+    systemPrompt: `You are a Python interpreter.
+      - You are given tasks to complete and you run python code to solve them.
+      - The python code runs by the python runtime. Every time you call $(interpreter) tool, the python code is executed in a separate cell. It's okay to make multiple calls to $(interpreter).
+      - You can run any python code you want in a secure environment.
+      - For images, return the full URL, not the base64 data.
+      - Return any image content as an HTML tag with the src attribute set to the URL of the image.`,
+  });
+
+  // Chat with the agent
+  const response = await agent.chat({
+    message:
+      "plot a chart of 5 random numbers and save it to /mnt/data/chart.png",
+    stream: false,
+  });
+
+  // Print the response
+  console.log({ response });
+}
+
+void main().then(() => {
+  console.log("Done");
+});

examples/anthropic/agent.ts

@@ -2,7 +2,7 @@ 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);
+  console.log("llm-tool-call", event.detail.toolCall);
 });
 
 const anthropic = new Anthropic({

examples/astradb/README.md

@@ -24,7 +24,7 @@ Here are two sample scripts which work well with the sample data in the Astra Po
 
 Loads and queries a simple vectorstore with some documents about Astra DB
 
-run `ts-node astradb/example`
+run `tsx astradb/example`
 
 ## Movie Reviews Example
 
@@ -32,10 +32,10 @@ run `ts-node astradb/example`
 
 This sample loads the same dataset of movie reviews as the Astra Portal sample dataset. (Feel free to load the data in your the Astra Data Explorer to compare)
 
-run `npx ts-node astradb/load`
+run `npx tsx astradb/load`
 
 ### Use RAG to Query the data
 
 Check out your data in the Astra Data Explorer and change the sample query as you see fit.
 
-run `npx ts-node astradb/query`
+run `npx tsx astradb/query`

examples/chatEngine.ts

@@ -16,8 +16,9 @@ Settings.chunkSize = 512;
 async function main() {
   const document = new Document({ text: essay });
   const index = await VectorStoreIndex.fromDocuments([document]);
-  const retriever = index.asRetriever();
-  retriever.similarityTopK = 5;
+  const retriever = index.asRetriever({
+    similarityTopK: 5,
+  });
   const chatEngine = new ContextChatEngine({ retriever });
   const rl = readline.createInterface({ input, output });
 

examples/chromadb/README.md

@@ -6,7 +6,7 @@ Export your OpenAI API Key using `export OPEN_API_KEY=insert your api key here`
 
 If you haven't installed chromadb, run `pip install chromadb`. Start the server using `chroma run`.
 
-Now, open a new terminal window and inside `examples`, run `pnpm dlx ts-node chromadb/test.ts`.
+Now, open a new terminal window and inside `examples`, run `pnpm dlx tsx chromadb/test.ts`.
 
 Here's the output for the input query `Tell me about Godfrey Cheshire's rating of La Sapienza.`:
 

examples/chromadb/preFilters.ts

@@ -40,7 +40,7 @@ async function main() {
           {
             key: "dogId",
             value: "2",
-            filterType: "ExactMatch",
+            operator: "==",
           },
         ],
       },

examples/cloud/README.md

@@ -21,7 +21,7 @@ export LLAMA_CLOUD_BASE_URL="https://api.staging.llamaindex.ai"
 This example is using the managed index named `test` from the project `default` to create a chat engine.
 
 ```shell
-pnpx ts-node cloud/chat.ts
+pnpx tsx cloud/chat.ts
 ```
 
 ## Query Engine
@@ -29,7 +29,7 @@ pnpx ts-node cloud/chat.ts
 This example shows how to use the managed index with a query engine.
 
 ```shell
-pnpx ts-node cloud/query.ts
+pnpx tsx cloud/query.ts
 ```
 
 ## Pipeline
@@ -37,5 +37,5 @@ pnpx ts-node cloud/query.ts
 This example shows how to create a managed index with a pipeline.
 
 ```shell
-pnpx ts-node cloud/pipeline.ts
+pnpx tsx cloud/pipeline.ts
 ```

examples/cloud/chat.ts

@@ -6,7 +6,7 @@ import { ContextChatEngine, LlamaCloudIndex } from "llamaindex";
 async function main() {
   const index = new LlamaCloudIndex({
     name: "test",
-    projectName: "default",
+    projectName: "Default",
     baseUrl: process.env.LLAMA_CLOUD_BASE_URL,
     apiKey: process.env.LLAMA_CLOUD_API_KEY,
   });
@@ -19,10 +19,10 @@ async function main() {
   while (true) {
     const query = await rl.question("User: ");
     const stream = await chatEngine.chat({ message: query, stream: true });
-    console.log();
     for await (const chunk of stream) {
       process.stdout.write(chunk.response);
     }
+    process.stdout.write("\n");
   }
 }
 

examples/longText.ts

@@ -1,17 +1,16 @@
 import {
   Document,
+  SentenceSplitter,
   Settings,
-  SimpleNodeParser,
   VectorStoreIndex,
 } from "llamaindex";
 
 export const STORAGE_DIR = "./data";
 
 // Update node parser
-Settings.nodeParser = new SimpleNodeParser({
+Settings.nodeParser = new SentenceSplitter({
   chunkSize: 512,
   chunkOverlap: 20,
-  splitLongSentences: true,
 });
 (async () => {
   // generate a document with a very long sentence (9000 words long)

examples/lowlevel.ts

@@ -27,11 +27,13 @@ import {
     },
   ];
 
-  const stream = await responseSynthesizer.synthesize({
-    query: "What age am I?",
-    nodesWithScore,
-    stream: true,
-  });
+  const stream = await responseSynthesizer.synthesize(
+    {
+      query: "What age am I?",
+      nodesWithScore,
+    },
+    true,
+  );
   for await (const chunk of stream) {
     process.stdout.write(chunk.response);
   }

examples/metadata-filter/milvus.ts

@@ -0,0 +1,40 @@
+import { MilvusVectorStore, VectorStoreIndex } from "llamaindex";
+
+const collectionName = "movie_reviews";
+
+async function main() {
+  try {
+    const milvus = new MilvusVectorStore({ collection: collectionName });
+    const index = await VectorStoreIndex.fromVectorStore(milvus);
+    const retriever = index.asRetriever({ similarityTopK: 20 });
+
+    console.log("\n=====\nQuerying the index with filters");
+    const queryEngineWithFilters = index.asQueryEngine({
+      retriever,
+      preFilters: {
+        filters: [
+          {
+            key: "document_id",
+            value: "./data/movie_reviews.csv_37",
+            operator: "==",
+          },
+          {
+            key: "document_id",
+            value: "./data/movie_reviews.csv_37",
+            operator: "!=",
+          },
+        ],
+        condition: "or",
+      },
+    });
+    const resultAfterFilter = await queryEngineWithFilters.query({
+      query: "Get all movie titles.",
+    });
+    console.log(`Query from ${resultAfterFilter.sourceNodes?.length} nodes`);
+    console.log(resultAfterFilter.response);
+  } catch (e) {
+    console.error(e);
+  }
+}
+
+void main();

examples/metadata-filter/simple.ts

@@ -0,0 +1,143 @@
+import {
+  Document,
+  Settings,
+  SimpleDocumentStore,
+  VectorStoreIndex,
+  storageContextFromDefaults,
+} from "llamaindex";
+
+Settings.callbackManager.on("retrieve-end", (event) => {
+  const { nodes } = event.detail;
+  console.log("Number of retrieved nodes:", nodes.length);
+});
+
+async function getDataSource() {
+  const docs = [
+    new Document({
+      text: "The dog is brown",
+      metadata: {
+        dogId: "1",
+        private: true,
+      },
+    }),
+    new Document({
+      text: "The dog is yellow",
+      metadata: {
+        dogId: "2",
+        private: false,
+      },
+    }),
+    new Document({
+      text: "The dog is red",
+      metadata: {
+        dogId: "3",
+        private: false,
+      },
+    }),
+  ];
+  const storageContext = await storageContextFromDefaults({
+    persistDir: "./cache",
+  });
+  const numberOfDocs = Object.keys(
+    (storageContext.docStore as SimpleDocumentStore).toDict(),
+  ).length;
+  if (numberOfDocs === 0) {
+    // Generate the data source if it's empty
+    return await VectorStoreIndex.fromDocuments(docs, {
+      storageContext,
+    });
+  }
+  return await VectorStoreIndex.init({
+    storageContext,
+  });
+}
+
+async function main() {
+  const index = await getDataSource();
+  console.log(
+    "=============\nQuerying index with no filters. The output should be any color.",
+  );
+  const queryEngineNoFilters = index.asQueryEngine({
+    similarityTopK: 3,
+  });
+  const noFilterResponse = await queryEngineNoFilters.query({
+    query: "What is the color of the dog?",
+  });
+  console.log("No filter response:", noFilterResponse.toString());
+
+  console.log(
+    "\n=============\nQuerying index with dogId 2 and private false. The output always should be red.",
+  );
+  const queryEngineEQ = index.asQueryEngine({
+    preFilters: {
+      filters: [
+        {
+          key: "private",
+          value: "false",
+          operator: "==",
+        },
+        {
+          key: "dogId",
+          value: "3",
+          operator: "==",
+        },
+      ],
+    },
+    similarityTopK: 3,
+  });
+  const responseEQ = await queryEngineEQ.query({
+    query: "What is the color of the dog?",
+  });
+  console.log("Filter with dogId 2 response:", responseEQ.toString());
+
+  console.log(
+    "\n=============\nQuerying index with dogId IN (1, 3). The output should be brown and red.",
+  );
+  const queryEngineIN = index.asQueryEngine({
+    preFilters: {
+      filters: [
+        {
+          key: "dogId",
+          value: ["1", "3"],
+          operator: "in",
+        },
+      ],
+    },
+    similarityTopK: 3,
+  });
+  const responseIN = await queryEngineIN.query({
+    query: "What is the color of the dog?",
+  });
+  console.log("Filter with dogId IN (1, 3) response:", responseIN.toString());
+
+  console.log(
+    "\n=============\nQuerying index with dogId IN (1, 3). The output should be any.",
+  );
+  const queryEngineOR = index.asQueryEngine({
+    preFilters: {
+      filters: [
+        {
+          key: "private",
+          value: "false",
+          operator: "==",
+        },
+        {
+          key: "dogId",
+          value: ["1", "3"],
+          operator: "in",
+        },
+      ],
+      condition: "or",
+    },
+    similarityTopK: 3,
+  });
+  const responseOR = await queryEngineOR.query({
+    query: "What is the color of the dog?",
+  });
+  console.log(
+    "Filter with dogId with OR operator response:",
+    responseOR.toString(),
+  );
+}
+
+void main();

examples/milvus/README.md

@@ -25,10 +25,10 @@ Here are two sample scripts which work with loading and querying data from a Mil
 
 This sample loads the same dataset of movie reviews as sample dataset. You can install https://github.com/zilliztech/attu to inspect the loaded data.
 
-run `npx ts-node milvus/load`
+run `npx tsx milvus/load`
 
 ## Use RAG to Query the data
 
 Check out your data in Attu and change the sample query as you see fit.
 
-run `npx ts-node milvus/query`
+run `npx tsx milvus/query`

examples/mongodb/README.md

@@ -34,7 +34,7 @@ MONGODB_COLLECTION=tiny_tweets_collection
 You are now ready to import our ready-made data set into Mongo. This is the file `tinytweets.json`, a selection of approximately 1000 tweets from @seldo on Twitter in mid-2019. With your environment set up you can do this by running
 
 ```
-npx ts-node mongodb/1_import.ts
+npx tsx mongodb/1_import.ts
 ```
 
 If you don't want to use tweets, you can replace `json_file` with any other array of JSON objects, but you will need to modify some code later to make sure the correct field gets indexed. There is no LlamaIndex-specific code here; you can load your data into Mongo any way you want to.
@@ -59,7 +59,7 @@ MONGODB_VECTOR_INDEX=tiny_tweets_vector_index
 If the data you're indexing is the tweets we gave you, you're ready to go:
 
 ```bash
-npx ts-node mongodb/2_load_and_index.ts
+npx tsx mongodb/2_load_and_index.ts
 ```
 
 > Note: this script is running a couple of minutes and currently doesn't show any progress.
@@ -112,7 +112,7 @@ Now you're ready to query your data!
 You can do this by running
 
 ```bash
-npx ts-node mongodb/3_query.ts
+npx tsx mongodb/3_query.ts
 ```
 
 This sets up a connection to Atlas just like `2_load_and_index.ts` did, then it creates a [query engine](https://docs.llamaindex.ai/en/stable/understanding/querying/querying.html#getting-started) and runs a query against it.

examples/multimodal/context.ts

@@ -4,7 +4,6 @@ import {
   NodeWithScore,
   ObjectType,
   OpenAI,
-  RetrievalEndEvent,
   Settings,
   VectorStoreIndex,
 } from "llamaindex";
@@ -18,8 +17,8 @@ Settings.chunkOverlap = 20;
 Settings.llm = new OpenAI({ model: "gpt-4-turbo", maxTokens: 512 });
 
 // Update callbackManager
-Settings.callbackManager.on("retrieve-end", (event: RetrievalEndEvent) => {
-  const { nodes, query } = event.detail.payload;
+Settings.callbackManager.on("retrieve-end", (event) => {
+  const { nodes, query } = event.detail;
   const imageNodes = nodes.filter(
     (node: NodeWithScore) => node.node.type === ObjectType.IMAGE_DOCUMENT,
   );

examples/multimodal/jina.ts

@@ -0,0 +1,83 @@
+import {
+  ImageDocument,
+  JinaAIEmbedding,
+  similarity,
+  SimilarityType,
+  SimpleDirectoryReader,
+} from "llamaindex";
+import path from "path";
+
+async function main() {
+  const jina = new JinaAIEmbedding({
+    model: "jina-clip-v1",
+  });
+
+  // Get text embeddings
+  const text1 = "a car";
+  const textEmbedding1 = await jina.getTextEmbedding(text1);
+  const text2 = "a football match";
+  const textEmbedding2 = await jina.getTextEmbedding(text2);
+
+  // Get image embedding
+  const image =
+    "https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/football-match.jpg";
+  const imageEmbedding = await jina.getImageEmbedding(image);
+
+  // Calc similarity between text and image
+  const sim1 = similarity(
+    textEmbedding1,
+    imageEmbedding,
+    SimilarityType.DEFAULT,
+  );
+  const sim2 = similarity(
+    textEmbedding2,
+    imageEmbedding,
+    SimilarityType.DEFAULT,
+  );
+
+  console.log(`Similarity between "${text1}" and the image is ${sim1}`);
+  console.log(`Similarity between "${text2}" and the image is ${sim2}`);
+
+  // Get multiple text embeddings
+  const textEmbeddings = await jina.getTextEmbeddings([text1, text2]);
+  const sim3 = similarity(
+    textEmbeddings[0],
+    textEmbeddings[1],
+    SimilarityType.DEFAULT,
+  );
+  console.log(
+    `Similarity between the two texts "${text1}" and "${text2}" is ${sim3}`,
+  );
+
+  // Get multiple image embeddings
+  const catImg1 =
+    "https://i.pinimg.com/600x315/21/48/7e/21487e8e0970dd366dafaed6ab25d8d8.jpg";
+  const catImg2 =
+    "https://i.pinimg.com/736x/c9/f2/3e/c9f23e212529f13f19bad5602d84b78b.jpg";
+  const imageEmbeddings = await jina.getImageEmbeddings([catImg1, catImg2]);
+  const sim4 = similarity(
+    imageEmbeddings[0],
+    imageEmbeddings[1],
+    SimilarityType.DEFAULT,
+  );
+  console.log(`Similarity between the two online cat images is ${sim4}`);
+
+  // Get image embeddings from multiple local files
+  const documents = await new SimpleDirectoryReader().loadData({
+    directoryPath: path.join("multimodal", "data"),
+  });
+  const localImages = documents
+    .filter((doc) => doc instanceof ImageDocument)
+    .slice(0, 2); // Get only the first two images
+  const localImageEmbeddings = await jina.getImageEmbeddings(
+    localImages.map((doc) => (doc as ImageDocument).image),
+  );
+  const sim5 = similarity(
+    localImageEmbeddings[0],
+    localImageEmbeddings[1],
+    SimilarityType.DEFAULT,
+  );
+  console.log(`Similarity between the two local images is ${sim5}`);
+}
+
+void main();

examples/multimodal/rag.ts

@@ -1,7 +1,6 @@
 import {
   MultiModalResponseSynthesizer,
   OpenAI,
-  RetrievalEndEvent,
   Settings,
   VectorStoreIndex,
 } from "llamaindex";
@@ -15,8 +14,8 @@ Settings.chunkOverlap = 20;
 Settings.llm = new OpenAI({ model: "gpt-4-turbo", maxTokens: 512 });
 
 // Update callbackManager
-Settings.callbackManager.on("retrieve-end", (event: RetrievalEndEvent) => {
-  const { nodes, query } = event.detail.payload;
+Settings.callbackManager.on("retrieve-end", (event) => {
+  const { nodes, query } = event.detail;
   console.log(`Retrieved ${nodes.length} nodes for query: ${query}`);
 });
 

examples/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@llamaindex/examples",
   "private": true,
-  "version": "0.0.6",
+  "version": "0.0.7",
   "dependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
+    "@azure/identity": "^4.2.1",
     "@datastax/astra-db-ts": "^1.2.1",
+    "@llamaindex/core": "^0.1.0",
     "@notionhq/client": "^2.2.15",
     "@pinecone-database/pinecone": "^2.2.2",
-    "@zilliz/milvus2-sdk-node": "^2.4.2",
+    "@zilliz/milvus2-sdk-node": "^2.4.4",
     "chromadb": "^1.8.1",
     "commander": "^12.1.0",
     "dotenv": "^16.4.5",
     "js-tiktoken": "^1.0.12",
-    "llamaindex": "^0.4.3",
+    "llamaindex": "^0.5.0",
     "mongodb": "^6.7.0",
     "pathe": "^1.1.2"
   },
   "devDependencies": {
     "@types/node": "^20.14.1",
-    "ts-node": "^10.9.2",
     "tsx": "^4.15.6",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.3"
   },
   "scripts": {
     "lint": "eslint ."

examples/pg-vector-store/README.md

@@ -37,7 +37,7 @@ Read and follow the instructions in the README.md file located one directory up
 
 To import documents and save the embedding vectors to your database:
 
-> `npx ts-node pg-vector-store/load-docs.ts data`
+> `npx tsx pg-vector-store/load-docs.ts data`
 
 where data is the directory containing your input files. Using the `data` directory in the example above will read all of the files in that directory using the LlamaIndexTS default readers for each file type.
 
@@ -45,6 +45,6 @@ where data is the directory containing your input files. Using the `data` direct
 
 To query using the resulting vector store:
 
-> `npx ts-node pg-vector-store/query.ts`
+> `npx tsx pg-vector-store/query.ts`
 
 The script will prompt for a question, then process and present the answer using the PGVectorStore data and your OpenAI API key. It will continue to prompt until you enter `q`, `quit` or `exit` as the next query.

examples/pinecone-vector-store/README.md

@@ -19,7 +19,7 @@ Read and follow the instructions in the README.md file located one directory up
 
 To import documents and save the embedding vectors to your database:
 
-> `npx ts-node pinecone-vector-store/load-docs.ts data`
+> `npx tsx pinecone-vector-store/load-docs.ts data`
 
 where data is the directory containing your input files. Using the _data_ directory in the example above will read all of the files in that directory using the llamaindexTS default readers for each file type.
 
@@ -29,6 +29,6 @@ where data is the directory containing your input files. Using the _data_ direct
 
 To query using the resulting vector store:
 
-> `npx ts-node pinecone-vector-store/query.ts`
+> `npx tsx pinecone-vector-store/query.ts`
 
 The script will prompt for a question, then process and present the answer using the PineconeVectorStore data and your OpenAI API key. It will continue to prompt until you enter `q`, `quit` or `exit` as the next query.

examples/qdrantdb/README.md

@@ -8,4 +8,4 @@ Add your OpenAI API Key into a file called `.env` in the parent folder of this d
 OPEN_API_KEY=sk-you-key
 ```
 
-Now, open a new terminal window and inside `examples`, run `npx ts-node qdrantdb/preFilters.ts`.
+Now, open a new terminal window and inside `examples`, run `npx tsx qdrantdb/preFilters.ts`.

examples/qdrantdb/preFilters.ts

@@ -1,8 +1,8 @@
 import * as dotenv from "dotenv";
 import {
-  CallbackManager,
   Document,
   MetadataMode,
+  NodeWithScore,
   QdrantVectorStore,
   Settings,
   VectorStoreIndex,
@@ -10,13 +10,12 @@ import {
 } from "llamaindex";
 
 // Update callback manager
-Settings.callbackManager = new CallbackManager({
-  onRetrieve: (data) => {
-    console.log(
-      "The retrieved nodes are:",
-      data.nodes.map((node) => node.node.getContent(MetadataMode.NONE)),
-    );
-  },
+Settings.callbackManager.on("retrieve-end", (event) => {
+  const { nodes } = event.detail;
+  console.log(
+    "The retrieved nodes are:",
+    nodes.map((node: NodeWithScore) => node.node.getContent(MetadataMode.NONE)),
+  );
 });
 
 // Load environment variables from local .env file
@@ -65,7 +64,7 @@ async function main() {
           {
             key: "dogId",
             value: "2",
-            filterType: "ExactMatch",
+            operator: "==",
           },
         ],
       },

examples/readers/package.json

@@ -11,8 +11,10 @@
     "start:pdf": "node --import tsx ./src/pdf.ts",
     "start:llamaparse": "node --import tsx ./src/llamaparse.ts",
     "start:notion": "node --import tsx ./src/notion.ts",
+    "start:assemblyai": "node --import tsx ./src/assemblyai.ts",
     "start:llamaparse-dir": "node --import tsx ./src/simple-directory-reader-with-llamaparse.ts",
-    "start:llamaparse-json": "node --import tsx ./src/llamaparse-json.ts"
+    "start:llamaparse-json": "node --import tsx ./src/llamaparse-json.ts",
+    "start:discord": "node --import tsx ./src/discord.ts"
   },
   "dependencies": {
     "llamaindex": "*"
@@ -20,6 +22,6 @@
   "devDependencies": {
     "@types/node": "^20.12.11",
     "tsx": "^4.15.6",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.3"
   }
 }

examples/readers/src/discord.ts

@@ -0,0 +1,20 @@
+import { DiscordReader } from "llamaindex";
+
+async function main() {
+  // Create an instance of the DiscordReader. Set token here or DISCORD_TOKEN environment variable
+  const discordReader = new DiscordReader();
+
+  // Specify the channel IDs you want to read messages from as an arry of strings
+  const channelIds = ["721374320794009630", "719596376261918720"];
+
+  // Specify the number of messages to fetch per channel
+  const limit = 10;
+
+  // Load messages from the specified channel
+  const messages = await discordReader.loadData(channelIds, limit, true);
+
+  // Print out the messages
+  console.log(messages);
+}
+
+main().catch(console.error);

examples/recipes/cost-analysis.ts

@@ -1,7 +1,7 @@
+import { extractText } from "@llamaindex/core/utils";
 import { encodingForModel } from "js-tiktoken";
-import { ChatMessage, OpenAI, type LLMStartEvent } from "llamaindex";
+import { ChatMessage, OpenAI } from "llamaindex";
 import { Settings } from "llamaindex/Settings";
-import { extractText } from "llamaindex/llm/utils";
 
 const encoding = encodingForModel("gpt-4-0125-preview");
 
@@ -12,8 +12,8 @@ const llm = new OpenAI({
 
 let tokenCount = 0;
 
-Settings.callbackManager.on("llm-start", (event: LLMStartEvent) => {
-  const { messages } = event.detail.payload;
+Settings.callbackManager.on("llm-start", (event) => {
+  const { messages } = event.detail;
   messages.reduce((count: number, message: ChatMessage) => {
     return count + encoding.encode(extractText(message.content)).length;
   }, 0);
@@ -24,7 +24,7 @@ Settings.callbackManager.on("llm-start", (event: LLMStartEvent) => {
 });
 
 Settings.callbackManager.on("llm-stream", (event) => {
-  const { chunk } = event.detail.payload;
+  const { chunk } = event.detail;
   const { delta } = chunk;
   tokenCount += encoding.encode(extractText(delta)).length;
   if (tokenCount > 20) {

examples/rerankers/CohereReranker.ts

@@ -15,9 +15,9 @@ async function main() {
 
   const index = await VectorStoreIndex.fromDocuments([document]);
 
-  const retriever = index.asRetriever();
-
-  retriever.similarityTopK = 5;
+  const retriever = index.asRetriever({
+    similarityTopK: 5,
+  });
 
   const nodePostprocessor = new CohereRerank({
     apiKey: "<COHERE_API_KEY>",

examples/split.ts

@@ -8,7 +8,7 @@ async function main() {
 
   const textSplitter = new SentenceSplitter();
 
-  const chunks = textSplitter.splitTextWithOverlaps(essay);
+  const chunks = textSplitter.splitText(essay);
 
   console.log(chunks);
 }

examples/vectorIndexCustomize.ts

@@ -18,8 +18,9 @@ async function main() {
 
   const index = await VectorStoreIndex.fromDocuments([document]);
 
-  const retriever = index.asRetriever();
-  retriever.similarityTopK = 5;
+  const retriever = index.asRetriever({
+    similarityTopK: 5,
+  });
   const nodePostprocessor = new SimilarityPostprocessor({
     similarityCutoff: 0.7,
   });

package.json

@@ -21,27 +21,24 @@
     "@changesets/cli": "^2.27.5",
     "@typescript-eslint/eslint-plugin": "^7.13.1",
     "eslint": "^8.57.0",
-    "eslint-config-next": "^14.2.4",
+    "eslint-config-next": "^14.2.5",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-turbo": "^2.0.5",
-    "eslint-plugin-react": "7.34.1",
+    "eslint-plugin-react": "7.34.3",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.7",
     "madge": "^7.0.0",
     "prettier": "^3.3.2",
-    "prettier-plugin-organize-imports": "^3.2.4",
+    "prettier-plugin-organize-imports": "^4.0.0",
     "turbo": "^2.0.5",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.3"
   },
-  "packageManager": "pnpm@9.4.0",
+  "packageManager": "pnpm@9.5.0",
   "pnpm": {
     "overrides": {
       "trim": "1.0.1",
       "@babel/traverse": "7.23.2",
       "protobufjs": "7.2.6"
-    },
-    "patchedDependencies": {
-      "bunchee@5.2.1": "patches/bunchee@5.2.1.patch"
     }
   },
   "lint-staged": {

packages/autotool/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @llamaindex/autotool
 
+## 2.0.0
+
+### Patch Changes
+
+- Updated dependencies [16ef5dd]
+- Updated dependencies [16ef5dd]
+- Updated dependencies [36ddec4]
+  - llamaindex@0.5.0
+
 ## 1.0.0
 
 ### Patch Changes

packages/autotool/examples/01_node/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@llamaindex/autotool": "workspace:*",
     "llamaindex": "workspace:*",
-    "openai": "^4.52.0"
+    "openai": "^4.52.5"
   },
   "devDependencies": {
     "tsx": "^4.15.6"

packages/autotool/examples/02_nextjs/CHANGELOG.md

@@ -1,5 +1,160 @@
 # @llamaindex/autotool-02-next-example
 
+## 0.1.34
+
+### Patch Changes
+
+- Updated dependencies [15962b3]
+  - llamaindex@0.5.9
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.33
+
+### Patch Changes
+
+- Updated dependencies [3d5ba08]
+- Updated dependencies [d917cdc]
+  - llamaindex@0.5.8
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.32
+
+### Patch Changes
+
+- Updated dependencies [ec59acd]
+  - llamaindex@0.5.7
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.31
+
+### Patch Changes
+
+- Updated dependencies [2562244]
+- Updated dependencies [325aa51]
+- Updated dependencies [ab700ea]
+- Updated dependencies [92f0782]
+- Updated dependencies [6cf6ae6]
+- Updated dependencies [b7cfe5b]
+  - llamaindex@0.5.6
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.30
+
+### Patch Changes
+
+- Updated dependencies [b974eea]
+  - llamaindex@0.5.5
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.29
+
+### Patch Changes
+
+- Updated dependencies [1a65ead]
+  - llamaindex@0.5.4
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.28
+
+### Patch Changes
+
+- Updated dependencies [9bbbc67]
+- Updated dependencies [b3681bf]
+  - llamaindex@0.5.3
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.27
+
+### Patch Changes
+
+- llamaindex@0.5.2
+- @llamaindex/autotool@2.0.0
+
+## 0.1.26
+
+### Patch Changes
+
+- Updated dependencies [2774681]
+- Updated dependencies [a0f424e]
+  - llamaindex@0.5.1
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.25
+
+### Patch Changes
+
+- Updated dependencies [16ef5dd]
+- Updated dependencies [16ef5dd]
+- Updated dependencies [36ddec4]
+  - llamaindex@0.5.0
+  - @llamaindex/autotool@2.0.0
+
+## 0.1.24
+
+### Patch Changes
+
+- llamaindex@0.4.14
+- @llamaindex/autotool@1.0.0
+
+## 0.1.23
+
+### Patch Changes
+
+- Updated dependencies [e8f8bea]
+- Updated dependencies [304484b]
+  - llamaindex@0.4.13
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.22
+
+### Patch Changes
+
+- Updated dependencies [f326ab8]
+  - llamaindex@0.4.12
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.21
+
+### Patch Changes
+
+- Updated dependencies [8bf5b4a]
+  - llamaindex@0.4.11
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.20
+
+### Patch Changes
+
+- Updated dependencies [7dce3d2]
+  - llamaindex@0.4.10
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.19
+
+### Patch Changes
+
+- Updated dependencies [3a96a48]
+  - llamaindex@0.4.9
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.18
+
+### Patch Changes
+
+- Updated dependencies [83ebdfb]
+  - llamaindex@0.4.8
+  - @llamaindex/autotool@1.0.0
+
+## 0.1.17
+
+### Patch Changes
+
+- Updated dependencies [41fe871]
+- Updated dependencies [321c39d]
+- Updated dependencies [f7f1af0]
+  - llamaindex@0.4.7
+  - @llamaindex/autotool@1.0.0
+
 ## 0.1.16
 
 ### Patch Changes

packages/autotool/examples/02_nextjs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/autotool-02-next-example",
   "private": true,
-  "version": "0.1.16",
+  "version": "0.1.34",
   "scripts": {
     "dev": "next dev",
     "build": "next build",
@@ -14,7 +14,7 @@
     "class-variance-authority": "^0.7.0",
     "dotenv": "^16.3.1",
     "llamaindex": "workspace:*",
-    "lucide-react": "^0.378.0",
+    "lucide-react": "^0.407.0",
     "next": "14.3.0-canary.51",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -32,6 +32,6 @@
     "cross-env": "^7.0.3",
     "postcss": "^8.4.32",
     "tailwindcss": "^3.4.4",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.3"
   }
 }

packages/autotool/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/autotool",
   "type": "module",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "auto transpile your JS function to LLM Agent compatible",
   "files": [
     "dist",
@@ -47,11 +47,11 @@
   "dependencies": {
     "@swc/core": "^1.6.3",
     "jotai": "^2.8.3",
-    "typedoc": "^0.25.13",
+    "typedoc": "^0.26.4",
     "unplugin": "^1.10.1"
   },
   "peerDependencies": {
-    "llamaindex": "^0.4.6",
+    "llamaindex": "^0.5.9",
     "openai": "^4",
     "typescript": "^4"
   },
@@ -70,13 +70,13 @@
     "@swc/types": "^0.1.8",
     "@types/json-schema": "^7.0.15",
     "@types/node": "^20.12.11",
-    "bunchee": "^5.2.1",
+    "bunchee": "5.3.0-beta.0",
     "llamaindex": "workspace:*",
-    "next": "14.2.3",
+    "next": "14.2.5",
     "rollup": "^4.18.0",
     "tsx": "^4.15.6",
-    "typescript": "^5.5.2",
-    "vitest": "^1.6.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.2",
     "webpack": "^5.92.1"
   }
 }

packages/cloud/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @llamaindex/cloud
+
+## 0.2.0
+
+### Minor Changes
+
+- 3ed6acc: feat: cloud api change
+
+## 0.1.4
+
+### Patch Changes
+
+- 36ddec4: fix: typo in custom page separator parameter for LlamaParse
+
+## 0.1.3
+
+### Patch Changes
+
+- 1c444d5: feat(cloud): update openapi.json
+
+## 0.1.2
+
+### Patch Changes
+
+- f326ab8: chore: bump version
+
+## 0.1.1
+
+### Patch Changes
+
+- 321c39d: fix: generate api as class

packages/cloud/README.md

@@ -5,7 +5,7 @@
 ## Usage
 
 ```ts
-import { OpenAPI, Service } from "@llamaindex/cloud/api";
+import { OpenAPI } from "@llamaindex/cloud/api";
 OpenAPI.TOKEN = "YOUR_API_KEY";
 OpenAPI.BASE = "https://api.cloud.llamaindex.ai/";
 // ...

packages/cloud/openapi-ts.config.ts

@@ -9,6 +9,9 @@ export default defineConfig({
     format: "prettier",
     lint: "eslint",
   },
+  services: {
+    asClass: true,
+  },
   types: {
     enums: "javascript",
   },

packages/cloud/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/cloud",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "license": "MIT",
   "scripts": {
@@ -35,6 +35,6 @@
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.48.0",
-    "bunchee": "^5.2.1"
+    "bunchee": "5.3.0-beta.0"
   }
 }

packages/cloud/src/api.ts

@@ -1,4 +1 @@
-import * as Service from "./client/services.gen";
-
 export * from "./client";
-export { Service };

packages/community/CHANGELOG.md

@@ -1,5 +1,108 @@
 # @llamaindex/community
 
+## 0.0.24
+
+### Patch Changes
+
+- 3d9a802: feat: added llama 3.1
+- Updated dependencies [15962b3]
+  - @llamaindex/core@0.1.4
+
+## 0.0.23
+
+### Patch Changes
+
+- Updated dependencies [6cf6ae6]
+  - @llamaindex/core@0.1.3
+
+## 0.0.22
+
+### Patch Changes
+
+- Updated dependencies [b974eea]
+  - @llamaindex/core@0.1.2
+
+## 0.0.21
+
+### Patch Changes
+
+- Updated dependencies [b3681bf]
+  - @llamaindex/core@0.1.1
+
+## 0.0.20
+
+### Patch Changes
+
+- 56746c2: fix: llama3 patched to handle empty content (can happen with system) and added max tokens export
+
+## 0.0.19
+
+### Patch Changes
+
+- 16ef5dd: refactor: depends on core pacakge instead of llamaindex
+- Updated dependencies [16ef5dd]
+- Updated dependencies [16ef5dd]
+  - @llamaindex/core@0.1.0
+
+## 0.0.18
+
+### Patch Changes
+
+- llamaindex@0.4.14
+
+## 0.0.17
+
+### Patch Changes
+
+- Updated dependencies [e8f8bea]
+- Updated dependencies [304484b]
+  - llamaindex@0.4.13
+
+## 0.0.16
+
+### Patch Changes
+
+- f326ab8: chore: bump version
+- Updated dependencies [f326ab8]
+  - llamaindex@0.4.12
+
+## 0.0.15
+
+### Patch Changes
+
+- Updated dependencies [8bf5b4a]
+  - llamaindex@0.4.11
+
+## 0.0.14
+
+### Patch Changes
+
+- Updated dependencies [7dce3d2]
+  - llamaindex@0.4.10
+
+## 0.0.13
+
+### Patch Changes
+
+- Updated dependencies [3a96a48]
+  - llamaindex@0.4.9
+
+## 0.0.12
+
+### Patch Changes
+
+- Updated dependencies [83ebdfb]
+  - llamaindex@0.4.8
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies [41fe871]
+- Updated dependencies [321c39d]
+- Updated dependencies [f7f1af0]
+  - llamaindex@0.4.7
+
 ## 0.0.10
 
 ### Patch Changes

packages/community/README.md

@@ -5,6 +5,7 @@
 ## Current Features:
 
 - Bedrock support for the Anthropic Claude Models [usage](https://ts.llamaindex.ai/modules/llms/available_llms/bedrock)
+- Bedrock support for the Meta LLama 2, 3 and 3.1 Models [usage](https://ts.llamaindex.ai/modules/llms/available_llms/bedrock)
 
 ## LICENSE
 

packages/community/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/community",
   "description": "Community package for LlamaIndexTS",
-  "version": "0.0.10",
+  "version": "0.0.24",
   "type": "module",
   "types": "dist/type/index.d.ts",
   "main": "dist/cjs/index.js",
@@ -38,20 +38,15 @@
     "directory": "packages/community"
   },
   "scripts": {
-    "build": "rm -rf ./dist && pnpm run build:code && pnpm run build:type",
-    "build:code": "tsup",
-    "build:type": "tsc -p tsconfig.json",
-    "dev": "concurrently \"pnpm run build:esm --watch\" \"pnpm run build:cjs --watch\" \"pnpm run build:type --watch\""
+    "build": "bunchee",
+    "dev": "bunchee --watch"
   },
   "devDependencies": {
-    "@swc/cli": "^0.3.12",
-    "@swc/core": "^1.6.3",
-    "concurrently": "^8.2.2",
-    "tsup": "^8.1.0"
+    "@types/node": "^20.14.2",
+    "bunchee": "5.3.0-beta.0"
   },
   "dependencies": {
-    "@aws-sdk/client-bedrock-runtime": "^3.600.0",
-    "@types/node": "^20.14.2",
-    "llamaindex": "workspace:*"
+    "@aws-sdk/client-bedrock-runtime": "^3.613.0",
+    "@llamaindex/core": "workspace:*"
   }
 }

packages/community/src/index.ts

@@ -1 +1,5 @@
-export { BEDROCK_MODELS, Bedrock } from "./llm/bedrock/base.js";
+export {
+  BEDROCK_MODELS,
+  BEDROCK_MODEL_MAX_TOKENS,
+  Bedrock,
+} from "./llm/bedrock/base.js";

packages/community/src/llm/bedrock/base.ts

@@ -1,53 +1,35 @@
 import {
   BedrockRuntimeClient,
+  type BedrockRuntimeClientConfig,
   InvokeModelCommand,
   InvokeModelWithResponseStreamCommand,
-  ResponseStream,
-  type BedrockRuntimeClientConfig,
-  type InvokeModelCommandInput,
-  type InvokeModelWithResponseStreamCommandInput,
 } from "@aws-sdk/client-bedrock-runtime";
-import type {
-  BaseTool,
-  ChatMessage,
-  ChatResponse,
-  ChatResponseChunk,
-  CompletionResponse,
-  LLMChatParamsNonStreaming,
-  LLMChatParamsStreaming,
-  LLMCompletionParamsNonStreaming,
-  LLMCompletionParamsStreaming,
-  LLMMetadata,
-  PartialToolCall,
-  ToolCall,
-  ToolCallLLMMessageOptions,
-} from "llamaindex";
-import { ToolCallLLM, streamConverter, wrapLLMEvent } from "llamaindex";
-import type {
-  AnthropicNoneStreamingResponse,
-  AnthropicTextContent,
-  StreamEvent,
-  ToolBlock,
-  ToolChoice,
-} from "./types.js";
 import {
-  mapBaseToolsToAnthropicTools,
-  mapChatMessagesToAnthropicMessages,
-  mapMessageContentToMessageContentDetails,
-  toUtf8,
-} from "./utils.js";
-
-export type BedrockAdditionalChatOptions = { toolChoice: ToolChoice };
+  type ChatMessage,
+  type ChatResponse,
+  type CompletionResponse,
+  type LLMChatParamsNonStreaming,
+  type LLMChatParamsStreaming,
+  type LLMCompletionParamsNonStreaming,
+  type LLMCompletionParamsStreaming,
+  type LLMMetadata,
+  ToolCallLLM,
+  type ToolCallLLMMessageOptions,
+} from "@llamaindex/core/llms";
+import { streamConverter, wrapLLMEvent } from "@llamaindex/core/utils";
+import {
+  type BedrockAdditionalChatOptions,
+  type BedrockChatStreamResponse,
+  Provider,
+} from "./provider";
+import { PROVIDERS } from "./providers";
+import { mapMessageContentToMessageContentDetails } from "./utils.js";
 
 export type BedrockChatParamsStreaming = LLMChatParamsStreaming<
   BedrockAdditionalChatOptions,
   ToolCallLLMMessageOptions
 >;
 
-export type BedrockChatStreamResponse = AsyncIterable<
-  ChatResponseChunk<ToolCallLLMMessageOptions>
->;
-
 export type BedrockChatParamsNonStreaming = LLMChatParamsNonStreaming<
   BedrockAdditionalChatOptions,
   ToolCallLLMMessageOptions
@@ -78,6 +60,9 @@ export enum BEDROCK_MODELS {
   META_LLAMA2_70B_CHAT = "meta.llama2-70b-chat-v1",
   META_LLAMA3_8B_INSTRUCT = "meta.llama3-8b-instruct-v1:0",
   META_LLAMA3_70B_INSTRUCT = "meta.llama3-70b-instruct-v1:0",
+  META_LLAMA3_1_8B_INSTRUCT = "meta.llama3-1-8b-instruct-v1:0",
+  META_LLAMA3_1_70B_INSTRUCT = "meta.llama3-1-70b-instruct-v1:0",
+  META_LLAMA3_1_405B_INSTRUCT = "meta.llama3-1-405b-instruct-v1:0",
   MISTRAL_7B_INSTRUCT = "mistral.mistral-7b-instruct-v0:2",
   MISTRAL_MIXTRAL_7B_INSTRUCT = "mistral.mixtral-8x7b-instruct-v0:1",
   MISTRAL_MIXTRAL_LARGE_2402 = "mistral.mistral-large-2402-v1:0",
@@ -112,6 +97,9 @@ const CHAT_ONLY_MODELS = {
   [BEDROCK_MODELS.META_LLAMA2_70B_CHAT]: 4096,
   [BEDROCK_MODELS.META_LLAMA3_8B_INSTRUCT]: 8192,
   [BEDROCK_MODELS.META_LLAMA3_70B_INSTRUCT]: 8192,
+  [BEDROCK_MODELS.META_LLAMA3_1_8B_INSTRUCT]: 128000,
+  [BEDROCK_MODELS.META_LLAMA3_1_70B_INSTRUCT]: 128000,
+  [BEDROCK_MODELS.META_LLAMA3_1_405B_INSTRUCT]: 128000,
   [BEDROCK_MODELS.MISTRAL_7B_INSTRUCT]: 32000,
   [BEDROCK_MODELS.MISTRAL_MIXTRAL_7B_INSTRUCT]: 32000,
   [BEDROCK_MODELS.MISTRAL_MIXTRAL_LARGE_2402]: 32000,
@@ -139,6 +127,9 @@ export const STREAMING_MODELS = new Set([
   BEDROCK_MODELS.META_LLAMA2_70B_CHAT,
   BEDROCK_MODELS.META_LLAMA3_8B_INSTRUCT,
   BEDROCK_MODELS.META_LLAMA3_70B_INSTRUCT,
+  BEDROCK_MODELS.META_LLAMA3_1_8B_INSTRUCT,
+  BEDROCK_MODELS.META_LLAMA3_1_70B_INSTRUCT,
+  BEDROCK_MODELS.META_LLAMA3_1_405B_INSTRUCT,
   BEDROCK_MODELS.MISTRAL_7B_INSTRUCT,
   BEDROCK_MODELS.MISTRAL_MIXTRAL_7B_INSTRUCT,
   BEDROCK_MODELS.MISTRAL_MIXTRAL_LARGE_2402,
@@ -151,174 +142,6 @@ export const TOOL_CALL_MODELS = [
   BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_5_SONNET,
 ];
 
-abstract class Provider<ProviderStreamEvent extends {} = {}> {
-  abstract getTextFromResponse(response: Record<string, any>): string;
-
-  abstract getToolsFromResponse<T extends {} = {}>(
-    response: Record<string, any>,
-  ): T[];
-
-  getStreamingEventResponse(
-    response: Record<string, any>,
-  ): ProviderStreamEvent | undefined {
-    return response.chunk?.bytes
-      ? (JSON.parse(toUtf8(response.chunk?.bytes)) as ProviderStreamEvent)
-      : undefined;
-  }
-
-  async *reduceStream(
-    stream: AsyncIterable<ResponseStream>,
-  ): BedrockChatStreamResponse {
-    yield* streamConverter(stream, (response) => {
-      return {
-        delta: this.getTextFromStreamResponse(response),
-        raw: response,
-      };
-    });
-  }
-
-  getTextFromStreamResponse(response: Record<string, any>): string {
-    return this.getTextFromResponse(response);
-  }
-
-  abstract getRequestBody<T extends ChatMessage>(
-    metadata: LLMMetadata,
-    messages: T[],
-    tools?: BaseTool[],
-    options?: BedrockAdditionalChatOptions,
-  ): InvokeModelCommandInput | InvokeModelWithResponseStreamCommandInput;
-}
-
-class AnthropicProvider extends Provider<StreamEvent> {
-  getResultFromResponse(
-    response: Record<string, any>,
-  ): AnthropicNoneStreamingResponse {
-    return JSON.parse(toUtf8(response.body));
-  }
-
-  getToolsFromResponse<AnthropicToolContent>(
-    response: Record<string, any>,
-  ): AnthropicToolContent[] {
-    const result = this.getResultFromResponse(response);
-    return result.content
-      .filter((item) => item.type === "tool_use")
-      .map((item) => item as AnthropicToolContent);
-  }
-
-  getTextFromResponse(response: Record<string, any>): string {
-    const result = this.getResultFromResponse(response);
-    return result.content
-      .filter((item) => item.type === "text")
-      .map((item) => (item as AnthropicTextContent).text)
-      .join(" ");
-  }
-
-  getTextFromStreamResponse(response: Record<string, any>): string {
-    const event = this.getStreamingEventResponse(response);
-    if (event?.type === "content_block_delta") {
-      if (event.delta.type === "text_delta") return event.delta.text;
-      if (event.delta.type === "input_json_delta")
-        return event.delta.partial_json;
-    }
-    return "";
-  }
-
-  async *reduceStream(
-    stream: AsyncIterable<ResponseStream>,
-  ): BedrockChatStreamResponse {
-    let collecting = [];
-    let tool: ToolBlock | undefined = undefined;
-    // #TODO this should be broken down into a separate consumer
-    for await (const response of stream) {
-      const event = this.getStreamingEventResponse(response);
-      if (
-        event?.type === "content_block_start" &&
-        event.content_block.type === "tool_use"
-      ) {
-        tool = event.content_block;
-        continue;
-      }
-
-      if (
-        event?.type === "content_block_delta" &&
-        event.delta.type === "input_json_delta"
-      ) {
-        collecting.push(event.delta.partial_json);
-      }
-
-      let options: undefined | ToolCallLLMMessageOptions = undefined;
-      if (tool && collecting.length) {
-        const input = collecting.filter((item) => item).join("");
-        // We have all we need to parse the tool_use json
-        if (event?.type === "content_block_stop") {
-          options = {
-            toolCall: [
-              {
-                id: tool.id,
-                name: tool.name,
-                input: JSON.parse(input),
-              } as ToolCall,
-            ],
-          };
-          // reset the collection/tool
-          collecting = [];
-          tool = undefined;
-        } else {
-          options = {
-            toolCall: [
-              {
-                id: tool.id,
-                name: tool.name,
-                input,
-              } as PartialToolCall,
-            ],
-          };
-        }
-      }
-      const delta = this.getTextFromStreamResponse(response);
-      if (!delta && !options) continue;
-
-      yield {
-        delta,
-        options,
-        raw: response,
-      };
-    }
-  }
-
-  getRequestBody<T extends ChatMessage<ToolCallLLMMessageOptions>>(
-    metadata: LLMMetadata,
-    messages: T[],
-    tools?: BaseTool[],
-    options?: BedrockAdditionalChatOptions,
-  ): InvokeModelCommandInput | InvokeModelWithResponseStreamCommandInput {
-    const extra: Record<string, unknown> = {};
-    if (options?.toolChoice) {
-      extra["tool_choice"] = options?.toolChoice;
-    }
-    const mapped = mapChatMessagesToAnthropicMessages(messages);
-    return {
-      modelId: metadata.model,
-      contentType: "application/json",
-      accept: "application/json",
-      body: JSON.stringify({
-        anthropic_version: "bedrock-2023-05-31",
-        messages: mapped,
-        tools: mapBaseToolsToAnthropicTools(tools),
-        max_tokens: metadata.maxTokens,
-        temperature: metadata.temperature,
-        top_p: metadata.topP,
-        ...extra,
-      }),
-    };
-  }
-}
-
-// Other providers could go here
-const PROVIDERS: { [key: string]: Provider } = {
-  anthropic: new AnthropicProvider(),
-};
-
 const getProvider = (model: string): Provider => {
   const providerName = model.split(".")[0];
   if (!(providerName in PROVIDERS)) {
@@ -336,6 +159,21 @@ export type BedrockModelParams = {
   maxTokens?: number;
 };
 
+export const BEDROCK_MODEL_MAX_TOKENS: Partial<Record<BEDROCK_MODELS, number>> =
+  {
+    [BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_SONNET]: 4096,
+    [BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_HAIKU]: 4096,
+    [BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_OPUS]: 4096,
+    [BEDROCK_MODELS.ANTHROPIC_CLAUDE_3_5_SONNET]: 4096,
+    [BEDROCK_MODELS.META_LLAMA2_13B_CHAT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA2_70B_CHAT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA3_8B_INSTRUCT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA3_70B_INSTRUCT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA3_1_8B_INSTRUCT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA3_1_70B_INSTRUCT]: 2048,
+    [BEDROCK_MODELS.META_LLAMA3_1_405B_INSTRUCT]: 2048,
+  };
+
 const DEFAULT_BEDROCK_PARAMS = {
   temperature: 0.1,
   topP: 1,
@@ -373,6 +211,10 @@ export class Bedrock extends ToolCallLLM<BedrockAdditionalChatOptions> {
     this.temperature = temperature ?? DEFAULT_BEDROCK_PARAMS.temperature;
     this.topP = topP ?? DEFAULT_BEDROCK_PARAMS.topP;
     this.client = new BedrockRuntimeClient(params);
+
+    if (!this.supportToolCall) {
+      console.warn(`The model "${this.model}" doesn't support ToolCall`);
+    }
   }
 
   get supportToolCall(): boolean {
@@ -402,10 +244,13 @@ export class Bedrock extends ToolCallLLM<BedrockAdditionalChatOptions> {
     );
     const command = new InvokeModelCommand(input);
     const response = await this.client.send(command);
-    const tools = this.provider.getToolsFromResponse(response);
-    const options: ToolCallLLMMessageOptions = tools.length
-      ? { toolCall: tools }
-      : {};
+    let options: ToolCallLLMMessageOptions = {};
+    if (this.supportToolCall) {
+      const tools = this.provider.getToolsFromResponse(response);
+      if (tools.length) {
+        options = { toolCall: tools };
+      }
+    }
     return {
       raw: response,
       message: {

packages/community/src/llm/bedrock/provider.ts

@@ -0,0 +1,59 @@
+import {
+  type InvokeModelCommandInput,
+  type InvokeModelWithResponseStreamCommandInput,
+  ResponseStream,
+} from "@aws-sdk/client-bedrock-runtime";
+import {
+  type BaseTool,
+  type ChatMessage,
+  type ChatResponseChunk,
+  type LLMMetadata,
+  type ToolCallLLMMessageOptions,
+} from "@llamaindex/core/llms";
+import { streamConverter } from "@llamaindex/core/utils";
+import type { ToolChoice } from "./types";
+import { toUtf8 } from "./utils";
+
+export type BedrockAdditionalChatOptions = { toolChoice: ToolChoice };
+
+export type BedrockChatStreamResponse = AsyncIterable<
+  ChatResponseChunk<ToolCallLLMMessageOptions>
+>;
+
+export abstract class Provider<ProviderStreamEvent extends {} = {}> {
+  abstract getTextFromResponse(response: Record<string, any>): string;
+
+  abstract getToolsFromResponse<T extends {} = {}>(
+    response: Record<string, any>,
+  ): T[];
+
+  getStreamingEventResponse(
+    response: Record<string, any>,
+  ): ProviderStreamEvent | undefined {
+    return response.chunk?.bytes
+      ? (JSON.parse(toUtf8(response.chunk?.bytes)) as ProviderStreamEvent)
+      : undefined;
+  }
+
+  async *reduceStream(
+    stream: AsyncIterable<ResponseStream>,
+  ): BedrockChatStreamResponse {
+    yield* streamConverter(stream, (response) => {
+      return {
+        delta: this.getTextFromStreamResponse(response),
+        raw: response,
+      };
+    });
+  }
+
+  getTextFromStreamResponse(response: Record<string, any>): string {
+    return this.getTextFromResponse(response);
+  }
+
+  abstract getRequestBody<T extends ChatMessage>(
+    metadata: LLMMetadata,
+    messages: T[],
+    tools?: BaseTool[],
+    options?: BedrockAdditionalChatOptions,
+  ): InvokeModelCommandInput | InvokeModelWithResponseStreamCommandInput;
+}

packages/community/src/llm/bedrock/providers/anthropic.ts

@@ -0,0 +1,154 @@
+import {
+  type InvokeModelCommandInput,
+  type InvokeModelWithResponseStreamCommandInput,
+  ResponseStream,
+} from "@aws-sdk/client-bedrock-runtime";
+import type {
+  BaseTool,
+  ChatMessage,
+  LLMMetadata,
+  PartialToolCall,
+  ToolCall,
+  ToolCallLLMMessageOptions,
+} from "@llamaindex/core/llms";
+import {
+  type BedrockAdditionalChatOptions,
+  type BedrockChatStreamResponse,
+  Provider,
+} from "../provider";
+import type {
+  AnthropicNoneStreamingResponse,
+  AnthropicStreamEvent,
+  AnthropicTextContent,
+  ToolBlock,
+} from "../types";
+import {
+  mapBaseToolsToAnthropicTools,
+  mapChatMessagesToAnthropicMessages,
+  toUtf8,
+} from "../utils";
+
+export class AnthropicProvider extends Provider<AnthropicStreamEvent> {
+  getResultFromResponse(
+    response: Record<string, any>,
+  ): AnthropicNoneStreamingResponse {
+    return JSON.parse(toUtf8(response.body));
+  }
+
+  getToolsFromResponse<AnthropicToolContent>(
+    response: Record<string, any>,
+  ): AnthropicToolContent[] {
+    const result = this.getResultFromResponse(response);
+    return result.content
+      .filter((item) => item.type === "tool_use")
+      .map((item) => item as AnthropicToolContent);
+  }
+
+  getTextFromResponse(response: Record<string, any>): string {
+    const result = this.getResultFromResponse(response);
+    return result.content
+      .filter((item) => item.type === "text")
+      .map((item) => (item as AnthropicTextContent).text)
+      .join(" ");
+  }
+
+  getTextFromStreamResponse(response: Record<string, any>): string {
+    const event = this.getStreamingEventResponse(response);
+    if (event?.type === "content_block_delta") {
+      if (event.delta.type === "text_delta") return event.delta.text;
+      if (event.delta.type === "input_json_delta")
+        return event.delta.partial_json;
+    }
+    return "";
+  }
+
+  async *reduceStream(
+    stream: AsyncIterable<ResponseStream>,
+  ): BedrockChatStreamResponse {
+    let collecting = [];
+    let tool: ToolBlock | undefined = undefined;
+    // #TODO this should be broken down into a separate consumer
+    for await (const response of stream) {
+      const event = this.getStreamingEventResponse(response);
+      if (
+        event?.type === "content_block_start" &&
+        event.content_block.type === "tool_use"
+      ) {
+        tool = event.content_block;
+        continue;
+      }
+
+      if (
+        event?.type === "content_block_delta" &&
+        event.delta.type === "input_json_delta"
+      ) {
+        collecting.push(event.delta.partial_json);
+      }
+
+      let options: undefined | ToolCallLLMMessageOptions = undefined;
+      if (tool && collecting.length) {
+        const input = collecting.filter((item) => item).join("");
+        // We have all we need to parse the tool_use json
+        if (event?.type === "content_block_stop") {
+          options = {
+            toolCall: [
+              {
+                id: tool.id,
+                name: tool.name,
+                input: JSON.parse(input),
+              } as ToolCall,
+            ],
+          };
+          // reset the collection/tool
+          collecting = [];
+          tool = undefined;
+        } else {
+          options = {
+            toolCall: [
+              {
+                id: tool.id,
+                name: tool.name,
+                input,
+              } as PartialToolCall,
+            ],
+          };
+        }
+      }
+      const delta = this.getTextFromStreamResponse(response);
+      if (!delta && !options) continue;
+
+      yield {
+        delta,
+        options,
+        raw: response,
+      };
+    }
+  }
+
+  getRequestBody<T extends ChatMessage<ToolCallLLMMessageOptions>>(
+    metadata: LLMMetadata,
+    messages: T[],
+    tools?: BaseTool[],
+    options?: BedrockAdditionalChatOptions,
+  ): InvokeModelCommandInput | InvokeModelWithResponseStreamCommandInput {
+    const extra: Record<string, unknown> = {};
+    if (options?.toolChoice) {
+      extra["tool_choice"] = options?.toolChoice;
+    }
+    const mapped = mapChatMessagesToAnthropicMessages(messages);
+    return {
+      modelId: metadata.model,
+      contentType: "application/json",
+      accept: "application/json",
+      body: JSON.stringify({
+        anthropic_version: "bedrock-2023-05-31",
+        messages: mapped,
+        tools: mapBaseToolsToAnthropicTools(tools),
+        max_tokens: metadata.maxTokens,
+        temperature: metadata.temperature,
+        top_p: metadata.topP,
+        ...extra,
+      }),
+    };
+  }
+}

packages/community/src/llm/bedrock/providers/index.ts

@@ -0,0 +1,9 @@
+import { Provider } from "../provider";
+import { AnthropicProvider } from "./anthropic";
+import { MetaProvider } from "./meta";
+
+// Other providers should go here
+export const PROVIDERS: { [key: string]: Provider } = {
+  anthropic: new AnthropicProvider(),
+  meta: new MetaProvider(),
+};

packages/community/src/llm/bedrock/providers/meta.ts

@@ -0,0 +1,69 @@
+import type {
+  InvokeModelCommandInput,
+  InvokeModelWithResponseStreamCommandInput,
+} from "@aws-sdk/client-bedrock-runtime";
+import type { ChatMessage, LLMMetadata } from "@llamaindex/core/llms";
+import type { MetaNoneStreamingResponse, MetaStreamEvent } from "../types";
+import {
+  mapChatMessagesToMetaLlama2Messages,
+  mapChatMessagesToMetaLlama3Messages,
+  toUtf8,
+} from "../utils";
+
+import { Provider } from "../provider";
+
+export class MetaProvider extends Provider<MetaStreamEvent> {
+  constructor() {
+    super();
+  }
+
+  getResultFromResponse(
+    response: Record<string, any>,
+  ): MetaNoneStreamingResponse {
+    return JSON.parse(toUtf8(response.body));
+  }
+
+  getToolsFromResponse(_response: Record<string, any>): never {
+    throw new Error("Not supported by this provider.");
+  }
+
+  getTextFromResponse(response: Record<string, any>): string {
+    const result = this.getResultFromResponse(response);
+    return result.generation;
+  }
+
+  getTextFromStreamResponse(response: Record<string, any>): string {
+    const event = this.getStreamingEventResponse(response);
+    if (event?.generation) {
+      return event.generation;
+    }
+    return "";
+  }
+
+  getRequestBody<T extends ChatMessage>(
+    metadata: LLMMetadata,
+    messages: T[],
+  ): InvokeModelCommandInput | InvokeModelWithResponseStreamCommandInput {
+    let promptFunction: (messages: ChatMessage[]) => string;
+
+    if (metadata.model.startsWith("meta.llama3")) {
+      promptFunction = mapChatMessagesToMetaLlama3Messages;
+    } else if (metadata.model.startsWith("meta.llama2")) {
+      promptFunction = mapChatMessagesToMetaLlama2Messages;
+    } else {
+      throw new Error(`Meta model ${metadata.model} is not supported`);
+    }
+
+    return {
+      modelId: metadata.model,
+      contentType: "application/json",
+      accept: "application/json",
+      body: JSON.stringify({
+        prompt: promptFunction(messages),
+        max_gen_len: metadata.maxTokens,
+        temperature: metadata.temperature,
+        top_p: metadata.topP,
+      }),
+    };
+  }
+}

packages/community/src/llm/bedrock/types.ts

@@ -79,7 +79,7 @@ export type ToolChoice =
   | { type: "auto" }
   | { type: "tool"; name: string };
 
-export type StreamEvent =
+export type AnthropicStreamEvent =
   | { type: "message_start"; message: Message }
   | ContentBlockStart
   | ContentBlockDelta
@@ -93,6 +93,8 @@ export type AnthropicContent =
   | AnthropicToolContent
   | AnthropicToolResultContent;
 
+export type MetaTextContent = string;
+
 export type AnthropicTextContent = {
   type: "text";
   text: string;
@@ -133,6 +135,11 @@ export type AnthropicMessage = {
   content: AnthropicContent[];
 };
 
+export type MetaMessage = {
+  role: "user" | "assistant" | "system";
+  content: MetaTextContent;
+};
+
 export type AnthropicNoneStreamingResponse = {
   id: string;
   type: "message";
@@ -143,3 +150,16 @@ export type AnthropicNoneStreamingResponse = {
   stop_sequence?: string;
   usage: { input_tokens: number; output_tokens: number };
 };
+
+type MetaResponse = {
+  generation: string;
+  prompt_token_count: number;
+  generation_token_count: number;
+  stop_reason: "stop" | "length";
+};
+
+export type MetaStreamEvent = MetaResponse & {
+  "amazon-bedrock-invocationMetrics": InvocationMetrics;
+};
+
+export type MetaNoneStreamingResponse = MetaResponse;

packages/community/src/llm/bedrock/utils.ts

@@ -1,18 +1,20 @@
+import type { JSONObject } from "@llamaindex/core/global";
 import type {
   BaseTool,
   ChatMessage,
-  JSONObject,
   MessageContent,
   MessageContentDetail,
+  MessageContentTextDetail,
   ToolCallLLMMessageOptions,
   ToolMetadata,
-} from "llamaindex";
+} from "@llamaindex/core/llms";
 import type {
   AnthropicContent,
   AnthropicImageContent,
   AnthropicMediaTypes,
   AnthropicMessage,
   AnthropicTextContent,
+  MetaMessage,
 } from "./types.js";
 
 const ACCEPTED_IMAGE_MIME_TYPES = [
@@ -148,6 +150,85 @@ export const mapChatMessagesToAnthropicMessages = <
   return mergeNeighboringSameRoleMessages(mapped);
 };
 
+export const mapChatMessagesToMetaMessages = <T extends ChatMessage>(
+  messages: T[],
+): MetaMessage[] => {
+  return messages.map((msg) => {
+    let content: string = "";
+    if (typeof msg.content === "string") {
+      content = msg.content;
+    } else if (msg.content.length) {
+      content = (msg.content[0] as MessageContentTextDetail).text;
+    }
+    return {
+      role:
+        msg.role === "assistant"
+          ? "assistant"
+          : msg.role === "user"
+            ? "user"
+            : "system",
+      content,
+    };
+  });
+};
+
+/**
+ * Documentation at https://llama.meta.com/docs/model-cards-and-prompt-formats/meta-llama-3
+ */
+export const mapChatMessagesToMetaLlama3Messages = <T extends ChatMessage>(
+  messages: T[],
+): string => {
+  const mapped = mapChatMessagesToMetaMessages(messages).map((message) => {
+    const text = message.content;
+    return `<|start_header_id|>${message.role}<|end_header_id|>\n${text}\n<|eot_id|>\n`;
+  });
+  return (
+    "<|begin_of_text|>" +
+    mapped.join("\n") +
+    "\n<|start_header_id|>assistant<|end_header_id|>\n"
+  );
+};
+
+/**
+ * Documentation at https://llama.meta.com/docs/model-cards-and-prompt-formats/meta-llama-2
+ */
+export const mapChatMessagesToMetaLlama2Messages = <T extends ChatMessage>(
+  messages: T[],
+): string => {
+  const mapped = mapChatMessagesToMetaMessages(messages);
+  let output = "<s>";
+  let insideInst = false;
+  let needsStartAgain = false;
+  for (const message of mapped) {
+    if (needsStartAgain) {
+      output += "<s>";
+      needsStartAgain = false;
+    }
+    const text = message.content;
+    if (message.role === "system") {
+      if (!insideInst) {
+        output += "[INST] ";
+        insideInst = true;
+      }
+      output += `<<SYS>>\n${text}\n<</SYS>>\n`;
+    } else if (message.role === "user") {
+      output += text;
+      if (insideInst) {
+        output += " [/INST]";
+        insideInst = false;
+      }
+    } else if (message.role === "assistant") {
+      if (insideInst) {
+        output += " [/INST]";
+        insideInst = false;
+      }
+      output += ` ${text} </s>\n`;
+      needsStartAgain = true;
+    }
+  }
+  return output;
+};
+
 export const mapTextContent = (text: string): AnthropicTextContent => {
   return { type: "text", text };
 };

packages/community/tsconfig.script.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist/script/type",
-    "tsBuildInfoFile": "./dist/script/.tsbuildinfo",
-    "emitDeclarationOnly": true
-  },
-  "include": ["./tsup.config.ts"]
-}

packages/community/tsup.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig([
-  {
-    entry: ["src/index.ts", "src/llm/bedrock/base.ts"],
-    format: ["cjs", "esm"],
-    sourcemap: true,
-  },
-]);

packages/core/CHANGELOG.md

@@ -0,0 +1,61 @@
+# @llamaindex/core
+
+## 0.1.4
+
+### Patch Changes
+
+- 15962b3: feat: node parser refactor
+
+  Align the text splitter logic with Python; it has almost the same logic as Python; Zod checks for input and better error messages and event system.
+
+  This change will not be considered a breaking change since it doesn't have a significant output difference from the last version,
+  but some edge cases will change, like the page separator and parameter for the constructor.
+
+## 0.1.3
+
+### Patch Changes
+
+- 6cf6ae6: feat: abstract query type
+
+## 0.1.2
+
+### Patch Changes
+
+- b974eea: Add support for Metadata filters
+
+## 0.1.1
+
+### Patch Changes
+
+- b3681bf: fix: DataCloneError when using FunctionTool
+
+## 0.1.0
+
+### Minor Changes
+
+- 16ef5dd: refactor: simplify callback manager
+
+  Change `event.detail.payload` to `event.detail`
+
+### Patch Changes
+
+- 16ef5dd: refactor: move callback manager & llm to core module
+
+  For people who import `llamaindex/llms/base` or `llamaindex/llms/utils`,
+  use `@llamaindex/core/llms` and `@llamaindex/core/utils` instead.
+
+## 0.0.3
+
+### Patch Changes
+
+- f326ab8: chore: bump version
+- Updated dependencies [f326ab8]
+  - @llamaindex/env@0.1.8
+
+## 0.0.2
+
+### Patch Changes
+
+- f10b41d: fix: release files
+- Updated dependencies [41fe871]
+  - @llamaindex/env@0.1.7

packages/core/package.json

@@ -1,9 +1,51 @@
 {
   "name": "@llamaindex/core",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.1.4",
   "description": "LlamaIndex Core Module",
   "exports": {
+    "./node-parser": {
+      "require": {
+        "types": "./dist/node-parser/index.d.cts",
+        "default": "./dist/node-parser/index.cjs"
+      },
+      "import": {
+        "types": "./dist/node-parser/index.d.ts",
+        "default": "./dist/node-parser/index.js"
+      },
+      "default": {
+        "types": "./dist/node-parser/index.d.ts",
+        "default": "./dist/node-parser/index.js"
+      }
+    },
+    "./query-engine": {
+      "require": {
+        "types": "./dist/query-engine/index.d.cts",
+        "default": "./dist/query-engine/index.cjs"
+      },
+      "import": {
+        "types": "./dist/query-engine/index.d.ts",
+        "default": "./dist/query-engine/index.js"
+      },
+      "default": {
+        "types": "./dist/query-engine/index.d.ts",
+        "default": "./dist/query-engine/index.js"
+      }
+    },
+    "./llms": {
+      "require": {
+        "types": "./dist/llms/index.d.cts",
+        "default": "./dist/llms/index.cjs"
+      },
+      "import": {
+        "types": "./dist/llms/index.d.ts",
+        "default": "./dist/llms/index.js"
+      },
+      "default": {
+        "types": "./dist/llms/index.d.ts",
+        "default": "./dist/llms/index.js"
+      }
+    },
     "./decorator": {
       "require": {
         "types": "./dist/decorator/index.d.cts",
@@ -18,6 +60,20 @@
         "default": "./dist/decorator/index.js"
       }
     },
+    "./embeddings": {
+      "require": {
+        "types": "./dist/embeddings/index.d.cts",
+        "default": "./dist/embeddings/index.cjs"
+      },
+      "import": {
+        "types": "./dist/embeddings/index.d.ts",
+        "default": "./dist/embeddings/index.js"
+      },
+      "default": {
+        "types": "./dist/embeddings/index.d.ts",
+        "default": "./dist/embeddings/index.js"
+      }
+    },
     "./global": {
       "require": {
         "types": "./dist/global/index.d.cts",
@@ -45,8 +101,25 @@
         "types": "./dist/schema/index.d.ts",
         "default": "./dist/schema/index.js"
       }
+    },
+    "./utils": {
+      "require": {
+        "types": "./dist/utils/index.d.cts",
+        "default": "./dist/utils/index.cjs"
+      },
+      "import": {
+        "types": "./dist/utils/index.d.ts",
+        "default": "./dist/utils/index.js"
+      },
+      "default": {
+        "types": "./dist/utils/index.d.ts",
+        "default": "./dist/utils/index.js"
+      }
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "dev": "bunchee --watch",
     "build": "bunchee"
@@ -57,7 +130,9 @@
     "url": "https://github.com/himself65/LlamaIndexTS.git"
   },
   "devDependencies": {
-    "bunchee": "^5.2.1"
+    "ajv": "^8.16.0",
+    "bunchee": "5.3.0-beta.0",
+    "natural": "^7.1.0"
   },
   "dependencies": {
     "@llamaindex/env": "workspace:*",

packages/core/src/embeddings/base.ts

@@ -1,9 +1,8 @@
-import type { BaseNode } from "@llamaindex/core/schema";
-import { MetadataMode } from "@llamaindex/core/schema";
 import { type Tokenizers } from "@llamaindex/env";
-import type { TransformComponent } from "../ingestion/types.js";
-import type { MessageContentDetail } from "../llm/types.js";
-import { extractSingleText } from "../llm/utils.js";
+import type { MessageContentDetail } from "../llms";
+import type { TransformComponent } from "../schema";
+import { BaseNode, MetadataMode } from "../schema";
+import { extractSingleText } from "../utils";
 import { truncateMaxTokens } from "./tokenizer.js";
 import { SimilarityType, similarity } from "./utils.js";
 
@@ -17,6 +16,10 @@ export type EmbeddingInfo = {
   tokenizer?: Tokenizers;
 };
 
+export type BaseEmbeddingOptions = {
+  logProgress?: boolean;
+};
+
 export abstract class BaseEmbedding implements TransformComponent {
   embedBatchSize = DEFAULT_EMBED_BATCH_SIZE;
   embedInfo?: EmbeddingInfo;
@@ -45,7 +48,7 @@ export abstract class BaseEmbedding implements TransformComponent {
    * Optionally override this method to retrieve multiple embeddings in a single request
    * @param texts
    */
-  async getTextEmbeddings(texts: string[]): Promise<Array<number[]>> {
+  getTextEmbeddings = async (texts: string[]): Promise<Array<number[]>> => {
     const embeddings: number[][] = [];
 
     for (const text of texts) {
@@ -54,7 +57,7 @@ export abstract class BaseEmbedding implements TransformComponent {
     }
 
     return embeddings;
-  }
+  };
 
   /**
    * Get embeddings for a batch of texts
@@ -63,22 +66,23 @@ export abstract class BaseEmbedding implements TransformComponent {
    */
   async getTextEmbeddingsBatch(
     texts: string[],
-    options?: {
-      logProgress?: boolean;
-    },
+    options?: BaseEmbeddingOptions,
   ): Promise<Array<number[]>> {
     return await batchEmbeddings(
       texts,
-      this.getTextEmbeddings.bind(this),
+      this.getTextEmbeddings,
       this.embedBatchSize,
       options,
     );
   }
 
-  async transform(nodes: BaseNode[], _options?: any): Promise<BaseNode[]> {
+  async transform(
+    nodes: BaseNode[],
+    options?: BaseEmbeddingOptions,
+  ): Promise<BaseNode[]> {
     const texts = nodes.map((node) => node.getContent(MetadataMode.EMBED));
 
-    const embeddings = await this.getTextEmbeddingsBatch(texts, _options);
+    const embeddings = await this.getTextEmbeddingsBatch(texts, options);
 
     for (let i = 0; i < nodes.length; i++) {
       nodes[i].embedding = embeddings[i];
@@ -104,9 +108,7 @@ export async function batchEmbeddings<T>(
   values: T[],
   embedFunc: EmbedFunc<T>,
   chunkSize: number,
-  options?: {
-    logProgress?: boolean;
-  },
+  options?: BaseEmbeddingOptions,
 ): Promise<Array<number[]>> {
   const resultEmbeddings: Array<number[]> = [];
 

packages/core/src/embeddings/index.ts

@@ -0,0 +1,4 @@
+export { BaseEmbedding, batchEmbeddings } from "./base";
+export type { BaseEmbeddingOptions, EmbeddingInfo } from "./base";
+export { truncateMaxTokens } from "./tokenizer";
+export { DEFAULT_SIMILARITY_TOP_K, SimilarityType, similarity } from "./utils";

packages/core/src/embeddings/utils.ts

@@ -0,0 +1,64 @@
+export const DEFAULT_SIMILARITY_TOP_K = 2;
+
+/**
+ * Similarity type
+ * Default is cosine similarity. Dot product and negative Euclidean distance are also supported.
+ */
+export enum SimilarityType {
+  DEFAULT = "cosine",
+  DOT_PRODUCT = "dot_product",
+  EUCLIDEAN = "euclidean",
+}
+
+/**
+ * The similarity between two embeddings.
+ * @param embedding1
+ * @param embedding2
+ * @param mode
+ * @returns similarity score with higher numbers meaning the two embeddings are more similar
+ */
+
+export function similarity(
+  embedding1: number[],
+  embedding2: number[],
+  mode: SimilarityType = SimilarityType.DEFAULT,
+): number {
+  if (embedding1.length !== embedding2.length) {
+    throw new Error("Embedding length mismatch");
+  }
+
+  // NOTE I've taken enough Kahan to know that we should probably leave the
+  // numeric programming to numeric programmers. The naive approach here
+  // will probably cause some avoidable loss of floating point precision
+  // ml-distance is worth watching although they currently also use the naive
+  // formulas
+  function norm(x: number[]): number {
+    let result = 0;
+    for (let i = 0; i < x.length; i++) {
+      result += x[i] * x[i];
+    }
+    return Math.sqrt(result);
+  }
+
+  switch (mode) {
+    case SimilarityType.EUCLIDEAN: {
+      const difference = embedding1.map((x, i) => x - embedding2[i]);
+      return -norm(difference);
+    }
+    case SimilarityType.DOT_PRODUCT: {
+      let result = 0;
+      for (let i = 0; i < embedding1.length; i++) {
+        result += embedding1[i] * embedding2[i];
+      }
+      return result;
+    }
+    case SimilarityType.DEFAULT: {
+      return (
+        similarity(embedding1, embedding2, SimilarityType.DOT_PRODUCT) /
+        (norm(embedding1) * norm(embedding2))
+      );
+    }
+    default:
+      throw new Error("Not implemented yet");
+  }
+}

packages/core/src/global/index.ts

@@ -1 +1,11 @@
 export { Settings } from "./settings";
+export { CallbackManager } from "./settings/callback-manager";
+export type {
+  LLMEndEvent,
+  LLMStartEvent,
+  LLMStreamEvent,
+  LLMToolCallEvent,
+  LLMToolResultEvent,
+  LlamaIndexEventMaps,
+} from "./settings/callback-manager";
+export type { JSONArray, JSONObject, JSONValue } from "./type";

packages/core/src/global/settings.ts

@@ -1,10 +1,31 @@
+import type { Tokenizer } from "@llamaindex/env";
+import {
+  type CallbackManager,
+  getCallbackManager,
+  setCallbackManager,
+  withCallbackManager,
+} from "./settings/callback-manager";
 import {
   getChunkSize,
   setChunkSize,
   withChunkSize,
 } from "./settings/chunk-size";
+import {
+  getTokenizer,
+  setTokenizer,
+  withTokenizer,
+} from "./settings/tokenizer";
 
 export const Settings = {
+  get tokenizer() {
+    return getTokenizer();
+  },
+  set tokenizer(tokenizer) {
+    setTokenizer(tokenizer);
+  },
+  withTokenizer<Result>(tokenizer: Tokenizer, fn: () => Result): Result {
+    return withTokenizer(tokenizer, fn);
+  },
   get chunkSize(): number | undefined {
     return getChunkSize();
   },
@@ -14,4 +35,19 @@ export const Settings = {
   withChunkSize<Result>(chunkSize: number, fn: () => Result): Result {
     return withChunkSize(chunkSize, fn);
   },
+
+  get callbackManager(): CallbackManager {
+    return getCallbackManager();
+  },
+
+  set callbackManager(callbackManager: CallbackManager) {
+    setCallbackManager(callbackManager);
+  },
+
+  withCallbackManager<Result>(
+    callbackManager: CallbackManager,
+    fn: () => Result,
+  ): Result {
+    return withCallbackManager(callbackManager, fn);
+  },
 };

packages/core/src/global/settings/callback-manager.ts

@@ -0,0 +1,155 @@
+import { AsyncLocalStorage, CustomEvent } from "@llamaindex/env";
+import type {
+  ChatMessage,
+  ChatResponse,
+  ChatResponseChunk,
+  ToolCall,
+  ToolOutput,
+} from "../../llms";
+import { TextNode } from "../../schema";
+import { EventCaller, getEventCaller } from "../../utils/event-caller";
+import type { UUID } from "../type";
+
+export type LLMStartEvent = {
+  id: UUID;
+  messages: ChatMessage[];
+};
+
+export type LLMToolCallEvent = {
+  toolCall: ToolCall;
+};
+
+export type LLMToolResultEvent = {
+  toolCall: ToolCall;
+  toolResult: ToolOutput;
+};
+
+export type LLMEndEvent = {
+  id: UUID;
+  response: ChatResponse;
+};
+
+export type LLMStreamEvent = {
+  id: UUID;
+  chunk: ChatResponseChunk;
+};
+
+export type ChunkingStartEvent = {
+  text: string[];
+};
+
+export type ChunkingEndEvent = {
+  chunks: string[];
+};
+
+export type NodeParsingStartEvent = {
+  documents: TextNode[];
+};
+
+export type NodeParsingEndEvent = {
+  nodes: TextNode[];
+};
+
+export interface LlamaIndexEventMaps {
+  "llm-start": LLMStartEvent;
+  "llm-end": LLMEndEvent;
+  "llm-tool-call": LLMToolCallEvent;
+  "llm-tool-result": LLMToolResultEvent;
+  "llm-stream": LLMStreamEvent;
+  "chunking-start": ChunkingStartEvent;
+  "chunking-end": ChunkingEndEvent;
+  "node-parsing-start": NodeParsingStartEvent;
+  "node-parsing-end": NodeParsingEndEvent;
+}
+
+export class LlamaIndexCustomEvent<T = any> extends CustomEvent<T> {
+  reason: EventCaller | null = null;
+  private constructor(
+    event: string,
+    options?: CustomEventInit & {
+      reason?: EventCaller | null;
+    },
+  ) {
+    super(event, options);
+    this.reason = options?.reason ?? null;
+  }
+
+  static fromEvent<Type extends keyof LlamaIndexEventMaps>(
+    type: Type,
+    detail: LlamaIndexEventMaps[Type],
+  ) {
+    return new LlamaIndexCustomEvent(type, {
+      detail: detail,
+      reason: getEventCaller(),
+    });
+  }
+}
+
+type EventHandler<Event> = (event: LlamaIndexCustomEvent<Event>) => void;
+
+export class CallbackManager {
+  #handlers = new Map<keyof LlamaIndexEventMaps, EventHandler<any>[]>();
+
+  on<K extends keyof LlamaIndexEventMaps>(
+    event: K,
+    handler: EventHandler<LlamaIndexEventMaps[K]>,
+  ) {
+    if (!this.#handlers.has(event)) {
+      this.#handlers.set(event, []);
+    }
+    this.#handlers.get(event)!.push(handler);
+    return this;
+  }
+
+  off<K extends keyof LlamaIndexEventMaps>(
+    event: K,
+    handler: EventHandler<LlamaIndexEventMaps[K]>,
+  ) {
+    if (!this.#handlers.has(event)) {
+      return this;
+    }
+    const cbs = this.#handlers.get(event)!;
+    const index = cbs.indexOf(handler);
+    if (index > -1) {
+      cbs.splice(index, 1);
+    }
+    return this;
+  }
+
+  dispatchEvent<K extends keyof LlamaIndexEventMaps>(
+    event: K,
+    detail: LlamaIndexEventMaps[K],
+  ) {
+    const cbs = this.#handlers.get(event);
+    if (!cbs) {
+      return;
+    }
+    queueMicrotask(() => {
+      cbs.forEach((handler) =>
+        handler(LlamaIndexCustomEvent.fromEvent(event, { ...detail })),
+      );
+    });
+  }
+}
+
+export const globalCallbackManager = new CallbackManager();
+
+const callbackManagerAsyncLocalStorage =
+  new AsyncLocalStorage<CallbackManager>();
+
+let currentCallbackManager: CallbackManager = globalCallbackManager;
+
+export function getCallbackManager(): CallbackManager {
+  return callbackManagerAsyncLocalStorage.getStore() ?? currentCallbackManager;
+}
+
+export function setCallbackManager(callbackManager: CallbackManager) {
+  currentCallbackManager = callbackManager;
+}
+
+export function withCallbackManager<Result>(
+  callbackManager: CallbackManager,
+  fn: () => Result,
+): Result {
+  return callbackManagerAsyncLocalStorage.run(callbackManager, fn);
+}

packages/core/src/global/settings/chunk-size.ts

@@ -1,9 +1,9 @@
 import { AsyncLocalStorage } from "@llamaindex/env";
 
 const chunkSizeAsyncLocalStorage = new AsyncLocalStorage<number | undefined>();
-let globalChunkSize: number | null = null;
+let globalChunkSize: number = 1024;
 
-export function getChunkSize(): number | undefined {
+export function getChunkSize(): number {
   return globalChunkSize ?? chunkSizeAsyncLocalStorage.getStore();
 }
 

packages/core/src/global/settings/tokenizer.ts

@@ -0,0 +1,21 @@
+import { AsyncLocalStorage, type Tokenizer, tokenizers } from "@llamaindex/env";
+
+const chunkSizeAsyncLocalStorage = new AsyncLocalStorage<Tokenizer>();
+let globalTokenizer: Tokenizer = tokenizers.tokenizer();
+
+export function getTokenizer(): Tokenizer {
+  return globalTokenizer ?? chunkSizeAsyncLocalStorage.getStore();
+}
+
+export function setTokenizer(tokenizer: Tokenizer | undefined) {
+  if (tokenizer !== undefined) {
+    globalTokenizer = tokenizer;
+  }
+}
+
+export function withTokenizer<Result>(
+  tokenizer: Tokenizer,
+  fn: () => Result,
+): Result {
+  return chunkSizeAsyncLocalStorage.run(tokenizer, fn);
+}

packages/core/src/global/type.ts

@@ -0,0 +1,9 @@
+export type UUID = `${string}-${string}-${string}-${string}-${string}`;
+
+export type JSONValue = string | number | boolean | JSONObject | JSONArray;
+
+export type JSONObject = {
+  [key: string]: JSONValue;
+};
+
+export type JSONArray = Array<JSONValue>;

packages/core/src/index.ts

@@ -1 +0,0 @@
-export * from "./schema";

packages/core/src/llms/base.ts

@@ -1,3 +1,5 @@
+import { streamConverter } from "../utils";
+import { extractText } from "../utils/llms";
 import type {
   ChatResponse,
   ChatResponseChunk,
@@ -9,8 +11,7 @@ import type {
   LLMCompletionParamsStreaming,
   LLMMetadata,
   ToolCallLLMMessageOptions,
-} from "./types.js";
-import { extractText, streamConverter } from "./utils.js";
+} from "./type";
 
 export abstract class BaseLLM<
   AdditionalChatOptions extends object = object,

packages/core/src/llms/index.ts

@@ -0,0 +1,32 @@
+export { BaseLLM, ToolCallLLM } from "./base";
+export type {
+  BaseTool,
+  BaseToolWithCall,
+  ChatMessage,
+  ChatResponse,
+  ChatResponseChunk,
+  CompletionResponse,
+  LLM,
+  LLMChat,
+  LLMChatParamsBase,
+  LLMChatParamsNonStreaming,
+  LLMChatParamsStreaming,
+  LLMCompletionParamsBase,
+  LLMCompletionParamsNonStreaming,
+  LLMCompletionParamsStreaming,
+  LLMMetadata,
+  MessageContent,
+  MessageContentDetail,
+  MessageContentImageDetail,
+  MessageContentTextDetail,
+  MessageType,
+  PartialToolCall,
+  TextChatMessage,
+  ToolCall,
+  ToolCallLLMMessageOptions,
+  ToolCallOptions,
+  ToolMetadata,
+  ToolOutput,
+  ToolResult,
+  ToolResultOptions,
+} from "./type";

packages/core/src/llms/type.ts

@@ -0,0 +1,245 @@
+import type { Tokenizers } from "@llamaindex/env";
+import type { JSONSchemaType } from "ajv";
+import type { JSONObject, JSONValue } from "../global/type";
+
+/**
+ * @internal
+ */
+export interface LLMChat<
+  AdditionalChatOptions extends object = object,
+  AdditionalMessageOptions extends object = object,
+> {
+  chat(
+    params:
+      | LLMChatParamsStreaming<AdditionalChatOptions>
+      | LLMChatParamsNonStreaming<AdditionalChatOptions>,
+  ): Promise<
+    | ChatResponse<AdditionalMessageOptions>
+    | AsyncIterable<ChatResponseChunk<AdditionalMessageOptions>>
+  >;
+}
+
+/**
+ * Unified language model interface
+ */
+export interface LLM<
+  AdditionalChatOptions extends object = object,
+  AdditionalMessageOptions extends object = object,
+> extends LLMChat<AdditionalChatOptions> {
+  metadata: LLMMetadata;
+  /**
+   * Get a chat response from the LLM
+   */
+  chat(
+    params: LLMChatParamsStreaming<
+      AdditionalChatOptions,
+      AdditionalMessageOptions
+    >,
+  ): Promise<AsyncIterable<ChatResponseChunk>>;
+  chat(
+    params: LLMChatParamsNonStreaming<
+      AdditionalChatOptions,
+      AdditionalMessageOptions
+    >,
+  ): Promise<ChatResponse<AdditionalMessageOptions>>;
+
+  /**
+   * Get a prompt completion from the LLM
+   */
+  complete(
+    params: LLMCompletionParamsStreaming,
+  ): Promise<AsyncIterable<CompletionResponse>>;
+  complete(
+    params: LLMCompletionParamsNonStreaming,
+  ): Promise<CompletionResponse>;
+}
+
+export type MessageType = "user" | "assistant" | "system" | "memory";
+
+export type TextChatMessage<AdditionalMessageOptions extends object = object> =
+  {
+    content: string;
+    role: MessageType;
+    options?: undefined | AdditionalMessageOptions;
+  };
+
+export type ChatMessage<AdditionalMessageOptions extends object = object> = {
+  content: MessageContent;
+  role: MessageType;
+  options?: undefined | AdditionalMessageOptions;
+};
+
+export interface ChatResponse<
+  AdditionalMessageOptions extends object = object,
+> {
+  message: ChatMessage<AdditionalMessageOptions>;
+  /**
+   * Raw response from the LLM
+   *
+   * If LLM response an iterable of chunks, this will be an array of those chunks
+   */
+  raw: object | null;
+}
+
+export type ChatResponseChunk<
+  AdditionalMessageOptions extends object = object,
+> = {
+  raw: object | null;
+  delta: string;
+  options?: undefined | AdditionalMessageOptions;
+};
+
+export interface CompletionResponse {
+  text: string;
+  /**
+   * Raw response from the LLM
+   *
+   * It's possible that this is `null` if the LLM response an iterable of chunks
+   */
+  raw: object | null;
+}
+
+export type LLMMetadata = {
+  model: string;
+  temperature: number;
+  topP: number;
+  maxTokens?: number;
+  contextWindow: number;
+  tokenizer: Tokenizers | undefined;
+};
+
+export interface LLMChatParamsBase<
+  AdditionalChatOptions extends object = object,
+  AdditionalMessageOptions extends object = object,
+> {
+  messages: ChatMessage<AdditionalMessageOptions>[];
+  additionalChatOptions?: AdditionalChatOptions;
+  tools?: BaseTool[];
+}
+
+export interface LLMChatParamsStreaming<
+  AdditionalChatOptions extends object = object,
+  AdditionalMessageOptions extends object = object,
+> extends LLMChatParamsBase<AdditionalChatOptions, AdditionalMessageOptions> {
+  stream: true;
+}
+
+export interface LLMChatParamsNonStreaming<
+  AdditionalChatOptions extends object = object,
+  AdditionalMessageOptions extends object = object,
+> extends LLMChatParamsBase<AdditionalChatOptions, AdditionalMessageOptions> {
+  stream?: false;
+}
+
+export interface LLMCompletionParamsBase {
+  prompt: MessageContent;
+}
+
+export interface LLMCompletionParamsStreaming extends LLMCompletionParamsBase {
+  stream: true;
+}
+
+export interface LLMCompletionParamsNonStreaming
+  extends LLMCompletionParamsBase {
+  stream?: false | null;
+}
+
+export type MessageContentTextDetail = {
+  type: "text";
+  text: string;
+};
+
+export type MessageContentImageDetail = {
+  type: "image_url";
+  image_url: { url: string };
+};
+
+export type MessageContentDetail =
+  | MessageContentTextDetail
+  | MessageContentImageDetail;
+
+/**
+ * Extended type for the content of a message that allows for multi-modal messages.
+ */
+export type MessageContent = string | MessageContentDetail[];
+
+export type ToolCall = {
+  name: string;
+  input: JSONObject;
+  id: string;
+};
+
+// happened in streaming response, the tool call is not ready yet
+export type PartialToolCall = {
+  name: string;
+  id: string;
+  // input is not ready yet, JSON.parse(input) will throw an error
+  input: string;
+};
+
+export type ToolResult = {
+  id: string;
+  result: string;
+  isError: boolean;
+};
+
+export type ToolCallOptions = {
+  toolCall: (ToolCall | PartialToolCall)[];
+};
+
+export type ToolResultOptions = {
+  toolResult: ToolResult;
+};
+
+export type ToolCallLLMMessageOptions =
+  | ToolResultOptions
+  | ToolCallOptions
+  | {};
+
+type Known =
+  | { [key: string]: Known }
+  | [Known, ...Known[]]
+  | Known[]
+  | number
+  | string
+  | boolean
+  | null;
+
+export type ToolMetadata<
+  Parameters extends Record<string, unknown> = Record<string, unknown>,
+> = {
+  description: string;
+  name: string;
+  /**
+   * OpenAI uses JSON Schema to describe the parameters that a tool can take.
+   * @link https://json-schema.org/understanding-json-schema
+   */
+  parameters?: Parameters;
+};
+
+/**
+ * Simple Tool interface. Likely to change.
+ */
+export interface BaseTool<Input = any> {
+  /**
+   * This could be undefined if the implementation is not provided,
+   *  which might be the case when communicating with a llm.
+   *
+   * @return {JSONValue | Promise<JSONValue>} The output of the tool.
+   */
+  call?: (input: Input) => JSONValue | Promise<JSONValue>;
+  metadata: // if user input any, we cannot check the schema
+  Input extends Known ? ToolMetadata<JSONSchemaType<Input>> : ToolMetadata;
+}
+
+export type BaseToolWithCall<Input = any> = Omit<BaseTool<Input>, "call"> & {
+  call: NonNullable<Pick<BaseTool<Input>, "call">["call"]>;
+};
+
+export type ToolOutput = {
+  tool: BaseTool | undefined;
+  // all of existing function calling LLMs only support object input
+  input: JSONObject;
+  output: JSONValue;
+  isError: boolean;
+};

packages/core/src/node-parser/base.ts

@@ -0,0 +1,147 @@
+import { Settings } from "../global";
+import {
+  BaseNode,
+  buildNodeFromSplits,
+  MetadataMode,
+  NodeRelationship,
+  TextNode,
+  type TransformComponent,
+} from "../schema";
+
+export abstract class NodeParser implements TransformComponent {
+  includeMetadata: boolean = true;
+  includePrevNextRel: boolean = true;
+
+  protected postProcessParsedNodes(
+    nodes: TextNode[],
+    parentDocMap: Map<string, TextNode>,
+  ): TextNode[] {
+    nodes.forEach((node, i) => {
+      const parentDoc = parentDocMap.get(node.sourceNode?.nodeId || "");
+
+      if (parentDoc) {
+        const startCharIdx = parentDoc.text.indexOf(
+          node.getContent(MetadataMode.NONE),
+        );
+        if (startCharIdx >= 0) {
+          node.startCharIdx = startCharIdx;
+          node.endCharIdx =
+            startCharIdx + node.getContent(MetadataMode.NONE).length;
+        }
+        if (this.includeMetadata && node.metadata && parentDoc.metadata) {
+          node.metadata = { ...node.metadata, ...parentDoc.metadata };
+        }
+      }
+
+      if (this.includePrevNextRel && node.sourceNode) {
+        const previousNode = i > 0 ? nodes[i - 1] : null;
+        const nextNode = i < nodes.length - 1 ? nodes[i + 1] : null;
+
+        if (
+          previousNode &&
+          previousNode.sourceNode &&
+          previousNode.sourceNode.nodeId === node.sourceNode.nodeId
+        ) {
+          node.relationships = {
+            ...node.relationships,
+            [NodeRelationship.PREVIOUS]: previousNode.asRelatedNodeInfo(),
+          };
+        }
+
+        if (
+          nextNode &&
+          nextNode.sourceNode &&
+          nextNode.sourceNode.nodeId === node.sourceNode.nodeId
+        ) {
+          node.relationships = {
+            ...node.relationships,
+            [NodeRelationship.NEXT]: nextNode.asRelatedNodeInfo(),
+          };
+        }
+      }
+    });
+
+    return nodes;
+  }
+
+  protected abstract parseNodes(
+    documents: TextNode[],
+    showProgress?: boolean,
+  ): TextNode[];
+
+  public getNodesFromDocuments(documents: TextNode[]): TextNode[] {
+    const docsId: Map<string, TextNode> = new Map(
+      documents.map((doc) => [doc.id_, doc]),
+    );
+    const callbackManager = Settings.callbackManager;
+
+    callbackManager.dispatchEvent("node-parsing-start", {
+      documents,
+    });
+
+    const nodes = this.postProcessParsedNodes(
+      this.parseNodes(documents),
+      docsId,
+    );
+
+    callbackManager.dispatchEvent("node-parsing-end", {
+      nodes,
+    });
+
+    return nodes;
+  }
+
+  async transform(nodes: BaseNode[], options?: {}): Promise<BaseNode[]> {
+    return this.getNodesFromDocuments(nodes as TextNode[]);
+  }
+}
+
+export abstract class TextSplitter extends NodeParser {
+  abstract splitText(text: string): string[];
+
+  public splitTexts(texts: string[]): string[] {
+    return texts.flatMap((text) => this.splitText(text));
+  }
+
+  protected parseNodes(nodes: TextNode[]): TextNode[] {
+    return nodes.reduce<TextNode[]>((allNodes, node) => {
+      const splits = this.splitText(node.getContent(MetadataMode.ALL));
+      const nodes = buildNodeFromSplits(splits, node);
+      return allNodes.concat(nodes);
+    }, []);
+  }
+}
+
+export abstract class MetadataAwareTextSplitter extends TextSplitter {
+  abstract splitTextMetadataAware(text: string, metadata: string): string[];
+
+  splitTextsMetadataAware(texts: string[], metadata: string[]): string[] {
+    if (texts.length !== metadata.length) {
+      throw new TypeError("`texts` and `metadata` must have the same length");
+    }
+    return texts.flatMap((text, i) =>
+      this.splitTextMetadataAware(text, metadata[i]),
+    );
+  }
+
+  protected getMetadataString(node: TextNode): string {
+    const embedStr = node.getMetadataStr(MetadataMode.EMBED);
+    const llmStr = node.getMetadataStr(MetadataMode.LLM);
+    if (embedStr.length > llmStr.length) {
+      return embedStr;
+    } else {
+      return llmStr;
+    }
+  }
+
+  protected parseNodes(nodes: TextNode[]): TextNode[] {
+    return nodes.reduce<TextNode[]>((allNodes, node) => {
+      const metadataStr = this.getMetadataString(node);
+      const splits = this.splitTextMetadataAware(
+        node.getContent(MetadataMode.ALL),
+        metadataStr,
+      );
+      return allNodes.concat(buildNodeFromSplits(splits, node));
+    }, []);
+  }
+}

packages/core/src/node-parser/index.ts

@@ -0,0 +1,24 @@
+/**
+ * Current logic is based on the following implementation:
+ * @link @link https://github.com/run-llama/llama_index/blob/cc0ea90e7e72b8e4f5069aac981d56bb1d568323/llama-index-core/llama_index/core/node_parser
+ */
+import { SentenceSplitter } from "./sentence-splitter";
+
+/**
+ * @deprecated Use `SentenceSplitter` instead
+ */
+export const SimpleNodeParser = SentenceSplitter;
+
+export { MetadataAwareTextSplitter, NodeParser, TextSplitter } from "./base";
+export { MarkdownNodeParser } from "./markdown";
+export { SentenceSplitter } from "./sentence-splitter";
+export { SentenceWindowNodeParser } from "./sentence-window";
+export type { SplitterParams } from "./type";
+export {
+  splitByChar,
+  splitByPhraseRegex,
+  splitByRegex,
+  splitBySentenceTokenizer,
+  splitBySep,
+} from "./utils";
+export type { TextSplitterFn } from "./utils";

packages/core/src/node-parser/markdown.ts

@@ -0,0 +1,87 @@
+import {
+  buildNodeFromSplits,
+  type Metadata,
+  MetadataMode,
+  TextNode,
+} from "../schema";
+import { NodeParser } from "./base";
+
+export class MarkdownNodeParser extends NodeParser {
+  override parseNodes(nodes: TextNode[], showProgress?: boolean): TextNode[] {
+    return nodes.reduce<TextNode[]>((allNodes, node) => {
+      const markdownNodes = this.getNodesFromNode(node);
+      return allNodes.concat(markdownNodes);
+    }, []);
+  }
+
+  protected getNodesFromNode(node: TextNode): TextNode[] {
+    const text = node.getContent(MetadataMode.NONE);
+    const markdownNodes: TextNode[] = [];
+    const lines = text.split("\n");
+    let metadata: { [key: string]: string } = {};
+    let codeBlock = false;
+    let currentSection = "";
+
+    for (const line of lines) {
+      if (line.trim().startsWith("```")) {
+        codeBlock = !codeBlock;
+      }
+      const headerMatch = /^(#+)\s(.*)/.exec(line);
+      if (headerMatch && !codeBlock) {
+        if (currentSection !== "") {
+          markdownNodes.push(
+            this.buildNodeFromSplit(currentSection.trim(), node, metadata),
+          );
+        }
+        metadata = this.updateMetadata(
+          metadata,
+          headerMatch[2],
+          headerMatch[1].trim().length,
+        );
+        currentSection = `${headerMatch[2]}\n`;
+      } else {
+        currentSection += line + "\n";
+      }
+    }
+
+    if (currentSection !== "") {
+      markdownNodes.push(
+        this.buildNodeFromSplit(currentSection.trim(), node, metadata),
+      );
+    }
+
+    return markdownNodes;
+  }
+
+  private updateMetadata(
+    headersMetadata: { [key: string]: string },
+    newHeader: string,
+    newHeaderLevel: number,
+  ): { [key: string]: string } {
+    const updatedHeaders: { [key: string]: string } = {};
+
+    for (let i = 1; i < newHeaderLevel; i++) {
+      const key = `Header_${i}`;
+      if (key in headersMetadata) {
+        updatedHeaders[key] = headersMetadata[key];
+      }
+    }
+
+    updatedHeaders[`Header_${newHeaderLevel}`] = newHeader;
+    return updatedHeaders;
+  }
+
+  private buildNodeFromSplit(
+    textSplit: string,
+    node: TextNode,
+    metadata: Metadata,
+  ): TextNode {
+    const newNode = buildNodeFromSplits([textSplit], node, undefined)[0];
+
+    if (this.includeMetadata) {
+      newNode.metadata = { ...newNode.metadata, ...metadata };
+    }
+
+    return newNode;
+  }
+}

packages/core/src/node-parser/sentence-splitter.ts

@@ -0,0 +1,226 @@
+import type { Tokenizer } from "@llamaindex/env";
+import { z } from "zod";
+import { Settings } from "../global";
+import { sentenceSplitterSchema } from "../schema";
+import { MetadataAwareTextSplitter } from "./base";
+import type { SplitterParams } from "./type";
+import {
+  splitByChar,
+  splitByRegex,
+  splitBySentenceTokenizer,
+  splitBySep,
+  type TextSplitterFn,
+} from "./utils";
+
+type _Split = {
+  text: string;
+  isSentence: boolean;
+  tokenSize: number;
+};
+
+/**
+ * Parse text with a preference for complete sentences.
+ */
+export class SentenceSplitter extends MetadataAwareTextSplitter {
+  /**
+   * The token chunk size for each chunk.
+   */
+  chunkSize: number = 1024;
+  /**
+   * The token overlap of each chunk when splitting.
+   */
+  chunkOverlap: number = 200;
+  /**
+   * Default separator for splitting into words
+   */
+  separator: string = " ";
+  /**
+   * Separator between paragraphs.
+   */
+  paragraphSeparator: string = "\n\n\n";
+  /**
+   * Backup regex for splitting into sentences.
+   */
+  secondaryChunkingRegex: string = "[^,.;。？！]+[,.;。？！]?";
+
+  #chunkingTokenizerFn = splitBySentenceTokenizer();
+  #splitFns: Set<TextSplitterFn> = new Set();
+  #subSentenceSplitFns: Set<TextSplitterFn> = new Set();
+  #tokenizer: Tokenizer;
+
+  constructor(
+    params?: z.input<typeof sentenceSplitterSchema> & SplitterParams,
+  ) {
+    super();
+    if (params) {
+      const parsedParams = sentenceSplitterSchema.parse(params);
+      this.chunkSize = parsedParams.chunkSize;
+      this.chunkOverlap = parsedParams.chunkOverlap;
+      this.separator = parsedParams.separator;
+      this.paragraphSeparator = parsedParams.paragraphSeparator;
+      this.secondaryChunkingRegex = parsedParams.secondaryChunkingRegex;
+    }
+    this.#tokenizer = params?.tokenizer ?? Settings.tokenizer;
+    this.#splitFns.add(splitBySep(this.paragraphSeparator));
+    this.#splitFns.add(this.#chunkingTokenizerFn);
+
+    this.#subSentenceSplitFns.add(splitByRegex(this.secondaryChunkingRegex));
+    this.#subSentenceSplitFns.add(splitBySep(this.separator));
+    this.#subSentenceSplitFns.add(splitByChar());
+  }
+
+  splitTextMetadataAware(text: string, metadata: string): string[] {
+    const metadataLength = this.tokenSize(metadata);
+    const effectiveChunkSize = this.chunkSize - metadataLength;
+    if (effectiveChunkSize <= 0) {
+      throw new Error(
+        `Metadata length (${metadataLength}) is longer than chunk size (${this.chunkSize}). Consider increasing the chunk size or decreasing the size of your metadata to avoid this.`,
+      );
+    } else if (effectiveChunkSize < 50) {
+      console.log(
+        `Metadata length (${metadataLength}) is close to chunk size (${this.chunkSize}). Resulting chunks are less than 50 tokens. Consider increasing the chunk size or decreasing the size of your metadata to avoid this.`,
+      );
+    }
+    return this._splitText(text, effectiveChunkSize);
+  }
+
+  splitText(text: string): string[] {
+    return this._splitText(text, this.chunkSize);
+  }
+
+  _splitText(text: string, chunkSize: number): string[] {
+    if (text === "") return [text];
+
+    const callbackManager = Settings.callbackManager;
+
+    callbackManager.dispatchEvent("chunking-start", {
+      text: [text],
+    });
+    const splits = this.#split(text, chunkSize);
+    const chunks = this.#merge(splits, chunkSize);
+
+    callbackManager.dispatchEvent("chunking-end", {
+      chunks,
+    });
+    return chunks;
+  }
+
+  #split(text: string, chunkSize: number): _Split[] {
+    const tokenSize = this.tokenSize(text);
+    if (tokenSize <= chunkSize) {
+      return [
+        {
+          text,
+          isSentence: true,
+          tokenSize,
+        },
+      ];
+    }
+    const [textSplitsByFns, isSentence] = this.#getSplitsByFns(text);
+    const textSplits: _Split[] = [];
+
+    for (const textSplit of textSplitsByFns) {
+      const tokenSize = this.tokenSize(textSplit);
+      if (tokenSize <= chunkSize) {
+        textSplits.push({
+          text: textSplit,
+          isSentence,
+          tokenSize,
+        });
+      } else {
+        const recursiveTextSplits = this.#split(textSplit, chunkSize);
+        textSplits.push(...recursiveTextSplits);
+      }
+    }
+    return textSplits;
+  }
+
+  #getSplitsByFns(text: string): [splits: string[], isSentence: boolean] {
+    for (const splitFn of this.#splitFns) {
+      const splits = splitFn(text);
+      if (splits.length > 1) {
+        return [splits, true];
+      }
+    }
+    for (const splitFn of this.#subSentenceSplitFns) {
+      const splits = splitFn(text);
+      if (splits.length > 1) {
+        return [splits, false];
+      }
+    }
+    return [[text], true];
+  }
+
+  #merge(splits: _Split[], chunkSize: number): string[] {
+    const chunks: string[] = [];
+    let currentChunk: [string, number][] = [];
+    let lastChunk: [string, number][] = [];
+    let currentChunkLength = 0;
+    let newChunk = true;
+
+    const closeChunk = (): void => {
+      chunks.push(currentChunk.map(([text]) => text).join(""));
+      lastChunk = currentChunk;
+      currentChunk = [];
+      currentChunkLength = 0;
+      newChunk = true;
+
+      let lastIndex = lastChunk.length - 1;
+      while (
+        lastIndex >= 0 &&
+        currentChunkLength + lastChunk[lastIndex][1] <= this.chunkOverlap
+      ) {
+        const [text, length] = lastChunk[lastIndex];
+        currentChunkLength += length;
+        currentChunk.unshift([text, length]);
+        lastIndex -= 1;
+      }
+    };
+
+    while (splits.length > 0) {
+      const curSplit = splits[0];
+      if (curSplit.tokenSize > chunkSize) {
+        throw new Error("Single token exceeded chunk size");
+      }
+      if (currentChunkLength + curSplit.tokenSize > chunkSize && !newChunk) {
+        closeChunk();
+      } else {
+        if (
+          curSplit.isSentence ||
+          currentChunkLength + curSplit.tokenSize <= chunkSize ||
+          newChunk
+        ) {
+          currentChunkLength += curSplit.tokenSize;
+          currentChunk.push([curSplit.text, curSplit.tokenSize]);
+          splits.shift();
+          newChunk = false;
+        } else {
+          closeChunk();
+        }
+      }
+    }
+
+    // Handle the last chunk
+    if (!newChunk) {
+      chunks.push(currentChunk.map(([text]) => text).join(""));
+    }
+
+    return this.#postprocessChunks(chunks);
+  }
+
+  /**
+   * Remove whitespace only chunks and remove leading and trailing whitespace.
+   */
+  #postprocessChunks(chunks: string[]): string[] {
+    const newChunks: string[] = [];
+    for (const chunk of chunks) {
+      const trimmedChunk = chunk.trim();
+      if (trimmedChunk !== "") {
+        newChunks.push(trimmedChunk);
+      }
+    }
+    return newChunks;
+  }
+
+  tokenSize = (text: string) => this.#tokenizer.encode(text).length;
+}

packages/core/src/node-parser/sentence-tokenizer-parser.d.ts

@@ -0,0 +1,5 @@
+declare class SentenceTokenizer {
+  tokenize(text: string): string[];
+}
+
+export { SentenceTokenizer as default };

packages/core/src/node-parser/sentence-window.ts

@@ -0,0 +1,85 @@
+import { randomUUID } from "@llamaindex/env";
+import { z } from "zod";
+import {
+  buildNodeFromSplits,
+  Document,
+  sentenceWindowNodeParserSchema,
+  TextNode,
+} from "../schema";
+import { NodeParser } from "./base";
+import { splitBySentenceTokenizer, type TextSplitterFn } from "./utils";
+
+export class SentenceWindowNodeParser extends NodeParser {
+  static DEFAULT_WINDOW_SIZE = 3;
+  static DEFAULT_WINDOW_METADATA_KEY = "window";
+  static DEFAULT_ORIGINAL_TEXT_METADATA_KEY = "originalText";
+
+  windowSize: number;
+  windowMetadataKey: string;
+  originalTextMetadataKey: string;
+  sentenceSplitter: TextSplitterFn = splitBySentenceTokenizer();
+  idGenerator: () => string = () => randomUUID();
+
+  constructor(params?: z.input<typeof sentenceWindowNodeParserSchema>) {
+    super();
+    if (params) {
+      const parsedParams = sentenceWindowNodeParserSchema.parse(params);
+      this.windowSize = parsedParams.windowSize;
+      this.windowMetadataKey = parsedParams.windowMetadataKey;
+      this.originalTextMetadataKey = parsedParams.originalTextMetadataKey;
+    } else {
+      this.windowSize = SentenceWindowNodeParser.DEFAULT_WINDOW_SIZE;
+      this.windowMetadataKey =
+        SentenceWindowNodeParser.DEFAULT_WINDOW_METADATA_KEY;
+      this.originalTextMetadataKey =
+        SentenceWindowNodeParser.DEFAULT_ORIGINAL_TEXT_METADATA_KEY;
+    }
+  }
+
+  override parseNodes(nodes: TextNode[], showProgress?: boolean): TextNode[] {
+    return nodes.reduce<TextNode[]>((allNodes, node) => {
+      const nodes = this.buildWindowNodesFromDocuments([node]);
+      return allNodes.concat(nodes);
+    }, []);
+  }
+
+  buildWindowNodesFromDocuments(documents: Document[]): TextNode[] {
+    const allNodes: TextNode[] = [];
+
+    for (const doc of documents) {
+      const text = doc.text;
+      const textSplits = this.sentenceSplitter(text);
+      const nodes = buildNodeFromSplits(
+        textSplits,
+        doc,
+        undefined,
+        this.idGenerator,
+      );
+
+      nodes.forEach((node, i) => {
+        const windowNodes = nodes.slice(
+          Math.max(0, i - this.windowSize),
+          Math.min(i + this.windowSize + 1, nodes.length),
+        );
+
+        node.metadata[this.windowMetadataKey] = windowNodes
+          .map((n) => n.text)
+          .join(" ");
+        node.metadata[this.originalTextMetadataKey] = node.text;
+
+        node.excludedEmbedMetadataKeys.push(
+          this.windowMetadataKey,
+          this.originalTextMetadataKey,
+        );
+        node.excludedLlmMetadataKeys.push(
+          this.windowMetadataKey,
+          this.originalTextMetadataKey,
+        );
+      });
+
+      allNodes.push(...nodes);
+    }
+
+    return allNodes;
+  }
+}

packages/core/src/node-parser/type.ts

@@ -0,0 +1,5 @@
+import type { Tokenizer } from "@llamaindex/env";
+
+export type SplitterParams = {
+  tokenizer?: Tokenizer;
+};

packages/core/src/node-parser/utils.ts

@@ -0,0 +1,53 @@
+import type { TextSplitter } from "./base";
+import SentenceTokenizerNew from "./sentence-tokenizer-parser.js";
+
+export type TextSplitterFn = (text: string) => string[];
+
+const truncateText = (text: string, textSplitter: TextSplitter): string => {
+  const chunks = textSplitter.splitText(text);
+  return chunks[0];
+};
+
+const splitTextKeepSeparator = (text: string, separator: string): string[] => {
+  const parts = text.split(separator);
+  const result = parts.map((part, index) =>
+    index > 0 ? separator + part : part,
+  );
+  return result.filter((s) => s);
+};
+
+export const splitBySep = (
+  sep: string,
+  keepSep: boolean = true,
+): TextSplitterFn => {
+  if (keepSep) {
+    return (text: string) => splitTextKeepSeparator(text, sep);
+  } else {
+    return (text: string) => text.split(sep);
+  }
+};
+
+export const splitByChar = (): TextSplitterFn => {
+  return (text: string) => text.split("");
+};
+
+let sentenceTokenizer: SentenceTokenizerNew | null = null;
+
+export const splitBySentenceTokenizer = (): TextSplitterFn => {
+  if (!sentenceTokenizer) {
+    sentenceTokenizer = new SentenceTokenizerNew();
+  }
+  const tokenizer = sentenceTokenizer;
+  return (text: string) => {
+    return tokenizer.tokenize(text);
+  };
+};
+
+export const splitByRegex = (regex: string): TextSplitterFn => {
+  return (text: string) => text.match(new RegExp(regex, "g")) || [];
+};
+
+export const splitByPhraseRegex = (): TextSplitterFn => {
+  const regex = "[^,.;]+[,.;]?";
+  return splitByRegex(regex);
+};