agents-core/ai.koog.agents.core.agent/GraphAgentBuilder

GraphAgentBuilder

class GraphAgentBuilder<Input, Output>(strategy: AIAgentGraphStrategy<Input, Output>, promptExecutor: PromptExecutor? = null, toolRegistry: ToolRegistry = ToolRegistry.EMPTY, id: String? = null, config: AIAgentConfig, clock: KoogClock = KoogClock.System, featureInstallers: MutableList<GraphAIAgent.FeatureContext.() -> Unit> = mutableListOf()) : AIAgentBuilderBase<GraphAgentBuilder<Input, Output>> (source)

A builder class for creating instances of AIAgent. This builder provides a fluent interface to configure various parameters and components required to construct an AI agent with a specific set of features, tools, and execution strategies.

Parameters

strategy

The execution strategy used by the agent for processing input and generating results.

promptExecutor

PromptExecutor for the agent

id of the agent

config

AIAgentConfig containing initial agent configuration for the builder

clock

optional KoogClock to be used in the agent for calculating timestamps

Type Parameters

Input

The input type that the agent processes.

Output

The output type that the agent produces.

Constructors

GraphAgentBuilder

constructor(strategy: AIAgentGraphStrategy<Input, Output>, promptExecutor: PromptExecutor? = null, toolRegistry: ToolRegistry = ToolRegistry.EMPTY, id: String? = null, config: AIAgentConfig, clock: KoogClock = KoogClock.System, featureInstallers: MutableList<GraphAIAgent.FeatureContext.() -> Unit> = mutableListOf())

Functions

agentConfig

fun agentConfig(config: AIAgentConfig): GraphAgentBuilder<Input, Output>

Configures the current builder instance using the provided AIAgentConfig.

build

fun build(): AIAgent<Input, Output>

Builds and returns an instance of AIAgent configured using the parameters provided to the GraphAgentBuilder.

clock

fun clock(clock: KoogClock): GraphAgentBuilder<Input, Output>

Sets the clock for the agent.

fun id(id: String?): GraphAgentBuilder<Input, Output>

Sets the identifier for the builder configuration.

install

fun install(featureInstaller: GraphAIAgent.FeatureContext.() -> Unit): GraphAgentBuilder<Input, Output>

Installs a new feature into the GraphAgentBuilder.

fun <TConfig : FeatureConfig> install(feature: AIAgentGraphFeature<TConfig, *>, configure: ConfigureAction<TConfig>): GraphAgentBuilder<Input, Output>

Installs a specified feature into the current context and applies its configuration.

llmModel

fun llmModel(model: LLModel): GraphAgentBuilder<Input, Output>

Sets the LLModel instance to be used by the builder.

maxIterations

fun maxIterations(maxIterations: Int): GraphAgentBuilder<Input, Output>

Sets the maximum number of iterations for the builder.

numberOfChoices

fun numberOfChoices(numberOfChoices: Int): GraphAgentBuilder<Input, Output>

Sets the number of choices to be utilized by the builder instance.

prompt

fun prompt(prompt: Prompt): GraphAgentBuilder<Input, Output>

Sets the prompt to be used by the builder.

promptExecutor

fun promptExecutor(promptExecutor: PromptExecutor): GraphAgentBuilder<Input, Output>

Sets the PromptExecutor to be used by the builder instance.

responseProcessor

fun responseProcessor(responseProcessor: ResponseProcessor): GraphAgentBuilder<Input, Output>

Sets the response processor for the agent.

systemPrompt

fun systemPrompt(systemPrompt: String): GraphAgentBuilder<Input, Output>

Sets the system prompt to be used by the builder.

temperature

fun temperature(temperature: Double): GraphAgentBuilder<Input, Output>

Sets the temperature value for the builder.

toolRegistry

fun toolRegistry(toolRegistry: ToolRegistry): GraphAgentBuilder<Input, Output>

Sets the given ToolRegistry instance to the builder configuration.