feat: use ink to render workflow

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

.github/workflows/test.yml

@@ -87,6 +87,30 @@ jobs:
         run: pnpm run type-check
       - name: Run Circular Dependency Check
         run: pnpm run circular-check
+  e2e-npm:
+    runs-on: ubuntu-latest
+    name: Test using packages with npm
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build packages
+        run: pnpm run build
+      - name: Pack packages
+        run: |
+          pnpm pack --pack-destination ${{ runner.temp }} -C packages/llamaindex
+          pnpm pack --pack-destination ${{ runner.temp }} -C packages/workflow
+      - name: Install packed packages
+        run: npm add ${{ runner.temp }}/*.tgz
+        working-directory: e2e/npm
+      - name: Run tests
+        run: npm test
+        working-directory: e2e/npm
   e2e-llamaindex-examples:
     strategy:
       fail-fast: false

README.md

@@ -7,9 +7,10 @@
 </h3>
 
 [![NPM Version](https://img.shields.io/npm/v/llamaindex)](https://www.npmjs.com/package/llamaindex)
-[![NPM License](https://img.shields.io/npm/l/llamaindex)](https://www.npmjs.com/package/llamaindex)
+[![NPM License](https://img.shields.io/npm/l/llamaindex)](https://github.com/run-llama/LlamaIndexTS/blob/main/LICENSE)
 [![NPM Downloads](https://img.shields.io/npm/dm/llamaindex)](https://www.npmjs.com/package/llamaindex)
 [![Discord](https://img.shields.io/discord/1059199217496772688)](https://discord.com/invite/eN6D2HQ4aX)
+[![Twitter](https://img.shields.io/twitter/follow/llama_index)](https://x.com/llama_index)
 
 Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in JS runtime environments with TypeScript support.
 
@@ -63,7 +64,7 @@ yarn add llamaindex
 
 ### Setup in Node.js, Deno, Bun, TypeScript...?
 
-See our official document: <https://ts.llamaindex.ai/docs/llamaindex/getting_started/>
+See our official document: https://ts.llamaindex.ai/docs/llamaindex/getting_started
 
 ### Adding provider packages
 
@@ -83,19 +84,7 @@ Check out our NextJS playground at https://llama-playground.vercel.app/. The sou
 
 ## Core concepts for getting started:
 
-- [Document](/packages/llamaindex/src/Node.ts): A document represents a text file, PDF file or other contiguous piece of data.
-
-- [Node](/packages/llamaindex/src/Node.ts): The basic data building block. Most commonly, these are parts of the document split into manageable pieces that are small enough to be fed into an embedding model and LLM.
-
-- [Embedding](/packages/llamaindex/src/embeddings/OpenAIEmbedding.ts): Embeddings are sets of floating point numbers which represent the data in a Node. By comparing the similarity of embeddings, we can derive an understanding of the similarity of two pieces of data. One use case is to compare the embedding of a question with the embeddings of our Nodes to see which Nodes may contain the data needed to answer that question. Because the default service context is OpenAI, the default embedding is `OpenAIEmbedding`. If using different models, say through Ollama, use this [Embedding](/packages/llamaindex/src/embeddings/OllamaEmbedding.ts) (see all [here](/packages/llamaindex/src/embeddings)).
-
-- [Indices](/packages/llamaindex/src/indices/): Indices store the Nodes and the embeddings of those nodes. QueryEngines retrieve Nodes from these Indices using embedding similarity.
-
-- [QueryEngine](/packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts): Query engines are what generate the query you put in and give you back the result. Query engines generally combine a pre-built prompt with selected Nodes from your Index to give the LLM the context it needs to answer your query. To build a query engine from your Index (recommended), use the [`asQueryEngine`](/packages/llamaindex/src/indices/BaseIndex.ts) method on your Index. See all query engines [here](/packages/llamaindex/src/engines/query).
-
-- [ChatEngine](/packages/llamaindex/src/engines/chat/SimpleChatEngine.ts): A ChatEngine helps you build a chatbot that will interact with your Indices. See all chat engines [here](/packages/llamaindex/src/engines/chat).
-
-- [SimplePrompt](/packages/llamaindex/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
+See our documentation: https://ts.llamaindex.ai/docs/llamaindex/getting_started/concepts
 
 ## Contributing:
 

apps/next/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @llamaindex/doc
 
+## 0.2.19
+
+### Patch Changes
+
+- Updated dependencies [680b529]
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+- Updated dependencies [3e66ddc]
+  - @llamaindex/workflow@1.1.3
+  - @llamaindex/core@0.6.6
+  - llamaindex@0.11.0
+  - @llamaindex/openai@0.4.0
+  - @llamaindex/cloud@4.0.8
+  - @llamaindex/node-parser@2.0.6
+  - @llamaindex/readers@3.1.4
+
+## 0.2.18
+
+### Patch Changes
+
+- d671ed6: Add functionality for search params when querying Qdrant vector store.
+- Updated dependencies [76c9a80]
+- Updated dependencies [168d11f]
+- Updated dependencies [d671ed6]
+- Updated dependencies [40f5f41]
+  - @llamaindex/openai@0.3.7
+  - @llamaindex/workflow@1.1.2
+  - @llamaindex/core@0.6.5
+  - @llamaindex/cloud@4.0.7
+  - llamaindex@0.10.6
+  - @llamaindex/node-parser@2.0.5
+  - @llamaindex/readers@3.1.3
+
 ## 0.2.17
 
 ### Patch Changes

apps/next/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/doc",
-  "version": "0.2.17",
+  "version": "0.2.19",
   "private": true,
   "scripts": {
     "postinstall": "fumadocs-mdx",

apps/next/scripts/validate-links.mts

@@ -4,7 +4,6 @@ import matter from "gray-matter";
 import path from "path";
 
 const CONTENT_DIR = path.join(process.cwd(), "src/content/docs");
-const BUILD_DIR = path.join(process.cwd(), ".next");
 
 // Regular expression to find internal links
 // This captures Markdown links [text](/docs/path) and href attributes href="/docs/path"
@@ -14,6 +13,8 @@ const INTERNAL_LINK_REGEX = /(?:(?:\]\(|\bhref=["'])\/docs\/([^")]+))/g;
 // This captures relative links like [text](./path) or ![alt](../images/image.png)
 const RELATIVE_LINK_REGEX = /(?:\]\()(?:\s*)(?:\.\.?)\//g;
 
+const ALLOWED_LINKS = ["/docs/llamaflow"];
+
 interface LinkValidationResult {
   file: string;
   invalidLinks: Array<{ link: string; line: number }>;
@@ -28,7 +29,7 @@ interface RelativeLinkResult {
  * Get all valid documentation routes from the content directory
  */
 async function getValidRoutes(): Promise<Set<string>> {
-  const mdxFiles = await glob("**/*.mdx?", { cwd: CONTENT_DIR });
+  const mdxFiles = await glob("**/*.{md,mdx}", { cwd: CONTENT_DIR });
 
   const routes = new Set<string>();
 
@@ -124,14 +125,11 @@ function findRelativeLinksInFile(
   return relativeLinks;
 }
 
-/**
- * Validate internal links in all MDX files
- */
 /**
  * Find relative links in all MDX files
  */
 async function findRelativeLinks(): Promise<RelativeLinkResult[]> {
-  const mdxFiles = await glob("**/*.mdx?", { cwd: CONTENT_DIR });
+  const mdxFiles = await glob("**/*.mdx", { cwd: CONTENT_DIR });
   const results: RelativeLinkResult[] = [];
 
   for (const file of mdxFiles) {
@@ -150,7 +148,7 @@ async function findRelativeLinks(): Promise<RelativeLinkResult[]> {
 }
 
 async function validateLinks(): Promise<LinkValidationResult[]> {
-  const mdxFiles = await glob("**/*.mdx?", { cwd: CONTENT_DIR });
+  const mdxFiles = await glob("**/*.mdx", { cwd: CONTENT_DIR });
   const validRoutes = await getValidRoutes();
 
   const results: LinkValidationResult[] = [];
@@ -160,6 +158,11 @@ async function validateLinks(): Promise<LinkValidationResult[]> {
     const links = extractLinksFromFile(filePath);
 
     const invalidLinks = links.filter(({ link }) => {
+      // Check if the link is in the allowed list
+      if (ALLOWED_LINKS.includes(`/docs/${link}`)) {
+        return false;
+      }
+
       // Check if the link exists in valid routes
       // First normalize the link (remove any query string or hash)
       const baseLink = link.split("?")[0].split("#")[0];

apps/next/src/content/docs/llamaindex/getting_started/concepts.mdx

@@ -0,0 +1,60 @@
+---
+title: High-Level Concepts
+---
+
+This is a quick guide to the high-level concepts you'll encounter frequently when building LLM applications.
+
+## Large Language Models (LLMs)
+
+LLMs are the fundamental innovation that launched LlamaIndex. They are an artificial intelligence (AI) computer system that can understand, generate, and manipulate natural language, including answering questions based on their training data or data provided to them at query time. 
+
+## Agentic Applications
+
+When an LLM is used within an application, it is often used to make decisions, take actions, and/or interact with the world. This is the core definition of an **agentic application**.
+
+While the definition of an agentic application is broad, there are several key characteristics that define an agentic application:
+
+- **LLM Augmentation**: The LLM is augmented with tools (i.e. arbitrary callable functions in code), memory, and/or dynamic prompts.
+- **Prompt Chaining**: Several LLM calls are used that build on each other, with the output of one LLM call being used as the input to the next.
+- **Routing**: The LLM is used to route the application to the next appropriate step or state in the application.
+- **Parallelism**: The application can perform multiple steps or actions in parallel.
+- **Orchestration**: A hierarchical structure of LLMs is used to orchestrate lower-level actions and LLMs.
+- **Reflection**: The LLM is used to reflect and validate outputs of previous steps or LLM calls, which can be used to guide the application to the next appropriate step or state.
+
+In LlamaIndex, you can build agentic applications by using the workflows to orchestrate a sequence of steps and LLMs. You can [learn more about workflows](/docs/llamaindex/tutorials/workflows).
+
+## Agents
+
+We define an agent as a specific instance of an "agentic application". An agent is a piece of software that semi-autonomously performs tasks by combining LLMs with other tools and memory, orchestrated in a reasoning loop that decides which tool to use next (if any).
+
+What this means in practice, is something like:
+- An agent receives a user message
+- The agent uses an LLM to determine the next appropriate action to take using the previous chat history, tools, and the latest user message
+- The agent may invoke one or more tools to assist in the users request
+- If tools are used, the agent will then interpret the tool outputs and use them to inform the next action
+- Once the agent stops taking actions, it returns the final output to the user
+
+You can [learn more about agents](/docs/llamaindex/tutorials/basic_agent).
+
+## Retrieval Augmented Generation (RAG)
+
+Retrieval-Augmented Generation (RAG) is a core technique for building data-backed LLM applications with LlamaIndex. It allows LLMs to answer questions about your private data by providing it to the LLM at query time, rather than training the LLM on your data. To avoid sending **all** of your data to the LLM every time, RAG indexes your data and selectively sends only the relevant parts along with your query. You can [learn more about RAG](/docs/llamaindex/tutorials/rag).
+
+## Use cases
+
+There are endless use cases for data-backed LLM applications but they can be roughly grouped into four categories:
+
+[**Agents**](/docs/llamaindex/tutorials/basic_agent):
+An agent is an automated decision-maker powered by an LLM that interacts with the world via a set of [tools](/docs/llamaindex/modules/agents/tool). Agents can take an arbitrary number of steps to complete a given task, dynamically deciding on the best course of action rather than following pre-determined steps. This gives it additional flexibility to tackle more complex tasks.
+
+[**Workflows**](/docs/llamaindex/tutorials/workflows):
+A Workflow in LlamaIndex is a specific event-driven abstraction that allows you to orchestrate a sequence of steps and LLMs calls. Workflows can be used to implement any agentic application, and are a core component of LlamaIndex.
+
+[**Structured Data Extraction**](/docs/llamaindex/tutorials/structured_data_extraction):
+Pydantic extractors allow you to specify a precise data structure to extract from your data and use LLMs to fill in the missing pieces in a type-safe way. This is useful for extracting structured data from unstructured sources like PDFs, websites, and more, and is key to automating workflows.
+
+[**Query Engines**](/docs/llamaindex/modules/rag/query_engines):
+A query engine is an end-to-end flow that allows you to ask questions over your data. It takes in a natural language query, and returns a response, along with reference context retrieved and passed to the LLM.
+
+[**Chat Engines**](/docs/llamaindex/modules/rag/chat_engine):
+A chat engine is an end-to-end flow for having a conversation with your data (multiple back-and-forth instead of a single question-and-answer).

apps/next/src/content/docs/llamaindex/getting_started/meta.json

@@ -1,4 +1,4 @@
 {
   "title": "Getting Started",
-  "pages": ["installation", "create_llama", "examples"]
+  "pages": ["concepts", "installation", "create_llama", "examples"]
 }

apps/next/src/content/docs/llamaindex/modules/agents/workflows.mdx

@@ -12,7 +12,7 @@ To use workflows install this package:
 npm i @llamaindex/workflow
 ```
 
-This package is a stable, production-ready version of our [llama-flow](../../../llamaflow) project. 
+This package is a stable, production-ready version of our [llama-flow](/docs/llamaflow) project. 
 
 While you can still reference the llama-flow documentation for detailed information about the underlying concepts, we recommend using the `@llamaindex/workflow` package for all new projects to ensure stability and long-term availability.
 

apps/next/src/content/docs/llamaindex/modules/data/readers/discord.mdx

@@ -18,7 +18,7 @@ In your Discord Application, go to the `OAuth2` tab and generate an invite URL b
 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.
 
-<include cwd>../../examples/discord/reader.ts</include>
+<include cwd>../../examples/readers/discord/reader.ts</include>
 
 ### Params
 

apps/next/src/content/docs/llamaindex/modules/data/stores/vector_stores/qdrant.mdx

@@ -88,7 +88,7 @@ async function main() {
 
   const response = await queryEngine.query({
     query: "What did the author do in college?",
-  });
+  }); // Additional filters and params can be passed as options
 
   // Output response
   console.log(response.toString());

apps/next/src/content/docs/llamaindex/modules/models/llms/azure.mdx

@@ -2,89 +2,43 @@
 title: Azure OpenAI
 ---
 
-To use Azure OpenAI, you only need to set a few environment variables together with the `OpenAI` class.
-
-For example:
-
-## Environment Variables
-
-```
-export AZURE_OPENAI_KEY="<YOUR KEY HERE>"
-export AZURE_OPENAI_ENDPOINT="<YOUR ENDPOINT, see https://learn.microsoft.com/en-us/azure/ai-services/openai/quickstart?tabs=command-line%2Cpython&pivots=rest-api>"
-export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name
-```
+To use Azure OpenAI, you only need to install the `@llamaindex/azure` package:
 
 ## Installation
 
 ```package-install
-npm i llamaindex @llamaindex/openai
+npm i llamaindex @llamaindex/azure
 ```
 
 ## Usage
 
+The class `AzureOpenAI` is used for setting the LLM and `AzureOpenAIEmbedding` is used for setting the embedding model, e.g.:
+
 ```ts
 import { Settings } from "llamaindex";
-import { OpenAI } from "@llamaindex/openai";
+import { AzureOpenAI, AzureOpenAIEmbedding } from "@llamaindex/azure";
 
-Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
-```
-
-## Load and index documents
-
-For this example, we will use a single document. In a real-world scenario, you would have multiple documents to index.
-
-```ts
-const document = new Document({ text: essay, id_: "essay" });
-
-const index = await VectorStoreIndex.fromDocuments([document]);
-```
-
-## Query
-
-```ts
-const queryEngine = index.asQueryEngine();
-
-const query = "What is the meaning of life?";
-
-const results = await queryEngine.query({
-  query,
+Settings.llm = new AzureOpenAI({ 
+  apiKey: '[key]',
+  deployment: '[model]',
+  apiVersion: '[version]',
+  endpoint: `https://[deployment].openai.azure.com/`, 
+});
+Settings.embedModel = new AzureOpenAIEmbedding({
+  apiKey: '[key]',
+  deployment: '[embedding-model]',
+  apiVersion: '[version]',
+  endpoint: `https://[deployment].openai.azure.com/`, 
 });
 ```
 
-## Full Example
+Instead of explicitly setting the API key, deployment, version, and endpoint in the constructor, you can use the following environment variables: `AZURE_OPENAI_DEPLOYMENT` for the model deployment name, `AZURE_OPENAI_KEY` for your API key, `AZURE_OPENAI_ENDPOINT` for your Azure endpoint URL, and `AZURE_OPENAI_API_VERSION` for the API version.
 
-```ts
-import { Document, VectorStoreIndex, Settings } from "llamaindex";
-import { OpenAI } from "@llamaindex/openai";
+## Examples
 
-Settings.llm = new OpenAI({ model: "gpt-4", temperature: 0 });
-
-async function main() {
-  const document = new Document({ text: essay, id_: "essay" });
-
-  // Load and index documents
-  const index = await VectorStoreIndex.fromDocuments([document]);
-
-  // get retriever
-  const retriever = index.asRetriever();
-
-  // Create a query engine
-  const queryEngine = index.asQueryEngine({
-    retriever,
-  });
-
-  const query = "What is the meaning of life?";
-
-  // Query
-  const response = await queryEngine.query({
-    query,
-  });
-
-  // Log the response
-  console.log(response.response);
-}
-```
+See the [Azure examples](https://github.com/run-llama/LlamaIndexTS/tree/main/examples/storage/azure) for more examples of how to use Azure OpenAI.
 
 ## API Reference
 
-- [OpenAI](/docs/api/classes/OpenAI)
+- [AzureOpenAI](/docs/api/classes/AzureOpenAI)
+- [AzureOpenAIEmbedding](/docs/api/classes/AzureOpenAIEmbedding)

apps/next/src/content/docs/llamaindex/modules/models/llms/groq.mdx

@@ -55,7 +55,7 @@ const results = await queryEngine.query({
 
 ## Full Example
 
-<include cwd>../../examples/groq.ts</include>
+<include cwd>../../examples/models/groq.ts</include>
 
 ## API Reference
 

apps/next/src/content/docs/llamaindex/modules/ui/llamaindex-server.mdx

@@ -166,4 +166,4 @@ Want to start a new project with LlamaIndexServer? Check out our [create-llama](
 
 ## API Reference
 
-- [LlamaIndexServer](/docs/api/classes/LlamaIndexServer)
+- [LlamaIndexServer](https://github.com/run-llama/create-llama/blob/main/packages/server)

apps/next/src/content/docs/llamaindex/tutorials/rag/index.mdx

@@ -27,7 +27,7 @@ Create the file `example.ts`. This code will
 - index it (which creates embeddings using OpenAI)
 - create a query engine to answer questions about the data
 
-<include cwd>../../examples/vectorIndex.ts</include>
+<include cwd>../../examples/index/vectorIndex.ts</include>
 
 Create a `tsconfig.json` file in the same folder:
 

apps/next/src/content/docs/llamaindex/tutorials/structured_data_extraction.mdx

@@ -24,7 +24,7 @@ Create the file `example.ts`. This code will:
 - Give an example of the data structure we wish to generate
 - Prompt the LLM with instructions and the example, plus a sample transcript
 
-<include cwd>../../examples/jsonExtract.ts</include>
+<include cwd>../../examples/misc/jsonExtract.ts</include>
 
 To run the code:
 

e2e/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @llamaindex/core-e2e
 
+## 0.1.1
+
+### Patch Changes
+
+- b0cd530: # Breaking Change
+
+  ## What Changed
+
+  Remove default setting of llm and embedModel in Settings
+
+  ## Migration Guide
+
+  Set the llm provider and embed Model in the top of your code using Settings.llm = and Settings.embedModel
+
 ## 0.1.0
 
 ### Minor Changes

e2e/examples/cloudflare-worker-agent/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @llamaindex/cloudflare-worker-agent-test
 
+## 0.0.161
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+
+## 0.0.160
+
+### Patch Changes
+
+- llamaindex@0.10.6
+
 ## 0.0.159
 
 ### Patch Changes

e2e/examples/cloudflare-worker-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/cloudflare-worker-agent-test",
-  "version": "0.0.159",
+  "version": "0.0.161",
   "type": "module",
   "private": true,
   "scripts": {

e2e/examples/llama-parse-browser/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @llamaindex/llama-parse-browser-test
 
+## 0.0.63
+
+### Patch Changes
+
+- @llamaindex/cloud@4.0.8
+
+## 0.0.62
+
+### Patch Changes
+
+- Updated dependencies [40f5f41]
+  - @llamaindex/cloud@4.0.7
+
 ## 0.0.61
 
 ### Patch Changes

e2e/examples/llama-parse-browser/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/llama-parse-browser-test",
   "private": true,
-  "version": "0.0.61",
+  "version": "0.0.63",
   "type": "module",
   "scripts": {
     "dev": "vite",

e2e/examples/nextjs-agent/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @llamaindex/next-agent-test
 
+## 0.1.161
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+
+## 0.1.160
+
+### Patch Changes
+
+- llamaindex@0.10.6
+
 ## 0.1.159
 
 ### Patch Changes

e2e/examples/nextjs-agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-agent-test",
-  "version": "0.1.159",
+  "version": "0.1.161",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-agent/src/actions/index.tsx

@@ -1,7 +1,7 @@
 "use server";
+import { OpenAIAgent } from "@llamaindex/openai";
 import { createStreamableUI } from "ai/rsc";
 import type { ChatMessage } from "llamaindex";
-import { OpenAIAgent } from "llamaindex";
 
 export async function chatWithAgent(
   question: string,

e2e/examples/nextjs-edge-runtime/CHANGELOG.md

@@ -1,5 +1,19 @@
 # test-edge-runtime
 
+## 0.1.160
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+
+## 0.1.159
+
+### Patch Changes
+
+- llamaindex@0.10.6
+
 ## 0.1.158
 
 ### Patch Changes

e2e/examples/nextjs-edge-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/nextjs-edge-runtime-test",
-  "version": "0.1.158",
+  "version": "0.1.160",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-node-runtime/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @llamaindex/next-node-runtime
 
+## 0.1.28
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+  - @llamaindex/huggingface@0.1.10
+  - @llamaindex/readers@3.1.4
+
+## 0.1.27
+
+### Patch Changes
+
+- Updated dependencies [76c9a80]
+  - @llamaindex/huggingface@0.1.9
+  - llamaindex@0.10.6
+  - @llamaindex/readers@3.1.3
+
 ## 0.1.26
 
 ### Patch Changes

e2e/examples/nextjs-node-runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/next-node-runtime-test",
-  "version": "0.1.26",
+  "version": "0.1.28",
   "private": true,
   "scripts": {
     "dev": "next dev",

e2e/examples/nextjs-node-runtime/src/actions/openai.ts

@@ -1,7 +1,8 @@
 "use server";
 import { HuggingFaceEmbedding } from "@llamaindex/huggingface";
+import { OpenAI, OpenAIAgent } from "@llamaindex/openai";
 import { SimpleDirectoryReader } from "@llamaindex/readers/directory";
-import { OpenAI, OpenAIAgent, Settings, VectorStoreIndex } from "llamaindex";
+import { Settings, VectorStoreIndex } from "llamaindex";
 
 Settings.llm = new OpenAI({
   apiKey: process.env.NEXT_PUBLIC_OPENAI_KEY ?? "FAKE_KEY_TO_PASS_TESTS",

e2e/examples/vite-import-llamaindex/CHANGELOG.md

@@ -1,5 +1,19 @@
 # vite-import-llamaindex
 
+## 0.0.27
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+
+## 0.0.26
+
+### Patch Changes
+
+- llamaindex@0.10.6
+
 ## 0.0.25
 
 ### Patch Changes

e2e/examples/vite-import-llamaindex/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-import-llamaindex",
   "private": true,
-  "version": "0.0.25",
+  "version": "0.0.27",
   "type": "module",
   "scripts": {
     "build": "vite build",

e2e/examples/vite-import-llamaindex/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/main.ts","./vite.config.ts"],"version":"5.7.3"}

e2e/examples/waku-query-engine/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @llamaindex/waku-query-engine-test
 
+## 0.0.161
+
+### Patch Changes
+
+- Updated dependencies [b0cd530]
+- Updated dependencies [361a685]
+  - llamaindex@0.11.0
+
+## 0.0.160
+
+### Patch Changes
+
+- llamaindex@0.10.6
+
 ## 0.0.159
 
 ### Patch Changes

e2e/examples/waku-query-engine/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@llamaindex/waku-query-engine-test",
-  "version": "0.0.159",
+  "version": "0.0.161",
   "type": "module",
   "private": true,
   "scripts": {

e2e/node/embedding/clip.e2e.ts

@@ -1,6 +1,7 @@
 import { ClipEmbedding } from "@llamaindex/clip";
 import type { LoadTransformerEvent } from "@llamaindex/env/multi-model";
 import { setTransformers } from "@llamaindex/env/multi-model";
+import { OpenAIEmbedding } from "@llamaindex/openai";
 import { ImageNode, Settings } from "llamaindex";
 import assert from "node:assert";
 import { type Mock, test } from "node:test";
@@ -19,6 +20,7 @@ test.before(() => {
 
 test.beforeEach(() => {
   callback.mock.resetCalls();
+  Settings.embedModel = new OpenAIEmbedding();
 });
 
 await test.skip("clip embedding", async (t) => {

e2e/node/issue.e2e.ts

@@ -1,10 +1,6 @@
 import type { TaskStep } from "@llamaindex/core/agent";
-import {
-  LLMSingleSelector,
-  OpenAIAgent,
-  Settings,
-  type ChatMessage,
-} from "llamaindex";
+import { OpenAIAgent } from "@llamaindex/openai";
+import { LLMSingleSelector, Settings, type ChatMessage } from "llamaindex";
 import assert from "node:assert";
 import { test } from "node:test";
 import { divideNumbersTool, sumNumbersTool } from "./fixtures/tools.js";

e2e/node/openai.e2e.ts

@@ -1,11 +1,10 @@
 import { extractText } from "@llamaindex/core/utils";
+import { OpenAI, OpenAIAgent } from "@llamaindex/openai";
 import { consola } from "consola";
 import {
   Document,
   FunctionTool,
   ObjectIndex,
-  OpenAI,
-  OpenAIAgent,
   QueryEngineTool,
   SentenceSplitter,
   Settings,

e2e/node/react.e2e.ts

@@ -1,5 +1,6 @@
 import { extractText } from "@llamaindex/core/utils";
-import { OpenAI, ReActAgent, Settings, type LLM } from "llamaindex";
+import { OpenAI } from "@llamaindex/openai";
+import { ReActAgent, Settings, type LLM } from "llamaindex";
 import { ok } from "node:assert";
 import { beforeEach, test } from "node:test";
 import { getWeatherTool } from "./fixtures/tools.js";

e2e/node/vector-store/pg-vector-store.e2e.ts

@@ -1,8 +1,9 @@
+import { OpenAIEmbedding } from "@llamaindex/openai";
 import { PGVectorStore } from "@llamaindex/postgres";
 import { config } from "dotenv";
-import { Document, VectorStoreQueryMode } from "llamaindex";
+import { Document, Settings, VectorStoreQueryMode } from "llamaindex";
 import assert from "node:assert";
-import { test } from "node:test";
+import { beforeEach, test } from "node:test";
 import pg from "pg";
 import { registerTypes } from "pgvector/pg";
 
@@ -14,6 +15,10 @@ const pgConfig = {
   database: "llamaindex_node_test",
 };
 
+beforeEach(async () => {
+  Settings.embedModel = new OpenAIEmbedding();
+});
+
 await test("init with client", async (t) => {
   const pgClient = new pg.Client(pgConfig);
   await pgClient.connect();

e2e/npm/.gitignore

@@ -0,0 +1 @@
+package-lock.json

e2e/npm/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "e2e-npm",
+  "private": true,
+  "scripts": {
+    "test": "node --import tsx --test test/*.e2e.ts"
+  },
+  "dependencies": {
+    "@llamaindex/workflow": "1.1.1",
+    "llamaindex": "0.10.5",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "tsx": "^4.19.1",
+    "@types/node": "^22.9.0"
+  }
+}

e2e/npm/test/workflow.e2e.ts

@@ -0,0 +1,29 @@
+import { OpenAI } from "@llamaindex/openai";
+import { agent } from "@llamaindex/workflow";
+import { Settings, tool } from "llamaindex";
+import { ok } from "node:assert";
+import { test } from "node:test";
+import { z } from "zod";
+
+Settings.llm = new OpenAI({ model: "gpt-4-0613" });
+
+test("creating agent from workflow package", async () => {
+  const calculatorAgent = agent({
+    tools: [
+      tool({
+        name: "add",
+        description: "Adds two numbers",
+        parameters: z.object({ x: z.number(), y: z.number() }),
+        execute: ({ x, y }) => x + y,
+      }),
+    ],
+  });
+  ok(calculatorAgent !== undefined, "calculatorAgent should be defined");
+
+  const agents = calculatorAgent.getAgents();
+  const currentLLM = agents?.[0].llm;
+  ok(
+    (currentLLM as OpenAI)?.model === (Settings.llm as OpenAI)?.model,
+    "Agent should use the same LLM model as setup in Settings instance",
+  );
+});

e2e/npm/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "moduleResolution": "node16",
+    "target": "ESNext",
+    "types": ["node"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["test/**/*.ts"]
+}

e2e/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@llamaindex/e2e",
   "private": true,
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "scripts": {
     "e2e": "node --import tsx --import ./mock-register.js --test ./node/**/*.e2e.ts",

examples/.gitignore

@@ -1,3 +1,2 @@
 package-lock.json
-storage
-tmp_data
+tmp_data

examples/CHANGELOG.md

@@ -1,5 +1,117 @@
 # examples
 
+## 0.3.16
+
+### Patch Changes
+
+- Updated dependencies [680b529]
+- Updated dependencies [b0cd530]
+- Updated dependencies [c73c659]
+- Updated dependencies [361a685]
+- Updated dependencies [3e66ddc]
+  - @llamaindex/workflow@1.1.3
+  - @llamaindex/core@0.6.6
+  - llamaindex@0.11.0
+  - @llamaindex/qdrant@0.1.15
+  - @llamaindex/azure@0.1.16
+  - @llamaindex/openai@0.4.0
+  - @llamaindex/cloud@4.0.8
+  - @llamaindex/node-parser@2.0.6
+  - @llamaindex/anthropic@0.3.7
+  - @llamaindex/assemblyai@0.1.5
+  - @llamaindex/clip@0.0.56
+  - @llamaindex/cohere@0.0.20
+  - @llamaindex/deepinfra@0.0.56
+  - @llamaindex/discord@0.1.5
+  - @llamaindex/google@0.3.2
+  - @llamaindex/huggingface@0.1.10
+  - @llamaindex/jinaai@0.0.16
+  - @llamaindex/mistral@0.1.6
+  - @llamaindex/mixedbread@0.0.20
+  - @llamaindex/notion@0.1.5
+  - @llamaindex/ollama@0.1.6
+  - @llamaindex/perplexity@0.0.13
+  - @llamaindex/portkey-ai@0.0.48
+  - @llamaindex/replicate@0.0.48
+  - @llamaindex/astra@0.0.20
+  - @llamaindex/chroma@0.0.20
+  - @llamaindex/elastic-search@0.1.6
+  - @llamaindex/firestore@1.0.13
+  - @llamaindex/milvus@0.1.15
+  - @llamaindex/mongodb@0.0.21
+  - @llamaindex/pinecone@0.1.6
+  - @llamaindex/postgres@0.0.49
+  - @llamaindex/supabase@0.1.5
+  - @llamaindex/upstash@0.0.20
+  - @llamaindex/weaviate@0.0.20
+  - @llamaindex/vercel@0.1.6
+  - @llamaindex/voyage-ai@1.0.12
+  - @llamaindex/readers@3.1.4
+  - @llamaindex/tools@0.0.11
+  - @llamaindex/deepseek@0.0.16
+  - @llamaindex/fireworks@0.0.16
+  - @llamaindex/groq@0.0.71
+  - @llamaindex/together@0.0.16
+  - @llamaindex/vllm@0.0.42
+  - @llamaindex/xai@0.0.3
+
+## 0.3.15
+
+### Patch Changes
+
+- d671ed6: Add functionality for search params when querying Qdrant vector store.
+- Updated dependencies [7a7ca60]
+- Updated dependencies [7a7ca60]
+- Updated dependencies [76c9a80]
+- Updated dependencies [168d11f]
+- Updated dependencies [d671ed6]
+- Updated dependencies [40f5f41]
+  - @llamaindex/xai@0.0.2
+  - @llamaindex/fireworks@0.0.15
+  - @llamaindex/elastic-search@0.1.5
+  - @llamaindex/firestore@1.0.12
+  - @llamaindex/pinecone@0.1.5
+  - @llamaindex/postgres@0.0.48
+  - @llamaindex/supabase@0.1.4
+  - @llamaindex/weaviate@0.0.19
+  - @llamaindex/mongodb@0.0.20
+  - @llamaindex/upstash@0.0.19
+  - @llamaindex/chroma@0.0.19
+  - @llamaindex/milvus@0.1.14
+  - @llamaindex/qdrant@0.1.14
+  - @llamaindex/astra@0.0.19
+  - @llamaindex/azure@0.1.15
+  - @llamaindex/huggingface@0.1.9
+  - @llamaindex/assemblyai@0.1.4
+  - @llamaindex/mixedbread@0.0.19
+  - @llamaindex/perplexity@0.0.12
+  - @llamaindex/portkey-ai@0.0.47
+  - @llamaindex/anthropic@0.3.6
+  - @llamaindex/deepinfra@0.0.55
+  - @llamaindex/replicate@0.0.47
+  - @llamaindex/voyage-ai@1.0.11
+  - @llamaindex/discord@0.1.4
+  - @llamaindex/mistral@0.1.5
+  - @llamaindex/cohere@0.0.19
+  - @llamaindex/google@0.3.1
+  - @llamaindex/jinaai@0.0.15
+  - @llamaindex/notion@0.1.4
+  - @llamaindex/ollama@0.1.5
+  - @llamaindex/openai@0.3.7
+  - @llamaindex/vercel@0.1.5
+  - @llamaindex/clip@0.0.55
+  - @llamaindex/tools@0.0.10
+  - @llamaindex/workflow@1.1.2
+  - @llamaindex/core@0.6.5
+  - @llamaindex/cloud@4.0.7
+  - llamaindex@0.10.6
+  - @llamaindex/deepseek@0.0.15
+  - @llamaindex/groq@0.0.70
+  - @llamaindex/together@0.0.15
+  - @llamaindex/vllm@0.0.41
+  - @llamaindex/node-parser@2.0.5
+  - @llamaindex/readers@3.1.3
+
 ## 0.3.14
 
 ### 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 tsx ./chatEngine.ts
+npx tsx ./rag/chatEngine.ts
 ```
 
 ## Build your own RAG app

examples/agents/agent/multiple-agents.ts

@@ -92,7 +92,7 @@ async function multiWeatherAgent() {
       agentInputEvent.include(event) ||
       stopAgentEvent.include(event)
     ) {
-      console.log(event);
+      console.log(event.data);
     } else if (agentStreamEvent.include(event)) {
       for (const chunk of event.data.delta) {
         process.stdout.write(chunk);

examples/agents/agent/query-tool.ts

@@ -1,9 +1,10 @@
+import { openai } from "@llamaindex/openai";
 import {
   agent,
   agentStreamEvent,
   agentToolCallResultEvent,
 } from "@llamaindex/workflow";
-import { Document, VectorStoreIndex, openai } from "llamaindex";
+import { Document, VectorStoreIndex } from "llamaindex";
 
 async function main() {
   const index = await VectorStoreIndex.fromDocuments([

examples/agents/agent/single-agent.ts

@@ -3,7 +3,7 @@
  */
 import { openai } from "@llamaindex/openai";
 import { agent } from "@llamaindex/workflow";
-import { getWeatherTool } from "../deprecated/utils/tools";
+import { getWeatherTool } from "../../deprecated/agents/utils/tools";
 
 async function main() {
   const weatherAgent = agent({

examples/agents/agent/with-ollama.ts

@@ -1,6 +1,6 @@
 import { ollama } from "@llamaindex/ollama";
 import { agent } from "@llamaindex/workflow";
-import { getWeatherTool } from "../deprecated/utils/tools";
+import { getWeatherTool } from "../../deprecated/agents/utils/tools";
 
 async function main() {
   const myAgent = agent({

examples/agents/workflow/doc-workflow.ts

@@ -0,0 +1,332 @@
+import { ChatMemoryBuffer, ChatMessage, LLM, MessageContent } from "llamaindex";
+
+import {
+  agentStreamEvent,
+  createStatefulMiddleware,
+  createWorkflow,
+  startAgentEvent,
+  stopAgentEvent,
+  workflowEvent,
+} from "@llamaindex/workflow";
+
+import { z } from "zod";
+
+export const DocumentRequirementSchema = z.object({
+  type: z.enum(["markdown", "html"]),
+  title: z.string(),
+  requirement: z.string(),
+});
+
+export type DocumentRequirement = z.infer<typeof DocumentRequirementSchema>;
+
+export const UIEventSchema = z.object({
+  type: z.literal("ui_event"),
+  data: z.object({
+    state: z
+      .enum(["plan", "generate", "completed"])
+      .describe(
+        "The current state of the workflow: 'plan', 'generate', or 'completed'.",
+      ),
+    requirement: z
+      .string()
+      .optional()
+      .describe(
+        "An optional requirement creating or updating a document, if applicable.",
+      ),
+  }),
+});
+export type UIEvent = z.infer<typeof UIEventSchema>;
+export const uiEvent = workflowEvent<UIEvent>();
+
+const planEvent = workflowEvent<{
+  userInput: MessageContent;
+  context?: string | undefined;
+}>();
+
+const generateArtifactEvent = workflowEvent<{
+  requirement: DocumentRequirement;
+}>();
+
+const synthesizeAnswerEvent = workflowEvent<{
+  requirement: DocumentRequirement;
+  generatedArtifact: string;
+}>();
+
+const ArtifactSchema = z.object({
+  type: z.literal("artifact"),
+  data: z.object({
+    type: z.literal("document"),
+    data: z.object({
+      title: z.string(),
+      content: z.string(),
+      type: z.string(),
+    }),
+    created_at: z.number(),
+  }),
+});
+export type Artifact = z.infer<typeof ArtifactSchema>;
+export const artifactEvent = workflowEvent<Artifact>();
+
+export function createDocumentArtifactWorkflow(
+  llm: LLM,
+  chatHistory: ChatMessage[],
+  lastArtifact: Artifact | undefined,
+) {
+  const { withState, getContext } = createStatefulMiddleware(() => {
+    return {
+      memory: new ChatMemoryBuffer({
+        llm,
+        chatHistory: chatHistory,
+      }),
+      lastArtifact: lastArtifact,
+    };
+  });
+  const workflow = withState(createWorkflow());
+
+  workflow.handle([startAgentEvent], async ({ data: { userInput } }) => {
+    // Prepare chat history
+    const { state } = getContext();
+    // Put user input to the memory
+    if (!userInput) {
+      throw new Error("Missing user input to start the workflow");
+    }
+    state.memory.put({
+      role: "user",
+      content: userInput,
+    });
+    return planEvent.with({
+      userInput,
+      context: state.lastArtifact
+        ? JSON.stringify(state.lastArtifact)
+        : undefined,
+    });
+  });
+
+  workflow.handle([planEvent], async ({ data: planData }) => {
+    const { sendEvent } = getContext();
+    const { state } = getContext();
+    sendEvent(
+      uiEvent.with({
+        type: "ui_event",
+        data: {
+          state: "plan",
+        },
+      }),
+    );
+    const user_msg = planData.userInput;
+    const context = planData.context
+      ? `## The context is: \n${planData.context}\n`
+      : "";
+    const prompt = `
+         You are a documentation analyst responsible for analyzing the user's request and providing requirements for document generation or update.
+         Follow these instructions:
+         1. Carefully analyze the conversation history and the user's request to determine what has been done and what the next step should be.
+         2. From the user's request, provide requirements for the next step of the document generation or update.
+         3. Do not be verbose; only return the requirements for the next step of the document generation or update.
+         4. Only the following document types are allowed: "markdown", "html".
+         5. The requirement should be in the following format:
+            \`\`\`json
+            {
+                "type": "markdown" | "html",
+                "title": string,
+                "requirement": string
+            }
+            \`\`\`
+
+         ## Example:
+         User request: Create a project guideline document.
+         You should return:
+         \`\`\`json
+         {
+             "type": "markdown",
+             "title": "Project Guideline",
+             "requirement": "Generate a Markdown document that outlines the project goals, deliverables, and timeline. Include sections for introduction, objectives, deliverables, and timeline."
+         }
+         \`\`\`
+
+         User request: Add a troubleshooting section to the guideline.
+         You should return:
+         \`\`\`json
+         {
+             "type": "markdown",
+             "title": "Project Guideline",
+             "requirement": "Add a 'Troubleshooting' section at the end of the document with common issues and solutions."
+         }
+         \`\`\`
+
+         ${context}
+
+         Now, please plan for the user's request:
+         ${user_msg}
+        `;
+
+    const response = await llm.complete({
+      prompt,
+    });
+    // Parse the response to DocumentRequirement
+    const jsonBlock = response.text.match(/```json\s*([\s\S]*?)\s*```/);
+    if (!jsonBlock) {
+      throw new Error("No JSON block found in the response.");
+    }
+    const requirement = DocumentRequirementSchema.parse(
+      JSON.parse(jsonBlock[1]),
+    );
+    state.memory.put({
+      role: "assistant",
+      content: `Planning for the document generation: \n${response.text}`,
+    });
+    return generateArtifactEvent.with({
+      requirement,
+    });
+  });
+
+  workflow.handle(
+    [generateArtifactEvent],
+    async ({ data: { requirement } }) => {
+      const { sendEvent } = getContext();
+      const { state } = getContext();
+
+      sendEvent(
+        uiEvent.with({
+          type: "ui_event",
+          data: {
+            state: "generate",
+            requirement: requirement.requirement,
+          },
+        }),
+      );
+
+      const previousArtifact = state.lastArtifact
+        ? JSON.stringify(state.lastArtifact)
+        : "";
+      const requirementStr = JSON.stringify(requirement);
+
+      const prompt = `
+         You are a skilled technical writer who can help users with documentation.
+         You are given a task to generate or update a document for a given requirement.
+
+         ## Follow these instructions:
+         **1. Carefully read the user's requirements.**
+            If any details are ambiguous or missing, make reasonable assumptions and clearly reflect those in your output.
+            If the previous document is provided:
+            + Carefully analyze the document with the request to make the right changes.
+            + Avoid making unnecessary changes from the previous document if the request is not to rewrite it from scratch.
+         **2. For document requests:**
+            - If the user does not specify a type, default to Markdown.
+            - Ensure the document is clear, well-structured, and grammatically correct.
+            - Only generate content relevant to the user's request—do not add extra boilerplate.
+         **3. Do not be verbose in your response.**
+            - No other text or comments; only return the document content wrapped by the appropriate code block (\`\`\`markdown or \`\`\`html).
+            - If the user's request is to update the document, only return the updated document.
+         **4. Only the following types are allowed: "markdown", "html".**
+         **5. If there is no change to the document, return the reason without any code block.**
+
+         ## Example:
+         \`\`\`markdown
+         # Project Guideline
+         
+         ## Introduction
+         ...
+         \`\`\`
+
+         The previous content is:
+         ${previousArtifact}
+
+         Now, please generate the document for the following requirement:
+         ${requirementStr}
+      `;
+
+      const response = await llm.complete({
+        prompt,
+      });
+
+      // Extract the document from the response
+      const docMatch = response.text.match(/```(markdown|html)([\s\S]*)```/);
+      const generatedContent = response.text;
+
+      if (docMatch) {
+        const content = docMatch[2].trim();
+        const docType = docMatch[1] as "markdown" | "html";
+
+        // Put the generated document to the memory
+        state.memory.put({
+          role: "assistant",
+          content: `Generated document: \n${response.text}`,
+        });
+
+        // To show the Canvas panel for the artifact
+        sendEvent(
+          artifactEvent.with({
+            type: "artifact",
+            data: {
+              type: "document",
+              created_at: Date.now(),
+              data: {
+                title: requirement.title,
+                content: content,
+                type: docType,
+              },
+            },
+          }),
+        );
+      }
+
+      return synthesizeAnswerEvent.with({
+        requirement,
+        generatedArtifact: generatedContent,
+      });
+    },
+  );
+
+  workflow.handle([synthesizeAnswerEvent], async ({ data }) => {
+    const { sendEvent } = getContext();
+    const { state } = getContext();
+
+    const chatHistory = await state.memory.getMessages();
+    const messages = [
+      ...chatHistory,
+      {
+        role: "system" as const,
+        content: `
+                Your responsibility is to explain the work to the user.
+                If there is no document to update, explain the reason.
+                If the document is updated, just summarize what changed. Don't need to include the whole document again in the response.
+                `,
+      },
+    ];
+
+    const responseStream = await llm.chat({
+      messages,
+      stream: true,
+    });
+
+    sendEvent(
+      uiEvent.with({
+        type: "ui_event",
+        data: {
+          state: "completed",
+          requirement: data.requirement.requirement,
+        },
+      }),
+    );
+
+    let response = "";
+    for await (const chunk of responseStream) {
+      response += chunk.delta;
+      sendEvent(
+        agentStreamEvent.with({
+          delta: chunk.delta,
+          response: "",
+          currentAgentName: "assistant",
+          raw: chunk,
+        }),
+      );
+    }
+
+    return stopAgentEvent.with({
+      result: response,
+    });
+  });
+
+  return workflow;
+}

examples/agents/workflow/runner.tsx

@@ -0,0 +1,162 @@
+import { openai } from "@llamaindex/openai";
+import { Box, render, Text } from "ink";
+import React from "react";
+
+import {
+  agentStreamEvent,
+  startAgentEvent,
+  stopAgentEvent,
+} from "@llamaindex/workflow";
+
+import {
+  artifactEvent,
+  createDocumentArtifactWorkflow,
+  uiEvent,
+  UIEvent,
+} from "./doc-workflow";
+
+// Import Artifact type (assuming it's exported from doc-workflow.ts)
+// If not exported, we'd define a simplified version here or use 'any' temporarily.
+// Based on the read file, Artifact is a Zod schema inference.
+// We can either import it or define a similar structure for props.
+// For now, let's assume it's available from './doc-workflow'.
+import type { Artifact } from "./doc-workflow"; // Assuming Artifact is exported
+
+const llm = openai({ model: "gpt-4.1-mini" });
+
+// Define the props for our UI component
+interface WorkflowUIProps {
+  uiEvent: UIEvent;
+}
+
+// React component to render the UI using Ink
+const WorkflowUI: React.FC<WorkflowUIProps> = ({ uiEvent }) => {
+  const contentWidth = 60;
+  const stateColorMap: { [key: string]: string } = {
+    plan: "yellow",
+    generate: "blue",
+    completed: "green",
+  };
+
+  const state = uiEvent.data.state;
+  const coloredStateText = (
+    <Text color={stateColorMap[state] || "white"}>{state.toUpperCase()}</Text>
+  );
+
+  const title = "💡 Workflow Event";
+  const requirementLabel = "Requirement: ";
+
+  return (
+    <Box
+      borderStyle="round"
+      borderColor="gray"
+      flexDirection="column"
+      paddingX={1}
+      width={contentWidth + 2 + 2}
+    >
+      <Box justifyContent="center" paddingTop={0} paddingBottom={0}>
+        <Text>{title}</Text>
+      </Box>
+
+      <Box borderStyle="single" borderColor="gray" height={1} marginY={1} />
+
+      <Box flexDirection="column">
+        <Box>
+          <Text>State: </Text>
+          {coloredStateText}
+        </Box>
+
+        {uiEvent.data.requirement !== undefined && (
+          <Box flexDirection="row" marginTop={1}>
+            <Text>{requirementLabel}</Text>
+            <Box flexGrow={1} flexShrink={1} marginLeft={1}>
+              <Text>{uiEvent.data.requirement}</Text>
+            </Box>
+          </Box>
+        )}
+      </Box>
+    </Box>
+  );
+};
+
+// --- BEGIN NEW ARTIFACT UI COMPONENT ---
+interface ArtifactUIProps {
+  artifact: Artifact; // Use the imported Artifact type
+}
+
+const ArtifactUI: React.FC<ArtifactUIProps> = ({ artifact }) => {
+  const artifactData = artifact.data.data; // Access nested data
+  const contentWidth = 80; // Allow more width for artifact content
+
+  return (
+    <Box
+      borderStyle="round"
+      borderColor="cyan"
+      flexDirection="column"
+      padding={1}
+      width={contentWidth + 2 + 2} // Account for padding and border
+    >
+      <Box justifyContent="center" paddingBottom={1}>
+        <Text bold color="cyan">
+          📄 Artifact Generated: {artifactData.title}
+        </Text>
+      </Box>
+
+      <Box borderStyle="single" borderColor="gray" marginY={1} />
+
+      <Box flexDirection="column" gap={1}>
+        <Box>
+          <Text bold>Title: </Text>
+          <Text>{artifactData.title}</Text>
+        </Box>
+        <Box>
+          <Text bold>Type: </Text>
+          <Text>{artifactData.type}</Text>
+        </Box>
+        <Box flexDirection="column">
+          <Text bold>Content:</Text>
+          {/* Add a Box for content to allow it to take up space and wrap */}
+          <Box borderStyle="round" borderColor="gray" padding={1} marginTop={1}>
+            <Text>{artifactData.content}</Text>
+          </Box>
+        </Box>
+        <Box marginTop={1}>
+          <Text dimColor>
+            Created At: {new Date(artifact.data.created_at).toLocaleString()}
+          </Text>
+        </Box>
+      </Box>
+    </Box>
+  );
+};
+
+async function main() {
+  const workflow = createDocumentArtifactWorkflow(llm, [], undefined);
+  const { stream, sendEvent } = workflow.createContext();
+
+  const { rerender, unmount, clear } = render(
+    <Text>Waiting for workflow to start...</Text>,
+  );
+
+  sendEvent(
+    startAgentEvent.with({ userInput: "Create a project guideline document." }),
+  );
+
+  for await (const event of stream.until(stopAgentEvent)) {
+    if (agentStreamEvent.include(event)) {
+      process.stdout.write(event.data.delta);
+    } else if (uiEvent.include(event)) {
+      if (event.data.data.state !== "completed") {
+        rerender(<WorkflowUI uiEvent={event.data} />);
+      }
+    } else if (artifactEvent.include(event)) {
+      rerender(<ArtifactUI artifact={event.data} />);
+    }
+  }
+
+  unmount();
+
+  console.log("\nWorkflow finished.");
+}
+
+main().catch(console.error);

examples/index/vectorIndex.ts

@@ -1,12 +1,20 @@
 import fs from "node:fs/promises";
 
+import { openai, OpenAIEmbedding } from "@llamaindex/openai";
 import {
   Document,
   MetadataMode,
   NodeWithScore,
+  Settings,
   VectorStoreIndex,
 } from "llamaindex";
 
+Settings.llm = openai({
+  apiKey: process.env.OPENAI_API_KEY,
+  model: "gpt-4o",
+});
+Settings.embedModel = new OpenAIEmbedding();
+
 async function main() {
   // Load essay from abramov.txt in Node
   const path = "node_modules/llamaindex/examples/abramov.txt";

examples/index/vectorIndexCustomize.ts

@@ -7,7 +7,7 @@ import {
   VectorStoreIndex,
 } from "llamaindex";
 
-import essay from "./essay";
+import essay from "../data/essay";
 
 // Update llm to use OpenAI
 Settings.llm = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0.1 });

examples/longText.ts

@@ -1,20 +0,0 @@
-import {
-  Document,
-  SentenceSplitter,
-  Settings,
-  VectorStoreIndex,
-} from "llamaindex";
-
-export const STORAGE_DIR = "./data";
-
-// Update node parser
-Settings.nodeParser = new SentenceSplitter({
-  chunkSize: 512,
-  chunkOverlap: 20,
-});
-(async () => {
-  // generate a document with a very long sentence (9000 words long)
-  const longSentence = "is ".repeat(9000) + ".";
-  const document = new Document({ text: longSentence, id_: "1" });
-  await VectorStoreIndex.fromDocuments([document]);
-})();