Class AbstractAgentInvoker

java.lang.Object

dev.langchain4j.agentic.internal.AbstractAgentInvoker

All Implemented Interfaces:

AgentInvoker, InternalAgent, AgentInstance

Direct Known Subclasses:

MapperAgentInvoker, MethodAgentInvoker, UntypedAgentInvoker

public abstract class AbstractAgentInvoker
extends Object
implements AgentInvoker, InternalAgent

Field Summary

Fields

Modifier and Type	Field	Description
protected final InternalAgent	agent
protected final Method	method

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAgentInvoker(Method method, InternalAgent agent)

Method Summary

Modifier and Type	Method	Description
AgentCondition	activationCondition()	The condition under which this agent runs when it is invoked as a subagent, or null when it always runs.
String	agentId()
void	appendId(String idSuffix)
List<AgentArgument>	arguments()
<T extends AgentInstance> T	as(Class<T> agentInstanceClass)
boolean	async()
boolean	compensateOnError()
String	description()
void	enableCrossAgentCompensation()
boolean	equals(Object obj)
int	hashCode()
Object	invoke(DefaultAgenticScope agenticScope, Object agent, AgentInvocationArguments args)	Invokes the agent, reports the invocation to its listeners with the response of the model it called, and registers the messages it exchanged in the context of the scope.
AgentListener	listener()
Method	method()
String	name()
boolean	optional()
String	outputKey()
Type	outputType()
AgentInstance	parent()
Class<? extends Planner>	plannerType()
void	registerInheritedParentListener(AgentListener parentListener)
void	setParent(InternalAgent parent)
List<AgentInstance>	subagents()
AgentInvocationArguments	toInvocationArguments(AgenticScope agenticScope)
AgenticSystemTopology	topology()
String	toString()
Class<?>	type()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AgentInstance

leaf

Methods inherited from interface InternalAgent

allowChatMemory, allowStreamingOutput, setAgentId

Field Details

method

protected final Method method

agent

protected final InternalAgent agent

Constructor Details

AbstractAgentInvoker

protected AbstractAgentInvoker(Method method,
 InternalAgent agent)

Method Details

type

public Class<?> type()

Specified by:

type in interface AgentInstance

plannerType

public Class<? extends Planner> plannerType()

Specified by:

plannerType in interface AgentInstance

name

public String name()

Specified by:

name in interface AgentInstance

agentId

public String agentId()

Specified by:

agentId in interface AgentInstance

description

public String description()

Specified by:

description in interface AgentInstance

outputType

public Type outputType()

Specified by:

outputType in interface AgentInstance

outputKey

public String outputKey()

Specified by:

outputKey in interface AgentInstance

arguments

public List<AgentArgument> arguments()

Specified by:

arguments in interface AgentInstance

subagents

public List<AgentInstance> subagents()

Specified by:

subagents in interface AgentInstance

async

public boolean async()

Specified by:

async in interface AgentInstance

optional

public boolean optional()

Specified by:

optional in interface AgentInstance

activationCondition

public AgentCondition activationCondition()

Description copied from interface: AgentInstance

The condition under which this agent runs when it is invoked as a subagent, or null when it always runs. When the condition is false, the agent is skipped: it is not invoked, it writes nothing to the AgenticScope and its parent's planner is notified of the skip. The condition is ignored when the agent is invoked directly, as the root of an agentic system.

The condition can be evaluated more than once for a single invocation, by the planner of the parent while selecting its next agents and again when the agent is invoked, so it must be cheap and free of side effects.

Specified by:

activationCondition in interface AgentInstance

toInvocationArguments

public AgentInvocationArguments toInvocationArguments(AgenticScope agenticScope)
                                               throws MissingArgumentException

Specified by:

toInvocationArguments in interface AgentInvoker

Throws:

MissingArgumentException

invoke

public Object invoke(DefaultAgenticScope agenticScope,
 Object agent,
 AgentInvocationArguments args)
              throws AgentInvocationException

Description copied from interface: AgentInvoker

Invokes the agent, reports the invocation to its listeners with the response of the model it called, and registers the messages it exchanged in the context of the scope. Everything happens on the calling thread, which for an asynchronous agent is the thread of its executor.

Specified by:

invoke in interface AgentInvoker

Throws:

AgentInvocationException

listener

public AgentListener listener()

Specified by:

listener in interface InternalAgent

topology

public AgenticSystemTopology topology()

Specified by:

topology in interface AgentInstance

method

public Method method()

Specified by:

method in interface AgentInvoker

parent

public AgentInstance parent()

Specified by:

parent in interface AgentInstance

as

public <T extends AgentInstance> T as(Class<T> agentInstanceClass)

Specified by:

as in interface AgentInstance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compensateOnError

public boolean compensateOnError()

Specified by:

compensateOnError in interface InternalAgent

enableCrossAgentCompensation

public void enableCrossAgentCompensation()

Specified by:

enableCrossAgentCompensation in interface InternalAgent

setParent

public void setParent(InternalAgent parent)

Specified by:

setParent in interface InternalAgent

registerInheritedParentListener

public void registerInheritedParentListener(AgentListener parentListener)

Specified by:

registerInheritedParentListener in interface InternalAgent

appendId

public void appendId(String idSuffix)

Specified by:

appendId in interface InternalAgent