remove old workflow examples, we need to redo these anyways

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

@@ -2,149 +2,260 @@
 title: Workflows
 ---
 
-A `Workflow` in LlamaIndexTS is an event-driven abstraction used to chain together several events. Workflows are made up of `steps`, with each step responsible for handling certain event types and emitting new events.
-
-Workflows in LlamaIndexTS work by defining step functions that handle specific event types and emit new events.
-
-When a step function is added to a workflow, you need to specify the input and optionally the output event types (used for validation). The specification of the input events ensures each step only runs when an accepted event is ready.
-
-You can create a `Workflow` to do anything! Build an agent, a RAG flow, an extraction flow, or anything else you want.
+A `Workflow` in LlamaIndex is a lightweight, event-driven abstraction used to chain together several events. Workflows are made up of `handlers`, with each one responsible for processing specific event types and emitting new events.
 
+Workflows are designed to be flexible and can be used to build agents, RAG flows, extraction flows, or anything else you want to implement.
 
 ```package-install
-npm i @llamaindex/workflow
+npm i @llama-flow/core @llamaindex/openai
 ```
 
 ## Getting Started
 
-As an illustrative example, let's consider a naive workflow where a joke is generated and then critiqued.
+Let's explore a simple workflow example where a joke is generated and then critiqued and iterated on:
 
-<include cwd>../../examples/workflow/joke.ts</include>
+```typescript
+import { OpenAI } from "@llamaindex/openai";
+import { createWorkflow, workflowEvent } from "@llama-flow/core";
+import { withStore } from "@llama-flow/core/middleware/store";
 
-There's a few moving pieces here, so let's go through this piece by piece.
+// Create LLM instance
+const llm = new OpenAI({ model: "gpt-4.1-mini", apiKey: "..."});
+
+// Define our workflow events
+const startEvent = workflowEvent<string>(); // Input topic for joke
+const jokeEvent = workflowEvent<{ joke: string }>(); // Intermediate joke
+const critiqueEvent = workflowEvent<{ joke: string, critique: string }>(); // Intermediate critique
+const resultEvent = workflowEvent<{ joke: string, critique: string }>(); // Final joke + critique
+
+// Create our workflow
+const jokeFlow = withStore(
+    () => ({
+        numIterations: 0,
+        maxIterations: 3,
+    }),
+    createWorkflow()
+);
+
+// Define handlers for each step
+jokeFlow.handle([startEvent], async (event) => {
+  // Prompt the LLM to write a joke
+  const prompt = `Write your best joke about ${event.data}. Write the joke between <joke> and </joke> tags.`;
+  const response = await llm.complete({ prompt });
+
+  // Parse the joke from the response
+  const joke = response.text.match(/<joke>([\s\S]*?)<\/joke>/)?.[1]?.trim() ?? response.text;
+  return jokeEvent.with({ joke: joke });
+});
+
+jokeFlow.handle([jokeEvent], async (event) => {
+  // Prompt the LLM to critique the joke
+  const prompt = `Give a thorough critique of the following joke. If the joke needs improvement, put "IMPROVE" somewhere in the critique: ${event.data.joke}`;
+  const response = await llm.complete({ prompt });
+
+  // If the critique includes "IMPROVE", keep iterating, else, return the result
+  if (response.text.includes("IMPROVE")) {
+    return critiqueEvent.with({ joke: event.data.joke, critique: response.text });
+  }
+
+  return resultEvent.with({ joke: event.data.joke, critique: response.text });
+});
+
+jokeFlow.handle([critiqueEvent], async (event) => {
+  // Keep track of the number of iterations
+  const store = jokeFlow.getStore();
+  store.numIterations++;
+
+  // Write a new joke based on the previous joke and critique
+  const prompt = `Write a new joke based on the following critique and the original joke. Write the joke between <joke> and </joke> tags.\n\nJoke: ${event.data.joke}\n\nCritique: ${event.data.critique}`;
+  const response = await llm.complete({ prompt });
+  
+  // Parse the joke from the response
+  const joke = response.text.match(/<joke>([\s\S]*?)<\/joke>/)?.[1]?.trim() ?? response.text;
+  
+  // If we've done less than the max number of iterations, keep iterating
+  // else, return the result
+  if (store.numIterations < store.maxIterations) {
+    return jokeEvent.with({ joke: joke });
+  }
+
+  return resultEvent.with({ joke: joke, critique: event.data.critique });
+});
+
+// Usage
+async function main() {
+  const { stream, sendEvent } = jokeFlow.createContext();
+  sendEvent(startEvent.with("pirates"));
+
+  let result: { joke: string, critique: string } | undefined;
+
+  for await (const event of stream) {
+    // console.log(event.data);  optionally log the event data
+    if (resultEvent.include(event)) {
+      result = event.data;
+      break; // Stop when we get the final result
+    }
+  }
+  
+  console.log(result);
+}
+
+main().catch(console.error);
+```
+
+There are a few moving pieces here, so let's go through this step by step.
 
 ### Defining Workflow Events
 
 ```typescript
-export class JokeEvent extends WorkflowEvent<{ joke: string }> {}
+const startEvent = workflowEvent<string>(); // Input topic for joke
+const jokeEvent = workflowEvent<{ joke: string }>(); // Intermediate joke
+const critiqueEvent = workflowEvent<{ joke: string, critique: string }>(); // Intermediate critique
+const resultEvent = workflowEvent<{ joke: string, critique: string }>(); // Final joke + critique
 ```
 
-Events are user-defined classes that extend `WorkflowEvent` and contain arbitrary data provided as template argument. In this case, our workflow relies on a single user-defined event, the `JokeEvent` with a `joke` attribute of type `string`.
+Events are defined using the `workflowEvent` function and contain arbitrary data provided as a generic type. In this example, we have four events:
+- `startEvent`: Takes a string input (the joke topic)
+- `jokeEvent`: Contains an object with a joke property
+- `critiqueEvent`: Contains both the joke and its critique, used for the feedback loop
+- `resultEvent`: Contains the final joke and critique after any iterations
 
-### Setting up the Workflow Class
+### Setting up the Workflow with Store Middleware
 
 ```typescript
-const llm = new OpenAI();
-...
-const jokeFlow = new Workflow<unknown, string, string>();
-```
-
-Our workflow is implemented by initiating the `Workflow` class with three generic types: the context type (unknown), input type (string), and output type (string). The context type is `unknown`, as we're not using a shared context in this example.
-
-For simplicity, we created an `OpenAI` llm instance that we're using for inference in our workflow.
-
-### Workflow Entry Points
-
-```typescript
-const generateJoke = async (_: unknown, ev: StartEvent<string>) => {
-  const prompt = `Write your best joke about ${ev.data}.`;
-  const response = await llm.complete({ prompt });
-  return new JokeEvent({ joke: response.text });
-};
-```
-
-Here, we come to the entry-point of our workflow. While events are user-defined, there are two special-case events, the `StartEvent` and the `StopEvent`. These events are predefined, but we can specify the payload type using generic types. We're using `StartEvent<string>` to indicate that we're going to send an input of type string.
-
-To add this step to the workflow, we use the `addStep` method with an object specifying the input and output event types:
-
-```typescript
-jokeFlow.addStep(
-  {
-    inputs: [StartEvent<string>],
-    outputs: [JokeEvent],
-  },
-  generateJoke
+const jokeFlow = withStore(
+    () => ({
+        numIterations: 0,
+        maxIterations: 3,
+    }),
+    createWorkflow()
 );
 ```
 
-### Workflow Exit Points
+Our workflow is implemented using the `createWorkflow()` function, enhanced with the `withStore` middleware. The store provides shared state across all handlers, which in this case tracks:
+- `numIterations`: Counts how many iterations of joke improvement we've done
+- `maxIterations`: Sets a limit to prevent infinite loops
+
+This store will be accesible within workflows by using the `jokeFlow.getStore()` function.
+
+### Adding Handlers with Loops
+
+We have three key handlers in our workflow:
+
+1. The first handler processes the `startEvent`, generates an initial joke, and emits a `jokeEvent`:
 
 ```typescript
-const critiqueJoke = async (_: unknown, ev: JokeEvent) => {
-  const prompt = `Give a thorough critique of the following joke: ${ev.data.joke}`;
+jokeFlow.handle([startEvent], async (event) => {
+  // Prompt the LLM to write a joke
+  const prompt = `Write your best joke about ${event.data}. Write the joke between <joke> and </joke> tags.`;
   const response = await llm.complete({ prompt });
-  return new StopEvent(response.text);
-};
+
+  // Parse the joke from the response
+  const joke = response.text.match(/<joke>([\s\S]*?)<\/joke>/)?.[1]?.trim() ?? response.text;
+  return jokeEvent.with({ joke: joke });
+});
 ```
 
-Here, we have our second and last step in the workflow. We know it's the last step because the special `StopEvent` is returned. When the workflow encounters a returned `StopEvent`, it immediately stops the workflow and returns the result. Note that we're using the generic type `StopEvent<string>` to indicate that we're returning a string.
-
-Add this step to the workflow:
+2. The second handler handles the `jokeEvent`, critiques the joke, and either:
+   - Emits a `critiqueEvent` if the joke needs improvement
+   - Emits a `resultEvent` if the joke is good enough
 
 ```typescript
-jokeFlow.addStep(
-  {
-    inputs: [JokeEvent],
-    outputs: [StopEvent<string>],
-  },
-  critiqueJoke
-);
+jokeFlow.handle([jokeEvent], async (event) => {
+  // Prompt the LLM to critique the joke
+  const prompt = `Give a thorough critique of the following joke. If the joke needs improvement, put "IMPROVE" somewhere in the critique: ${event.data.joke}`;
+  const response = await llm.complete({ prompt });
+
+  // If the critique includes "IMPROVE", keep iterating, else, return the result
+  if (response.text.includes("IMPROVE")) {
+    return critiqueEvent.with({ joke: event.data.joke, critique: response.text });
+  }
+
+  return resultEvent.with({ joke: event.data.joke, critique: response.text });
+});
+```
+
+3. The third handler processes the `critiqueEvent`, generates an improved joke based on the critique, and either:
+   - Loops back to the joke evaluation (if under the iteration limit)
+   - Emits the final `resultEvent` (if iteration limit reached)
+
+```typescript
+jokeFlow.handle([critiqueEvent], async (event) => {
+  // Keep track of the number of iterations
+  const store = jokeFlow.getStore();
+  store.numIterations++;
+
+  // Write a new joke based on the previous joke and critique
+  const prompt = `Write a new joke based on the following critique and the original joke. Write the joke between <joke> and </joke> tags.\n\nJoke: ${event.data.joke}\n\nCritique: ${event.data.critique}`;
+  const response = await llm.complete({ prompt });
+  
+  // Parse the joke from the response
+  const joke = response.text.match(/<joke>([\s\S]*?)<\/joke>/)?.[1]?.trim() ?? response.text;
+  
+  // If we've done less than the max number of iterations, keep iterating
+  // else, return the result
+  if (store.numIterations < store.maxIterations) {
+    return jokeEvent.with({ joke: joke });
+  }
+
+  return resultEvent.with({ joke: joke, critique: event.data.critique });
+});
 ```
 
 ### Running the Workflow
 
 ```typescript
-const result = await jokeFlow.run("pirates");
-console.log(result.data.result);
-```
+async function main() {
+  const { stream, sendEvent } = jokeFlow.createContext();
+  sendEvent(startEvent.with("pirates"));
 
-Lastly, we run the workflow. The `.run()` method is async, so we use await here to wait for the result.
+  let result: { joke: string, critique: string } | undefined;
 
-## Working with Shared Context/State
-
-Optionally, you can choose to use a shared context between steps by specifying a context type when creating the workflow. Here's an example where multiple steps access a shared state:
-
-```typescript
-import { HandlerContext } from "llamaindex";
-
-type MyContextData = {
-  query: string;
-  intermediateResults: any[];
+  for await (const event of stream) {
+    // console.log(event.data);  optionally log the event data
+    if (resultEvent.include(event)) {
+      result = event.data;
+      break; // Stop when we get the final result
+    }
+  }
+  
+  console.log(result);
 }
-
-const query = async (context: HandlerContext<MyContextData>, ev: MyEvent) => {
-  // get the query from the context
-  const query = context.data.query;
-  // do something with context and event
-  const val = ...
-  // store in context
-  context.data.intermediateResults.push(val);
-
-  return new StopEvent({ result });
-};
 ```
 
-## Waiting for Multiple Events
+To run the workflow, we:
+1. Create a workflow context with `createContext()`
+2. Trigger the initial event with `sendEvent()`
+3. Listen to the event stream and process events as they arrive
+4. Use `include()` to check if an event is of a specific type
+5. Break the loop when we receive our final result
 
-The context does more than just hold data, it also provides utilities to buffer and wait for multiple events.
+### Using Stream Utilities
 
-For example, you might have a step that waits for a query and retrieved nodes before synthesizing a response:
+Workflows provide utility functions to make working with event streams easier:
 
 ```typescript
-const synthesize = async (context: Context, ev1: QueryEvent, ev2: RetrieveEvent) => {
-  const subPrompts = [`Answer this query using the context provided: ${ev1.data.query}`, `Context: ${ev2.data.context}`];
-  const prompt = subPrompts.join("\n");
-  const response = await llm.complete({ prompt });
-  return new StopEvent({ result: response.text });
-};
+import { collect } from "@llama-flow/core/stream/consumer";
+import { until } from "@llama-flow/core/stream/until";
+
+// Create a workflow context and send the initial event
+const { stream, sendEvent } = jokeFlow.createContext();
+sendEvent(startEvent.with("pirates"));
+
+// Collect all events until we get a resultEvent
+const allEvents = await collect(until(stream, resultEvent));
+
+// The last event will be the resultEvent
+const finalEvent = allEvents[allEvents.length - 1];
+console.log(finalEvent.data); // Output the joke and critique
 ```
 
-Passing multiple events, we can buffer and wait for ALL expected events to arrive. The receiving step function will only be called once all events have arrived.
+The stream utilities make it easier to work with the asynchronous event flow. In this example, we use:
+- `collect`: Aggregates all events into an array
+- `until`: Creates a stream that emits events until a condition is met (in this case, until a resultEvent is received)
 
-## Manually Triggering Events
+You can combine these utilities with other stream operators like `filter` and `map` to create powerful processing pipelines.
 
-Normally, events are triggered by returning another event during a step. However, events can also be manually dispatched using the `ctx.sendEvent(event)` method within a workflow.
+## Next Steps
 
-## Examples
-
-You can find many useful examples of using workflows in the [examples folder](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/workflow).
+To learn more about workflows, check out [the documentation in the tutorial section](../../../llamaflow).

examples/workflow/README.md

@@ -1,7 +0,0 @@
-# Workflow Examples
-
-These examples demonstrate LlamaIndexTS's workflow system. Check out [its documentation](https://ts.llamaindex.ai/modules/workflows) for more information.
-
-## Running the Examples
-
-To run the examples, make sure to run them from the parent folder called `examples`). For example, to run the joke workflow, run `npx tsx workflow/joke.ts`.

examples/workflow/app-creator.ts

@@ -1,157 +0,0 @@
-import { OpenAI } from "@llamaindex/openai";
-import {
-  HandlerContext,
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "llamaindex";
-
-const MAX_REVIEWS = 3;
-
-type Context = {
-  specification: string;
-  numberReviews: number;
-};
-
-// Using the o1-preview model (see https://platform.openai.com/docs/guides/reasoning?reasoning-prompt-examples=coding-planning)
-const llm = new OpenAI({ model: "o1-preview", temperature: 1 });
-
-// example specification from https://platform.openai.com/docs/guides/reasoning?reasoning-prompt-examples=coding-planning
-const specification = `Python app that takes user questions and looks them up in a 
-database where they are mapped to answers. If there is a close match, it retrieves 
-the matched answer. If there isn't, it asks the user to provide an answer and 
-stores the question/answer pair in the database.`;
-
-// Create custom event types
-export class MessageEvent extends WorkflowEvent<{ msg: string }> {}
-
-export class CodeEvent extends WorkflowEvent<{ code: string }> {}
-
-export class ReviewEvent extends WorkflowEvent<{
-  review: string;
-  code: string;
-}> {}
-
-// Helper function to truncate long strings
-const truncate = (str: string) => {
-  const MAX_LENGTH = 60;
-  if (str.length <= MAX_LENGTH) return str;
-  return str.slice(0, MAX_LENGTH) + "...";
-};
-
-// the architect is responsible for writing the structure and the initial code based on the specification
-const architect = async (
-  context: HandlerContext<Context>,
-  _: StartEvent<string>,
-) => {
-  const spec = context.data.specification;
-  // write a message to send an update to the user
-  context.sendEvent(
-    new MessageEvent({
-      msg: `Writing app using this specification: ${truncate(spec)}`,
-    }),
-  );
-  const prompt = `Build an app for this specification: <spec>${spec}</spec>. Make a plan for the directory structure you'll need, then return each file in full. Don't supply any reasoning, just code.`;
-  const code = await llm.complete({ prompt });
-  return new CodeEvent({ code: code.text });
-};
-
-// the coder is responsible for updating the code based on the review
-const coder = async (context: HandlerContext<Context>, ev: ReviewEvent) => {
-  // get the specification from the context
-  const spec = context.data.specification;
-  // get the latest review and code
-  const { review, code } = ev.data;
-  // write a message to send an update to the user
-  context.sendEvent(
-    new MessageEvent({
-      msg: `Update code based on review: ${truncate(review)}`,
-    }),
-  );
-  const prompt = `We need to improve code that should implement this specification: <spec>${spec}</spec>. Here is the current code: <code>${code}</code>. And here is a review of the code: <review>${review}</review>. Improve the code based on the review, keep the specification in mind, and return the full updated code. Don't supply any reasoning, just code.`;
-  const updatedCode = await llm.complete({ prompt });
-  return new CodeEvent({ code: updatedCode.text });
-};
-
-// the reviewer is responsible for reviewing the code and providing feedback
-const reviewer = async (context: HandlerContext<Context>, ev: CodeEvent) => {
-  // get the specification from the context
-  const spec = context.data.specification;
-  // get latest code from the event
-  const { code } = ev.data;
-  // update and check the number of reviews
-  context.data.numberReviews++;
-  if (context.data.numberReviews > MAX_REVIEWS) {
-    // the we've done this too many times - return the code
-    context.sendEvent(
-      new MessageEvent({
-        msg: `Already reviewed ${
-          context.data.numberReviews - 1
-        } times, stopping!`,
-      }),
-    );
-    return new StopEvent({ result: code });
-  }
-  // write a message to send an update to the user
-  context.sendEvent(
-    new MessageEvent({
-      msg: `Review #${context.data.numberReviews}: ${truncate(code)}`,
-    }),
-  );
-  const prompt = `Review this code: <code>${code}</code>. Check if the code quality and whether it correctly implements this specification: <spec>${spec}</spec>. If you're satisfied, just return 'Looks great', nothing else. If not, return a review with a list of changes you'd like to see.`;
-  const review = (await llm.complete({ prompt })).text;
-  if (review.includes("Looks great")) {
-    // the reviewer is satisfied with the code, let's return the review
-    context.sendEvent(
-      new MessageEvent({
-        msg: `Reviewer says: ${review}`,
-      }),
-    );
-    return new StopEvent({ result: code });
-  }
-
-  return new ReviewEvent({ review, code });
-};
-
-const codeAgent = new Workflow<Context, string, string>();
-codeAgent.addStep(
-  {
-    inputs: [StartEvent<string>],
-    outputs: [CodeEvent],
-  },
-  architect,
-);
-codeAgent.addStep(
-  {
-    inputs: [ReviewEvent],
-    outputs: [CodeEvent],
-  },
-  coder,
-);
-codeAgent.addStep(
-  {
-    inputs: [CodeEvent],
-    outputs: [ReviewEvent, StopEvent],
-  },
-  reviewer,
-);
-
-// Usage
-async function main() {
-  const run = codeAgent.run(specification).with({
-    specification,
-    numberReviews: 0,
-  });
-  for await (const event of run) {
-    if (event instanceof MessageEvent) {
-      const msg = (event as MessageEvent).data.msg;
-      console.log(`${msg}\n`);
-    } else if (event instanceof StopEvent) {
-      const result = (event as StopEvent<string>).data;
-      console.log("Final code:\n", result);
-    }
-  }
-}
-
-main().catch(console.error);

examples/workflow/conditional.ts

@@ -1,88 +0,0 @@
-import { OpenAI } from "@llamaindex/openai";
-import {
-  HandlerContext,
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "llamaindex";
-
-// Create LLM instance
-const llm = new OpenAI();
-
-// Create custom event types
-export class JokeEvent extends WorkflowEvent<{ joke: string }> {}
-
-export class CritiqueEvent extends WorkflowEvent<{ critique: string }> {}
-
-export class AnalysisEvent extends WorkflowEvent<{ analysis: string }> {}
-
-const generateJoke = async (_: unknown, ev: StartEvent<string>) => {
-  const prompt = `Write your best joke about ${ev.data}.`;
-  const response = await llm.complete({ prompt });
-  return new JokeEvent({ joke: response.text });
-};
-
-const critiqueJoke = async (_: unknown, ev: JokeEvent) => {
-  const prompt = `Give a thorough critique of the following joke: ${ev.data.joke}`;
-  const response = await llm.complete({ prompt });
-  return new CritiqueEvent({ critique: response.text });
-};
-
-const analyzeJoke = async (_: unknown, ev: JokeEvent) => {
-  const prompt = `Give a thorough analysis of the following joke: ${ev.data.joke}`;
-  const response = await llm.complete({ prompt });
-  return new AnalysisEvent({ analysis: response.text });
-};
-
-const reportJoke = async (
-  context: HandlerContext,
-  ev1: AnalysisEvent,
-  ev2: CritiqueEvent,
-) => {
-  const subPrompts = [ev1.data.analysis, ev2.data.critique];
-
-  const prompt = `Based on the following information about a joke:\n${subPrompts.join(
-    "\n",
-  )}\nProvide a comprehensive report on the joke's quality and impact.`;
-  const response = await llm.complete({ prompt });
-  return new StopEvent(response.text);
-};
-
-const jokeFlow = new Workflow<unknown, string, string>();
-jokeFlow.addStep(
-  {
-    inputs: [StartEvent<string>],
-    outputs: [JokeEvent],
-  },
-  generateJoke,
-);
-jokeFlow.addStep(
-  {
-    inputs: [JokeEvent],
-    outputs: [CritiqueEvent],
-  },
-  critiqueJoke,
-);
-jokeFlow.addStep(
-  {
-    inputs: [JokeEvent],
-    outputs: [AnalysisEvent],
-  },
-  analyzeJoke,
-);
-jokeFlow.addStep(
-  {
-    inputs: [AnalysisEvent, CritiqueEvent],
-    outputs: [StopEvent<string>],
-  },
-  reportJoke,
-);
-
-// Usage
-async function main() {
-  const result = await jokeFlow.run("pirates");
-  console.log(result.data);
-}
-
-main().catch(console.error);

examples/workflow/joke.ts

@@ -1,44 +0,0 @@
-import { OpenAI } from "@llamaindex/openai";
-import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
-
-// Create LLM instance
-const llm = new OpenAI();
-
-// Create a custom event type
-export class JokeEvent extends WorkflowEvent<{ joke: string }> {}
-
-const generateJoke = async (_: unknown, ev: StartEvent<string>) => {
-  const prompt = `Write your best joke about ${ev.data}.`;
-  const response = await llm.complete({ prompt });
-  return new JokeEvent({ joke: response.text });
-};
-
-const critiqueJoke = async (_: unknown, ev: JokeEvent) => {
-  const prompt = `Give a thorough critique of the following joke: ${ev.data.joke}`;
-  const response = await llm.complete({ prompt });
-  return new StopEvent(response.text);
-};
-
-const jokeFlow = new Workflow<unknown, string, string>();
-jokeFlow.addStep(
-  {
-    inputs: [StartEvent<string>],
-    outputs: [JokeEvent],
-  },
-  generateJoke,
-);
-jokeFlow.addStep(
-  {
-    inputs: [JokeEvent],
-    outputs: [StopEvent<string>],
-  },
-  critiqueJoke,
-);
-
-// Usage
-async function main() {
-  const result = await jokeFlow.run("pirates");
-  console.log(result.data);
-}
-
-main().catch(console.error);

examples/workflow/stream-events.ts

@@ -1,66 +0,0 @@
-import { OpenAI } from "@llamaindex/openai";
-import {
-  HandlerContext,
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "llamaindex";
-
-// Create LLM instance
-const llm = new OpenAI();
-
-// Create custom event types
-export class JokeEvent extends WorkflowEvent<{ joke: string }> {}
-
-export class MessageEvent extends WorkflowEvent<{ msg: string }> {}
-
-const generateJoke = async (context: HandlerContext, ev: StartEvent) => {
-  context.sendEvent(
-    new MessageEvent({ msg: `Generating a joke about: ${ev.data}` }),
-  );
-  const prompt = `Write your best joke about ${ev.data}.`;
-  const response = await llm.complete({ prompt });
-  return new JokeEvent({ joke: response.text });
-};
-
-const critiqueJoke = async (context: HandlerContext, ev: JokeEvent) => {
-  context.sendEvent(
-    new MessageEvent({ msg: `Write a critique of this joke: ${ev.data.joke}` }),
-  );
-  const prompt = `Give a thorough critique of the following joke: ${ev.data.joke}`;
-  const response = await llm.complete({ prompt });
-  return new StopEvent(response.text);
-};
-
-const jokeFlow = new Workflow();
-jokeFlow.addStep(
-  {
-    inputs: [StartEvent<string>],
-    outputs: [JokeEvent],
-  },
-  generateJoke,
-);
-jokeFlow.addStep(
-  {
-    inputs: [JokeEvent],
-    outputs: [StopEvent<string>],
-  },
-  critiqueJoke,
-);
-
-// Usage
-async function main() {
-  const run = jokeFlow.run("pirates");
-  for await (const event of run) {
-    if (event instanceof MessageEvent) {
-      console.log("Message:");
-      console.log((event as MessageEvent).data.msg);
-    } else if (event instanceof StopEvent) {
-      console.log("Result:");
-      console.log((event as StopEvent<string>).data);
-    }
-  }
-}
-
-main().catch(console.error);

examples/workflow/timeout.ts

@@ -1,48 +0,0 @@
-import { StartEvent, StopEvent, Workflow } from "llamaindex";
-
-const longRunning = async (_: unknown, ev: StartEvent<string>) => {
-  await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds
-  return new StopEvent("We waited 2 seconds");
-};
-
-async function timeout() {
-  const workflow = new Workflow<unknown, string, string>({
-    timeout: 1,
-  });
-  workflow.addStep(
-    {
-      inputs: [StartEvent<string>],
-      outputs: [StopEvent<string>],
-    },
-    longRunning,
-  );
-  try {
-    await workflow.run("Let's start");
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-async function notimeout() {
-  // Increase timeout to 3 seconds - no timeout
-  const workflow = new Workflow<unknown, string, string>({
-    timeout: 3,
-  });
-  workflow.addStep(
-    {
-      inputs: [StartEvent<string>],
-      outputs: [StopEvent<string>],
-    },
-    longRunning,
-  );
-  const result = await workflow.run("Let's start");
-  console.log(result.data);
-}
-
-async function main() {
-  await timeout();
-  console.log("---");
-  await notimeout();
-}
-
-main().catch(console.error);

examples/workflow/validation.ts

@@ -1,73 +0,0 @@
-import { OpenAI } from "@llamaindex/openai";
-import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
-
-// Create LLM instance
-const llm = new OpenAI();
-
-// Create a custom event type
-export class JokeEvent extends WorkflowEvent<{ joke: string }> {}
-
-const generateJoke = async (_: unknown, ev: StartEvent<string>) => {
-  const prompt = `Write your best joke about ${ev.data}.`;
-  const response = await llm.complete({ prompt });
-  return new JokeEvent({ joke: response.text });
-};
-
-const critiqueJoke = async (_: unknown, ev: JokeEvent) => {
-  const prompt = `Give a thorough critique of the following joke: ${ev.data.joke}`;
-  const response = await llm.complete({ prompt });
-  return new StopEvent(response.text);
-};
-
-async function validateFails() {
-  try {
-    const jokeFlow = new Workflow();
-    jokeFlow.addStep(
-      {
-        inputs: [StartEvent<string>],
-        outputs: [StopEvent<string>],
-      },
-      // @ts-expect-error outputs should be JokeEvent
-      generateJoke,
-    );
-    jokeFlow.addStep(
-      {
-        inputs: [JokeEvent],
-        outputs: [StopEvent],
-      },
-      critiqueJoke,
-    );
-    await jokeFlow.run("pirates").strict();
-  } catch (e) {
-    console.error("Validation failed:", e);
-  }
-}
-
-async function validate() {
-  const jokeFlow = new Workflow();
-  jokeFlow.addStep(
-    {
-      inputs: [StartEvent<string>],
-      outputs: [JokeEvent],
-    },
-    generateJoke,
-  );
-  jokeFlow.addStep(
-    {
-      inputs: [JokeEvent],
-      outputs: [StopEvent<string>],
-    },
-    critiqueJoke,
-  );
-  const result = await jokeFlow.run("pirates").strict();
-  console.log(result.data);
-}
-
-// Usage
-async function main() {
-  await validateFails();
-  console.log("---");
-  await validate();
-}
-
-main().catch(console.error);