agents-core/ai.koog.agents.planner/PlannerAIAgentBuilder

PlannerAIAgentBuilder

class PlannerAIAgentBuilder<Input, Output>(strategy: AIAgentPlannerStrategy<Input, Output, *>)(source)

A builder for creating PlannerAIAgent instances.

Constructors

PlannerAIAgentBuilder

constructor(strategy: AIAgentPlannerStrategy<Input, Output, *>)

Functions

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

Configures the current PlannerAIAgentBuilder instance using the provided AIAgentConfig.

fun build(): AIAgent<Input, Output>

Builds and returns an instance of AIAgent configured according to the builder's settings.

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

Sets the identifier for the builder configuration.

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

Installs a planner-specific AI agent feature into the builder with its provided configuration.

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

Sets the LLModel instance to be used by the builder.

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

Sets the maximum number of iterations for the builder.

numberOfChoices

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

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

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

Sets the prompt to be used by the builder.

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

Sets the PromptExecutor to be used by the builder instance.

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

Sets the system prompt to be used by the builder.

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

Sets the temperature value for the builder.

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

Sets the given ToolRegistry instance to the builder configuration.