Class SupervisorPlanner

java.lang.Object

dev.langchain4j.agentic.supervisor.SupervisorPlanner

All Implemented Interfaces:

ChatMemoryAccessProvider, Planner

public class SupervisorPlanner
extends Object
implements Planner, ChatMemoryAccessProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUPERVISOR_CONTEXT_KEY
static final String	SUPERVISOR_CONTEXT_PREFIX

Constructor Summary

Constructors

Constructor	Description
SupervisorPlanner(ChatModel chatModel, ChatMemoryProvider chatMemoryProvider, int maxAgentsInvocations, SupervisorContextStrategy contextStrategy, SupervisorResponseStrategy responseStrategy, Function<AgenticScope, String> requestGenerator, String outputKey, Function<AgenticScope, Object> output)

Method Summary

Modifier and Type	Method	Description
ChatMemoryAccess	chatMemoryAccess(AgenticScope agenticScope)
Map<String,Object>	executionState()	Returns the planner's current execution state as a map of serializable values.
void	init(InitPlanningContext initPlanningContext)
Action	nextAction(PlanningContext planningContext)
void	restoreExecutionState(Map<String,Object> state)	Restores the planner's execution state from a previously saved map.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Planner

as, call, call, done, done, firstAction, noOp, terminated, topology

Field Details

SUPERVISOR_CONTEXT_KEY

public static final String SUPERVISOR_CONTEXT_KEY

See Also:

• Constant Field Values

SUPERVISOR_CONTEXT_PREFIX

public static final String SUPERVISOR_CONTEXT_PREFIX

See Also:

• Constant Field Values

Constructor Details

SupervisorPlanner

public SupervisorPlanner(ChatModel chatModel,
 ChatMemoryProvider chatMemoryProvider,
 int maxAgentsInvocations,
 SupervisorContextStrategy contextStrategy,
 SupervisorResponseStrategy responseStrategy,
 Function<AgenticScope, String> requestGenerator,
 String outputKey,
 Function<AgenticScope, Object> output)

Method Details

init

public void init(InitPlanningContext initPlanningContext)

Specified by:

init in interface Planner

nextAction

public Action nextAction(PlanningContext planningContext)

Specified by:

nextAction in interface Planner

executionState

public Map<String,Object> executionState()

Description copied from interface: Planner

Returns the planner's current execution state as a map of serializable values. This state is persisted to the AgenticScope after each agent invocation, enabling the planner to resume from the correct position after a crash.

The returned state must be such that, when passed to Planner.restoreExecutionState(Map) and Planner.firstAction(PlanningContext) is called, the planner produces the correct resume action.

Stateless planners (e.g., parallel, conditional) can use the default empty implementation.

Specified by:

executionState in interface Planner

Returns:

a map of state entries to persist, or an empty map if no state needs saving

restoreExecutionState

public void restoreExecutionState(Map<String,Object> state)

Description copied from interface: Planner

Restores the planner's execution state from a previously saved map. Called by the execution loop before Planner.firstAction(PlanningContext) when recovering from a persisted scope.

Specified by:

restoreExecutionState in interface Planner

Parameters:

state - the previously saved execution state

chatMemoryAccess

public ChatMemoryAccess chatMemoryAccess(AgenticScope agenticScope)

Specified by:

chatMemoryAccess in interface ChatMemoryAccessProvider