Class AgentBuilder<T, B extends AgentBuilder<T,?>>

java.lang.Object

dev.langchain4j.agentic.agent.AgentBuilder<T,B>

Direct Known Subclasses:

UntypedAgentBuilder

public class AgentBuilder<T, B extends AgentBuilder<T,?>>
extends Object

Constructor Summary

Constructors

Constructor	Description
AgentBuilder(Class<T> agentServiceClass)

Method Summary

Modifier and Type	Method	Description
B	async(boolean async)
T	build()
protected void	build(DefaultAgenticScope agenticScope, AiServiceContext context, AiServices<T> aiServices)
B	chatMemory(ChatMemory chatMemory)
B	chatMemoryProvider(ChatMemoryProvider chatMemoryProvider)
B	chatModel(ChatModel model)
B	contentRetriever(ContentRetriever contentRetriever)
B	context(Function<AgenticScope, String> contextProvider)
<K> B	defaultKeyValue(Class<? extends TypedKey<K>> key, K value)
B	defaultKeyValue(String key, Object value)
B	description(String description)
B	executeToolsConcurrently()
B	executeToolsConcurrently(Executor executor)
B	hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> hallucinatedToolNameStrategy)
<I extends InputGuardrail> B	inputGuardrailClasses(Class<? extends I>... inputGuardrailClasses)
<I extends InputGuardrail> B	inputGuardrails(I... inputGuardrails)
B	inputGuardrailsConfig(InputGuardrailsConfig inputGuardrailsConfig)
B	listener(AgentListener agentListener)
B	maxSequentialToolsInvocations(int maxSequentialToolsInvocations)
B	name(String name)
<O extends OutputGuardrail> B	outputGuardrailClasses(Class<? extends O>... outputGuardrailClasses)
<O extends OutputGuardrail> B	outputGuardrails(O... outputGuardrails)
B	outputGuardrailsConfig(OutputGuardrailsConfig outputGuardrailsConfig)
B	outputKey(Class<? extends TypedKey<?>> outputKey)
B	outputKey(String outputKey)
B	retrievalAugmentor(RetrievalAugmentor retrievalAugmentor)
B	streamingChatModel(StreamingChatModel streamingChatModel)
B	summarizedContext(String... contextProvidingAgents)
B	systemMessage(String systemMessage)
B	systemMessageProvider(Function<Object,String> systemMessageProvider)
B	systemMessageTransformer(BiFunction<String, InvocationContext, String> systemMessageTransformer)
B	systemMessageTransformer(UnaryOperator<String> systemMessageTransformer)
B	toolArgumentsErrorHandler(ToolArgumentsErrorHandler toolArgumentsErrorHandler)
B	toolExecutionErrorHandler(ToolExecutionErrorHandler toolExecutionErrorHandler)
B	toolProvider(ToolProvider toolProvider)
B	toolProviders(ToolProvider... toolProviders)
B	toolProviders(Collection<ToolProvider> toolProviders)
B	tools(Object... objectsWithTools)
B	tools(Map<ToolSpecification, ToolExecutor> toolsMap)
B	tools(Map<ToolSpecification, ToolExecutor> toolsMap, Set<String> immediateReturnToolNames)
B	userMessage(String userMessage)
B	userMessageProvider(Function<Object,String> userMessageProvider)

Methods inherited from class Object

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

Constructor Details

AgentBuilder

public AgentBuilder(Class<T> agentServiceClass)

Method Details

build

public T build()

build

protected void build(DefaultAgenticScope agenticScope,
 AiServiceContext context,
 AiServices<T> aiServices)

chatModel

public B chatModel(ChatModel model)

streamingChatModel

public B streamingChatModel(StreamingChatModel streamingChatModel)

chatMemory

public B chatMemory(ChatMemory chatMemory)

chatMemoryProvider

public B chatMemoryProvider(ChatMemoryProvider chatMemoryProvider)

tools

public B tools(Object... objectsWithTools)

tools

public B tools(Map<ToolSpecification, ToolExecutor> toolsMap)

tools

public B tools(Map<ToolSpecification, ToolExecutor> toolsMap,
 Set<String> immediateReturnToolNames)

toolProvider

public B toolProvider(ToolProvider toolProvider)

toolProviders

public B toolProviders(Collection<ToolProvider> toolProviders)

toolProviders

public B toolProviders(ToolProvider... toolProviders)

maxSequentialToolsInvocations

public B maxSequentialToolsInvocations(int maxSequentialToolsInvocations)

hallucinatedToolNameStrategy

public B hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> hallucinatedToolNameStrategy)

contentRetriever

public B contentRetriever(ContentRetriever contentRetriever)

retrievalAugmentor

public B retrievalAugmentor(RetrievalAugmentor retrievalAugmentor)

inputGuardrailsConfig

public B inputGuardrailsConfig(InputGuardrailsConfig inputGuardrailsConfig)

outputGuardrailsConfig

public B outputGuardrailsConfig(OutputGuardrailsConfig outputGuardrailsConfig)

inputGuardrailClasses

public <I extends InputGuardrail> B inputGuardrailClasses(Class<? extends I>... inputGuardrailClasses)

outputGuardrailClasses

public <O extends OutputGuardrail> B outputGuardrailClasses(Class<? extends O>... outputGuardrailClasses)

inputGuardrails

public <I extends InputGuardrail> B inputGuardrails(I... inputGuardrails)

outputGuardrails

public <O extends OutputGuardrail> B outputGuardrails(O... outputGuardrails)

name

public B name(String name)

description

public B description(String description)

outputKey

public B outputKey(String outputKey)

outputKey

public B outputKey(Class<? extends TypedKey<?>> outputKey)

async

public B async(boolean async)

context

public B context(Function<AgenticScope, String> contextProvider)

summarizedContext

public B summarizedContext(String... contextProvidingAgents)

systemMessage

public B systemMessage(String systemMessage)

systemMessageProvider

public B systemMessageProvider(Function<Object,String> systemMessageProvider)

userMessage

public B userMessage(String userMessage)

userMessageProvider

public B userMessageProvider(Function<Object,String> userMessageProvider)

systemMessageTransformer

public B systemMessageTransformer(UnaryOperator<String> systemMessageTransformer)

systemMessageTransformer

public B systemMessageTransformer(BiFunction<String, InvocationContext, String> systemMessageTransformer)

executeToolsConcurrently

public B executeToolsConcurrently()

executeToolsConcurrently

public B executeToolsConcurrently(Executor executor)

toolArgumentsErrorHandler

public B toolArgumentsErrorHandler(ToolArgumentsErrorHandler toolArgumentsErrorHandler)

toolExecutionErrorHandler

public B toolExecutionErrorHandler(ToolExecutionErrorHandler toolExecutionErrorHandler)

defaultKeyValue

public B defaultKeyValue(String key,
 Object value)

defaultKeyValue

public <K> B defaultKeyValue(Class<? extends TypedKey<K>> key,
 K value)

listener

public B listener(AgentListener agentListener)