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

PlannerAgentBuilder

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

Builds an AI-based planning agent by configuring various parameters and defining custom behaviors for the agent. This builder allows flexible setup of an agent's functionality and behavior based on the provided configuration and tools.

Parameters

strategy

The planning strategy used by the agent to process and execute tasks.

promptExecutor

The executor responsible for handling AI prompts.

toolRegistry

The registry of tools available for use by the agent. Defaults to an empty tool registry.

The optional identifier of the agent.

config

AIAgentConfig containing initial agent configuration for the builder

clock

The clock instance used to track time-related operations for the agent. Defaults to the system clock.

featureInstallers

A list of feature installers that enhance the agent's behavior with additional functionality.

Constructors

PlannerAgentBuilder

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

Functions

agentConfig

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

Configures the current builder instance using the provided AIAgentConfig.

build

fun build(): AIAgent<Input, Output>

Constructs and returns an instance of AIAgent configured with the provided parameters and features.

clock

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

Sets the clock for the agent.

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

Sets the identifier for the builder configuration.

install

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

Installs a functional feature into the PlannerAgentBuilder with the specified configuration.

llmModel

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

Sets the LLModel instance to be used by the builder.

maxIterations

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

Sets the maximum number of iterations for the builder.

numberOfChoices

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

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

prompt

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

Sets the prompt to be used by the builder.

promptExecutor

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

Sets the PromptExecutor to be used by the builder instance.

responseProcessor

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

Sets the response processor for the agent.

systemPrompt

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

Sets the system prompt to be used by the builder.

temperature

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

Sets the temperature value for the builder.

toolRegistry

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

Sets the given ToolRegistry instance to the builder configuration.