import { ConditionalWorkflow } from "@arcgis/ai-components/agent-utils/workflows/ConditionalWorkflow.js";- Inheritance
- ConditionalWorkflow→
BaseWorkflow<TState>→ Accessor.js
- Since
- ArcGIS Maps SDK for JavaScript 5.1
ConditionalWorkflow chooses between two branch agents based on a boolean condition and routes execution through a simple true/false branch.
Use when:
- you want an if/else style decision or
- only two branches are needed.
How it works:
- evaluate
condition(state, config), - if true, run the first branch agent,
- if false, run the second branch agent.
Constructors
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| |
agents
- Type
- BaseAgentLike
[]
Must contain exactly two agents: [trueAgent, falseAgent]. The first agent is executed when
the condition is true, the second when the condition is false.
Methods
| Method | Signature | Class |
|---|---|---|
| protected | buildEdges(agents: BaseAgentLike<TState>[]): GraphEdge<AgentGraphState<TState>>[] | |
| protected | buildNodes(agents: BaseAgentLike<TState>[]): GraphNodes<AgentGraphState<TState>> | |
| inherited | generate(): WorkflowGenerateResult<TState> | |
| getAgents(): BaseAgentLike<TState>[] | | |
| protected | getEntryNode(): string | |
| protected | isTerminalAgent(): boolean | |
| protected | validateAgents(agents: BaseAgentLike<TState>[]): void | |
buildEdges
- Signature
-
buildEdges (agents: BaseAgentLike<TState>[]): GraphEdge<AgentGraphState<TState>>[]
Builds the workflow-specific edges.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| agents | | |
- Returns
- GraphEdge<AgentGraphState
>[]
buildNodes
- Signature
-
buildNodes (agents: BaseAgentLike<TState>[]): GraphNodes<AgentGraphState<TState>>
Builds the workflow's graph nodes.
Node ids use the agent id plus its position (agent.id_index) instead of only the raw
agent id. That prevents collisions when the same agent instance is used multiple times.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| agents | | |
- Returns
- GraphNodes<AgentGraphState
>
generate
- Signature
-
generate (): WorkflowGenerateResult<TState>
Generates the workflow's graph and shared workspace based on the defined agents and their schemas. This method is called by the WorkflowAgent when it generates its graph, and it orchestrates the creation of the workflow's structure, including validating the agents, deriving shared state from their schemas, and building the nodes and edges of the graph.
- Returns
- WorkflowGenerateResult
getAgents
- Signature
-
getAgents (): BaseAgentLike<TState>[]
A list of agents that are part of this workflow.
- Returns
- BaseAgentLike
[]
getEntryNode
- Signature
-
getEntryNode (): string
Returns the id of the first node in the workflow graph.
- Returns
- string
isTerminalAgent
- Signature
-
isTerminalAgent (): boolean
Returns whether the agent at this position should expose terminal runtime fields.
- Returns
- boolean
validateAgents
- Signature
-
validateAgents (agents: BaseAgentLike<TState>[]): void
Validates the workflow configuration and throws if invalid.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| agents | | |
- Returns
- void
Type definitions
ConditionDecider
Condition function that routes execution to either the true branch or false branch.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| state | Current workflow graph state. | | |
| config | Optional execution configuration. | |
ConditionalWorkflowConstructProperties
- Type parameters
- <TState extends AgentData>
- Supertypes
- Pick<ConditionalWorkflow
‚ "agents" | "condition">