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

GraphAgentBuilder

class GraphAgentBuilder<Input, Output>(strategy: AIAgentGraphStrategy<Input, Output>, inputType: TypeToken, outputType: TypeToken, promptExecutor: PromptExecutor? = null, toolRegistry: ToolRegistry = ToolRegistry.EMPTY, id: String? = null, config: AIAgentConfig, clock: Clock = Clock.System, featureInstallers: MutableList<GraphAIAgent.FeatureContext.() -> Unit> = mutableListOf())(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

Input

The input type that the agent processes.

Output

The output type that the agent produces.

strategy

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

inputType

The TypeToken representation of the input parameter type.

outputType

The TypeToken representation of the output parameter type.

promptExecutor

PromptExecutor for the agent

id

id of the agent

config

AIAgentConfig containing initial agent configuration for the builder

clock

optional Clock to be used in the agent for calculating timestamps

Constructors

GraphAgentBuilder

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

Functions

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

Configures the GraphAgentBuilder using the provided AIAgentConfig instance.

fun build(): AIAgent<Input, Output>

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

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

Sets the unique identifier for the GraphAgentBuilder instance.

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.

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

Sets the large language model (LLM) for the agent builder.

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

Sets the maximum number of iterations allowed for the agent's execution.

numberOfChoices

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

Sets the number of choices the agent can generate and returns the updated builder instance.

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

Sets the prompt for the GraphAgentBuilder and returns the builder instance for further configuration.

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

Sets the PromptExecutor instance to be used by this GraphAgentBuilder.

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

Sets the system-level prompt for the agent.

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

Sets the temperature parameter for the AI agent configuration.

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

Sets the toolRegistry for the GraphAgentBuilder and returns the updated builder instance.