Class AgenticServices.NonAiAgentBuilder<T>

java.lang.Object

dev.langchain4j.agentic.AgenticServices.NonAiAgentBuilder<T>

Enclosing class:

AgenticServices

public static class AgenticServices.NonAiAgentBuilder<T>
extends Object

Method Summary

Modifier and Type	Method	Description
AgenticServices.NonAiAgentBuilder<T>	async(boolean async)	Controls whether this agent executes asynchronously within an agentic system.
AgenticServices.AgenticScopeFunction<T>	build()
AgenticServices.NonAiAgentBuilder<T>	description(String description)	Sets a human-readable description of what this agent does, used by planners and orchestrators.
AgenticServices.NonAiAgentBuilder<T>	inputKey(Class<?> type, String name)
AgenticServices.NonAiAgentBuilder<T>	inputKeys(Class<?> type1, String name1, Class<?> type2, String name2)
AgenticServices.NonAiAgentBuilder<T>	inputKeys(Class<?> type1, String name1, Class<?> type2, String name2, Class<?> type3, String name3)
AgenticServices.NonAiAgentBuilder<T>	inputKeys(Class<?> type1, String name1, Class<?> type2, String name2, Class<?> type3, String name3, Class<?> type4, String name4)
AgenticServices.NonAiAgentBuilder<T>	inputs(AgentArgument... inputs)	Declares the keys of the AgenticScope that this agent reads.
AgenticServices.NonAiAgentBuilder<T>	listener(AgentListener listener)	Adds a listener notified of this agent's invocations.
AgenticServices.NonAiAgentBuilder<T>	name(String name)	Sets the agent name used for identification in multi-agent systems.
AgenticServices.NonAiAgentBuilder<T>	outputKey(Class<? extends TypedKey<?>> outputKey)	Sets the output key using a TypedKey class for type-safe scope access.
AgenticServices.NonAiAgentBuilder<T>	outputKey(String outputKey)	Sets the key under which this agent's result is stored in the AgenticScope.
AgenticServices.NonAiAgentBuilder<T>	outputType(Type outputType)	Sets the type of the result produced by this agent.

Methods inherited from class Object

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

Method Details

name

public AgenticServices.NonAiAgentBuilder<T> name(String name)

Sets the agent name used for identification in multi-agent systems. If not set, the name of the AgenticServices.AgenticScopeFunction.accept(AgenticScope) method is used, as for an agentAction.

description

public AgenticServices.NonAiAgentBuilder<T> description(String description)

Sets a human-readable description of what this agent does, used by planners and orchestrators.

inputs

public AgenticServices.NonAiAgentBuilder<T> inputs(AgentArgument... inputs)

Declares the keys of the AgenticScope that this agent reads. Before invoking the function, each input is read from the AgenticScope, converted to its declared type and written back, so that the function can read it with the expected type. If an input without default value is missing the invocation fails with a MissingArgumentException.

inputKey

public AgenticServices.NonAiAgentBuilder<T> inputKey(Class<?> type,
 String name)

inputKeys

public AgenticServices.NonAiAgentBuilder<T> inputKeys(Class<?> type1,
 String name1,
 Class<?> type2,
 String name2)

inputKeys

public AgenticServices.NonAiAgentBuilder<T> inputKeys(Class<?> type1,
 String name1,
 Class<?> type2,
 String name2,
 Class<?> type3,
 String name3)

inputKeys

public AgenticServices.NonAiAgentBuilder<T> inputKeys(Class<?> type1,
 String name1,
 Class<?> type2,
 String name2,
 Class<?> type3,
 String name3,
 Class<?> type4,
 String name4)

outputKey

public AgenticServices.NonAiAgentBuilder<T> outputKey(String outputKey)

Sets the key under which this agent's result is stored in the AgenticScope.

outputKey

public AgenticServices.NonAiAgentBuilder<T> outputKey(Class<? extends TypedKey<?>> outputKey)

Sets the output key using a TypedKey class for type-safe scope access.

outputType

public AgenticServices.NonAiAgentBuilder<T> outputType(Type outputType)

Sets the type of the result produced by this agent. Since the generic type of the function is erased at runtime, it defaults to Object.

async

public AgenticServices.NonAiAgentBuilder<T> async(boolean async)

Controls whether this agent executes asynchronously within an agentic system.

listener

public AgenticServices.NonAiAgentBuilder<T> listener(AgentListener listener)

Adds a listener notified of this agent's invocations.

build

public AgenticServices.AgenticScopeFunction<T> build()