refactor: workflow API

.changeset/giant-jars-grab.md

@@ -0,0 +1,9 @@
+---
+"@llamaindex/core": minor
+---
+
+feat: update workflow API v2
+
+- combine await behavior with async iterator, now there's only one queue to handle the `startEvent`.
+- each Context will have its own step map, so the step can be executed in parallel.
+- remove `context.globals` from API, you can provide your own context by `.with` API

.github/workflows/test.yml

@@ -99,7 +99,6 @@ jobs:
           - nextjs-agent
           - nextjs-edge-runtime
           - nextjs-node-runtime
-          - waku-query-engine
           - llama-parse-browser
     runs-on: ubuntu-latest
     name: Build LlamaIndex Example (${{ matrix.packages }})

apps/docs/docs/guides/workflow/1_introduction.mdx

@@ -0,0 +1,63 @@
+---
+sidebar_position: 1
+---
+
+import CodeBlock from "@theme/CodeBlock";
+import Basic from "!raw-loader!../../../../../examples/workflow/01_basic.ts";
+import Context from "!raw-loader!../../../../../examples/workflow/02_context.ts";
+import DynamicContext from "!raw-loader!../../../../../examples/workflow/03_dynamic_context.ts";
+import ComplexWorkflow from "!raw-loader!../../../../../examples/workflow/04_complex_workflow.ts";
+import ServerAction from "!raw-loader!../../../../../packages/llamaindex/e2e/examples/nextjs/src/actions/app-creator.tsx";
+import Page from "!raw-loader!../../../../../packages/llamaindex/e2e/examples/nextjs/src/app/app-creator/page.tsx";
+
+# Introduction
+
+Workflow is a primitive API that allows you to define a series of steps and chain by the event-driven mechanism.
+It is a powerful tool to orchestrate the execution of multiple tasks in a specific order.
+
+In this guide, we will walk you through the basic concepts of the Workflow API and how to use it in your application.
+
+## Getting Started
+
+<CodeBlock language="ts">{Basic}</CodeBlock>
+
+## Context
+
+When you want to share state between steps, you can use the `context` object.
+
+For example, you can abstract `OpenAI` to the context level and set it after you create the workflow.
+
+<CodeBlock language="ts">{Context}</CodeBlock>
+
+## Dynamic Context
+
+You can also set the context dynamically by using the `with` after you run a workflow.
+
+<CodeBlock language="ts">{DynamicContext}</CodeBlock>
+
+```txt
+Input word or phrase: Hello, world!
+OpenAI Result: Bonjour, le monde !
+Ollama3.1 Result: Bonjour, monde !
+```
+
+## Complex Workflow
+
+We can define a more complex workflow that involves multiple steps and reviews.
+
+<CodeBlock language="ts">{ComplexWorkflow}</CodeBlock>
+
+## Integrate with Next.js
+
+Adding more loading indicators and error handling to the workflow, integrate with server action in Next.js.
+
+<CodeBlock language="tsx">{ServerAction}</CodeBlock>
+
+<CodeBlock language="tsx">{Page}</CodeBlock>
+
+import Preview from "../../_static/showcase/app-creator.mp4";
+
+<video controls width="100%">
+  <source src={Preview} type="video/mp4" />
+  Your browser does not support the video tag.
+</video>

apps/docs/docs/guides/workflow/_category_.yml

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

examples/package.json

@@ -7,6 +7,8 @@
     "@azure/identity": "^4.4.1",
     "@datastax/astra-db-ts": "^1.4.1",
     "@llamaindex/core": "^0.2.0",
+    "@llamaindex/ollama": "workspace:^0.0.3",
+    "@llamaindex/openai": "workspace:^0.1.10",
     "@notionhq/client": "^2.2.15",
     "@pinecone-database/pinecone": "^3.0.2",
     "@vercel/postgres": "^0.10.0",

examples/workflow/01_basic.ts

@@ -0,0 +1,22 @@
+import { StartEvent, StopEvent, Workflow } from "@llamaindex/core/workflow";
+import { OpenAI } from "@llamaindex/openai";
+
+const myWorkflow = new Workflow({
+  verbose: true,
+});
+
+const openai = new OpenAI();
+
+myWorkflow.addStep(StartEvent, async (_, event) => {
+  const { input } = event.data;
+  const response = await openai.complete({
+    prompt: `Translate English to French: ${input}`,
+  });
+  return new StopEvent({
+    result: response.text,
+  });
+});
+
+const { data } = await myWorkflow.run("Hello, world!");
+
+console.log("Result:", data.result);

examples/workflow/02_context.ts

@@ -0,0 +1,35 @@
+import { StartEvent, StopEvent, Workflow } from "@llamaindex/core/workflow";
+import { OpenAI } from "@llamaindex/openai";
+import { createInterface } from "readline/promises";
+
+const myWorkflow = new Workflow({
+  verbose: true,
+}).with({
+  llm: new OpenAI({
+    apiKey: process.env.OPENAI_API_KEY!,
+  }),
+});
+
+myWorkflow.addStep(StartEvent, async (context, event) => {
+  const { llm } = context;
+  const { input } = event.data;
+  const response = await llm.complete({
+    prompt: `Translate English to French: ${input}`,
+  });
+  return new StopEvent({
+    result: response.text,
+  });
+});
+
+const rl = createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const input = await rl.question("Input word or phrase: ");
+
+const { data } = await myWorkflow.run(input);
+
+console.log("Result:", data.result);
+
+rl.close();

examples/workflow/03_dynamic_context.ts

@@ -0,0 +1,55 @@
+import type { LLM } from "@llamaindex/core/llms";
+import { StartEvent, StopEvent, Workflow } from "@llamaindex/core/workflow";
+import { Ollama } from "@llamaindex/ollama";
+import { OpenAI } from "@llamaindex/openai";
+import { createInterface } from "readline/promises";
+
+const myWorkflow = new Workflow({
+  verbose: false,
+}).with({
+  llm: null! as LLM,
+});
+
+myWorkflow.addStep(StartEvent, async (context, event) => {
+  const { llm } = context;
+  const { input } = event.data;
+  const response = await llm.complete({
+    prompt: `Translate English to French: ${input}`,
+  });
+  return new StopEvent({
+    result: response.text,
+  });
+});
+
+const rl = createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const input = await rl.question("Input word or phrase: ");
+
+const emptyRunner = myWorkflow.run(input);
+
+const openaiResult = emptyRunner.with({
+  llm: new OpenAI({
+    apiKey: process.env.OPENAI_API_KEY!,
+  }),
+});
+
+const ollamaResult = emptyRunner.with({
+  llm: new Ollama({
+    model: "llama3.1",
+  }),
+});
+
+{
+  const { data } = await openaiResult;
+  console.log("OpenAI Result:", data.result);
+}
+
+{
+  const { data } = await ollamaResult;
+  console.log("Ollama3.1 Result:", data.result);
+}
+
+rl.close();