feat: make AgentWorkflow llm param optional (#1727)

.changeset/shiny-camels-deny.md

@@ -0,0 +1,6 @@
+---
+"llamaindex": patch
+"@llamaindex/workflow": patch
+---
+
+feat: make AgentWorkflow llm param optional

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

@@ -119,7 +119,7 @@ Lastly, we run the workflow. The `.run()` method is async, so we use await here
 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/workflow";
+import { HandlerContext } from "llamaindex";
 
 type MyContextData = {
   query: string;

examples/agentworkflow/multiple_agents.ts

@@ -4,7 +4,6 @@
  * 2. TemperatureConverterAgent - Converts the temperature from Fahrenheit to Celsius
  */
 import { OpenAI } from "@llamaindex/openai";
-import { StopEvent } from "@llamaindex/workflow";
 import {
   AgentInput,
   AgentOutput,
@@ -14,6 +13,7 @@ import {
   AgentWorkflow,
   FunctionAgent,
   FunctionTool,
+  StopEvent,
 } from "llamaindex";
 import { z } from "zod";
 

examples/agentworkflow/single_agent.ts

@@ -2,17 +2,18 @@
  * This example shows how to use AgentWorkflow as a single agent with tools
  */
 import { OpenAI } from "@llamaindex/openai";
-import { AgentWorkflow } from "llamaindex";
+import { AgentWorkflow, Settings } from "llamaindex";
 import { getWeatherTool } from "../agent/utils/tools";
 
 const llm = new OpenAI({
   model: "gpt-4o",
 });
 
+Settings.llm = llm;
+
 async function singleWeatherAgent() {
   const workflow = AgentWorkflow.fromTools({
     tools: [getWeatherTool],
-    llm,
     verbose: false,
   });
 

examples/node/workflow/basic.ts

@@ -1,4 +1,4 @@
-import { StartEvent, StopEvent, Workflow } from "@llamaindex/workflow";
+import { StartEvent, StopEvent, Workflow } from "llamaindex";
 
 type ContextData = {
   counter: number;

examples/workflow/app-creator.ts

@@ -5,7 +5,7 @@ import {
   StopEvent,
   Workflow,
   WorkflowEvent,
-} from "@llamaindex/workflow";
+} from "llamaindex";
 
 const MAX_REVIEWS = 3;
 

examples/workflow/conditional.ts

@@ -5,7 +5,7 @@ import {
   StopEvent,
   Workflow,
   WorkflowEvent,
-} from "@llamaindex/workflow";
+} from "llamaindex";
 
 // Create LLM instance
 const llm = new OpenAI();

examples/workflow/joke.ts

@@ -1,10 +1,5 @@
 import { OpenAI } from "@llamaindex/openai";
-import {
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "@llamaindex/workflow";
+import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
 
 // Create LLM instance
 const llm = new OpenAI();

examples/workflow/stream-events.ts

@@ -5,7 +5,7 @@ import {
   StopEvent,
   Workflow,
   WorkflowEvent,
-} from "@llamaindex/workflow";
+} from "llamaindex";
 
 // Create LLM instance
 const llm = new OpenAI();

examples/workflow/timeout.ts

@@ -1,4 +1,4 @@
-import { StartEvent, StopEvent, Workflow } from "@llamaindex/workflow";
+import { StartEvent, StopEvent, Workflow } from "llamaindex";
 
 const longRunning = async (_: unknown, ev: StartEvent<string>) => {
   await new Promise((resolve) => setTimeout(resolve, 2000)); // Wait for 2 seconds

examples/workflow/validation.ts

@@ -1,10 +1,5 @@
 import { OpenAI } from "@llamaindex/openai";
-import {
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "@llamaindex/workflow";
+import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
 
 // Create LLM instance
 const llm = new OpenAI();

packages/llamaindex/src/index.edge.ts

@@ -67,6 +67,7 @@ export * from "@llamaindex/core/storage/index-store";
 export * from "@llamaindex/core/storage/kv-store";
 export * from "@llamaindex/core/utils";
 export * from "@llamaindex/openai";
+export * from "@llamaindex/workflow";
 export * from "@llamaindex/workflow/agent";
 export * from "./agent/index.js";
 export * from "./cloud/index.js";

packages/workflow/src/agent/agent-workflow.ts

@@ -159,7 +159,7 @@ export class AgentWorkflow {
     timeout,
   }: {
     tools: BaseToolWithCall[];
-    llm: ToolCallLLM;
+    llm?: ToolCallLLM;
     systemPrompt?: string;
     verbose?: boolean;
     timeout?: number;

packages/workflow/src/agent/function-agent.ts

@@ -1,4 +1,5 @@
 import type { JSONObject } from "@llamaindex/core/global";
+import { Settings } from "@llamaindex/core/global";
 import type {
   BaseToolWithCall,
   ChatMessage,
@@ -23,7 +24,7 @@ export type FunctionAgentParams = {
   /**
    * LLM to use for the agent, required.
    */
-  llm: ToolCallLLM;
+  llm?: ToolCallLLM | undefined;
   /**
    * Description of the agent, useful for task assignment.
    * Should provide the capabilities or responsibilities of the agent.
@@ -60,7 +61,7 @@ export class FunctionAgent implements BaseWorkflowAgent {
     systemPrompt,
   }: FunctionAgentParams) {
     this.name = name;
-    this.llm = llm;
+    this.llm = llm ?? (Settings.llm as ToolCallLLM);
     this.description = description;
     this.tools = tools;
     if (tools.length === 0) {

unit/workflow/workflow-ui.test.tsx

@@ -1,9 +1,4 @@
-import {
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "@llamaindex/workflow";
+import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
 import type { ReactNode } from "react";
 import { describe, expect, test } from "vitest";
 

unit/workflow/workflow.test.ts

@@ -1,14 +1,5 @@
-import type {
-  HandlerContext,
-  StepHandler,
-  StepParameters,
-} from "@llamaindex/workflow";
-import {
-  StartEvent,
-  StopEvent,
-  Workflow,
-  WorkflowEvent,
-} from "@llamaindex/workflow";
+import type { HandlerContext, StepHandler, StepParameters } from "llamaindex";
+import { StartEvent, StopEvent, Workflow, WorkflowEvent } from "llamaindex";
 import {
   beforeEach,
   describe,