Package com.alibaba.cloud.ai.graph.agent

Class Agent

java.lang.Object

com.alibaba.cloud.ai.graph.agent.Agent

Direct Known Subclasses:

BaseAgent, FlowAgent

public abstract class Agent
extends Object

Abstract base class for all agents in the graph system. Contains common properties and methods shared by different agent implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected CompileConfig	compileConfig
protected CompiledGraph	compiledGraph
protected String	description	One line description about the agent's capability.
protected Executor	executor
protected StateGraph	graph
protected String	name	The agent's name.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Agent()	Default protected constructor for subclasses that need to initialize properties differently.
protected	Agent(String name, String description)	Protected constructor for initializing all base agent properties.

Method Summary

Modifier and Type	Method	Description
protected void	applyExecutorConfig(RunnableConfig.Builder builder)	Applies executor configuration to the RunnableConfig builder.
protected Map<String,Object>	buildMessageInput(Object message)
protected RunnableConfig	buildNonStreamConfig(RunnableConfig config)
protected RunnableConfig	buildStreamConfig(RunnableConfig config)
String	description()	Gets the one-line description of the agent's capability.
protected Optional<OverAllState>	doInvoke(Map<String,Object> input, RunnableConfig runnableConfig)
protected Optional<NodeOutput>	doInvokeAndGetOutput(Map<String,Object> input, RunnableConfig runnableConfig)
protected reactor.core.publisher.Flux<NodeOutput>	doStream(Map<String,Object> input, RunnableConfig runnableConfig)
CompiledGraph	getAndCompileGraph()
StateSnapshot	getCurrentState(RunnableConfig config)
StateGraph	getGraph()
protected abstract StateGraph	initGraph()
Optional<OverAllState>	invoke(String message)
Optional<OverAllState>	invoke(String message, RunnableConfig config)
Optional<OverAllState>	invoke(List<org.springframework.ai.chat.messages.Message> messages)
Optional<OverAllState>	invoke(List<org.springframework.ai.chat.messages.Message> messages, RunnableConfig config)
Optional<OverAllState>	invoke(org.springframework.ai.chat.messages.UserMessage message)
Optional<OverAllState>	invoke(org.springframework.ai.chat.messages.UserMessage message, RunnableConfig config)
Optional<NodeOutput>	invokeAndGetOutput(String message)
Optional<NodeOutput>	invokeAndGetOutput(String message, RunnableConfig config)
Optional<NodeOutput>	invokeAndGetOutput(List<org.springframework.ai.chat.messages.Message> messages)
Optional<NodeOutput>	invokeAndGetOutput(List<org.springframework.ai.chat.messages.Message> messages, RunnableConfig config)
Optional<NodeOutput>	invokeAndGetOutput(org.springframework.ai.chat.messages.UserMessage message)
Optional<NodeOutput>	invokeAndGetOutput(org.springframework.ai.chat.messages.UserMessage message, RunnableConfig config)
String	name()	Gets the agent's unique name.
ScheduledAgentTask	schedule(ScheduleConfig scheduleConfig)	Schedule the agent task with trigger.
ScheduledAgentTask	schedule(org.springframework.scheduling.Trigger trigger, Map<String,Object> input)	Schedule the agent task with trigger.
reactor.core.publisher.Flux<NodeOutput>	stream(String message)
reactor.core.publisher.Flux<NodeOutput>	stream(String message, RunnableConfig config)
reactor.core.publisher.Flux<NodeOutput>	stream(List<org.springframework.ai.chat.messages.Message> messages)
reactor.core.publisher.Flux<NodeOutput>	stream(List<org.springframework.ai.chat.messages.Message> messages, RunnableConfig config)
reactor.core.publisher.Flux<NodeOutput>	stream(org.springframework.ai.chat.messages.UserMessage message)
reactor.core.publisher.Flux<NodeOutput>	stream(org.springframework.ai.chat.messages.UserMessage message, RunnableConfig config)

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

The agent's name. Must be a unique identifier within the graph.

description

protected String description

One line description about the agent's capability. The system can use this for decision-making when delegating control to different agents.

compileConfig

protected CompileConfig compileConfig

compiledGraph

protected volatile CompiledGraph compiledGraph

graph

protected volatile StateGraph graph

executor

protected Executor executor

Constructor Details

Agent

protected Agent(String name,
 String description)

Protected constructor for initializing all base agent properties.

Parameters:

name - the unique name of the agent

description - the description of the agent's capability

Agent

protected Agent()

Default protected constructor for subclasses that need to initialize properties differently.

Method Details

name

public String name()

Gets the agent's unique name.

Returns:

the unique name of the agent.

description

public String description()

Gets the one-line description of the agent's capability.

Returns:

the description of the agent.

getGraph

public StateGraph getGraph()

getAndCompileGraph

public CompiledGraph getAndCompileGraph()

schedule

public ScheduledAgentTask schedule(org.springframework.scheduling.Trigger trigger,
 Map<String,Object> input)
                            throws GraphStateException,
GraphRunnerException

Schedule the agent task with trigger.

Parameters:

trigger - the schedule configuration

input - the agent input

Returns:

a ScheduledAgentTask instance for managing the scheduled task

Throws:

GraphStateException

GraphRunnerException

schedule

public ScheduledAgentTask schedule(ScheduleConfig scheduleConfig)
                            throws GraphStateException

Schedule the agent task with trigger.

Parameters:

scheduleConfig - the schedule configuration

Returns:

a ScheduledAgentTask instance for managing the scheduled task

Throws:

GraphStateException

getCurrentState

public StateSnapshot getCurrentState(RunnableConfig config)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(String message)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(String message,
 RunnableConfig config)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(org.springframework.ai.chat.messages.UserMessage message)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(org.springframework.ai.chat.messages.UserMessage message,
 RunnableConfig config)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(List<org.springframework.ai.chat.messages.Message> messages)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invoke

public Optional<OverAllState> invoke(List<org.springframework.ai.chat.messages.Message> messages,
 RunnableConfig config)
                              throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(String message)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(String message,
 RunnableConfig config)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(org.springframework.ai.chat.messages.UserMessage message)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(org.springframework.ai.chat.messages.UserMessage message,
 RunnableConfig config)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(List<org.springframework.ai.chat.messages.Message> messages)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

invokeAndGetOutput

public Optional<NodeOutput> invokeAndGetOutput(List<org.springframework.ai.chat.messages.Message> messages,
 RunnableConfig config)
                                        throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(String message)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(String message,
 RunnableConfig config)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(org.springframework.ai.chat.messages.UserMessage message)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(org.springframework.ai.chat.messages.UserMessage message,
 RunnableConfig config)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(List<org.springframework.ai.chat.messages.Message> messages)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

stream

public reactor.core.publisher.Flux<NodeOutput> stream(List<org.springframework.ai.chat.messages.Message> messages,
 RunnableConfig config)
                                               throws GraphRunnerException

Throws:

GraphRunnerException

doInvoke

protected Optional<OverAllState> doInvoke(Map<String,Object> input,
 RunnableConfig runnableConfig)

doInvokeAndGetOutput

protected Optional<NodeOutput> doInvokeAndGetOutput(Map<String,Object> input,
 RunnableConfig runnableConfig)

doStream

protected reactor.core.publisher.Flux<NodeOutput> doStream(Map<String,Object> input,
 RunnableConfig runnableConfig)

buildNonStreamConfig

protected RunnableConfig buildNonStreamConfig(RunnableConfig config)

buildStreamConfig

protected RunnableConfig buildStreamConfig(RunnableConfig config)

applyExecutorConfig

protected void applyExecutorConfig(RunnableConfig.Builder builder)

Applies executor configuration to the RunnableConfig builder. This method sets the default executor for parallel nodes from the agent's configuration.

Parameters:

builder - the RunnableConfig builder to apply executor configuration to

buildMessageInput

protected Map<String,Object> buildMessageInput(Object message)

initGraph

protected abstract StateGraph initGraph()
                                 throws GraphStateException

Throws:

GraphStateException