import { WorkflowAgent } from "@arcgis/ai-components/agent-utils/WorkflowAgent.js";- Inheritance
- WorkflowAgent→
BaseAgent<TState>→ Accessor.js
- Since
- ArcGIS Maps SDK for JavaScript 5.1
WorkflowAgent wraps agents and workflows so they can be executed and registered as a single agent. The workflow defines the internal graph structure and logic of the agent, while WorkflowAgent provides the interface for integration with the broader agent system.
Constructors
Properties
| Property | Type | Class |
|---|---|---|
| inherited | ||
| readonly inherited | ||
| | ||
| inherited | ||
| inherited | ||
| | ||
| readonly inherited | ||
| |
description
- Type
- string
Description of the agent's purpose and functionality. This can be used in registration metadata to provide context about the agent's functionality. A good description is clear and concise. Use bullet points to describe tasks the agent can accomplish. Provide examples of user questions or prompts that could be answered by the agent.
- Default value
- ""
inputSchema
- Type
- ZodObjectSchema<object> | undefined
Optional structured input schema for the workflow wrapper.
middlewares
- Type
- AgentMiddleware
[]
An optional array of middleware functions that can be used to extend or modify the agent's behavior during execution. This allows for flexible customization of the agent's execution logic. For example, middlewares can be used to implement trace messages (i.e. logging), human-in-the-loop interrupts, or other custom actions.
name
- Type
- string
A name for the agent, which is used in the registration metadata and can be displayed in tooling. It should be unique across agents to avoid registration conflicts. A good agent name clearly indicates the scope and purpose of the agent. For example, "WeatherAgent" or "CustomerSupportAgent" are descriptive names that convey the agent's functionality as opposed to generic names like "Agent1" or "MyAgent".
The name is also used to generate the agent's id.
outputSchema
- Type
- ZodObjectSchema<object> | undefined
Optional structured output schema for the workflow wrapper.
registration
- Type
- AgentRegistration
The registration property assembles the necessary metadata and graph definition for this agent, which is consumed by the orchestrator during registration.
workflow
- Type
- BaseWorkflow
The workflow to execute when generating and running this agent's graph.
Methods
| Method | Signature | Class |
|---|---|---|
| initialize(): void | | |
| inherited | run(state?: Partial<AgentGraphState<TCustomState>>, config?: AgentExecutionConfig): Promise<AgentGraphState<TCustomState>> |
run
- Signature
-
run (state?: Partial<AgentGraphState<TCustomState>>, config?: AgentExecutionConfig): Promise<AgentGraphState<TCustomState>>
Executes the agent's graph with the provided state and configuration. This method is responsible for invoking the compiled graph and returning the resulting state after execution.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| state | An optional partial state object to initialize the graph execution. This can include any custom fields defined by the agent. | | |
| config | An optional execution configuration that can influence the agent's behavior during invocation. | |
- Returns
- Promise<AgentGraphState
> A promise that resolves to the updated agent graph state after execution.
Type definitions
WorkflowAgentConstructProperties
- Supertypes
- Partial<Pick<WorkflowAgent
, "description" | "inputSchema" | "middlewares" | "outputSchema">> ‚ Pick<WorkflowAgent ‚ "name" | "workflow">