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

AIAgentBuilder

expect class AIAgentBuilder : AIAgentBuilderCommon<AIAgentBuilder> (source)

Represents a configurational builder for setting up and customizing the execution parameters and components of an AI agent. This builder enables fine-grained control over tools, strategies, and prompts utilized by an AI agent during its execution.

actual class AIAgentBuilder : AIAgentBuilderCommon<AIAgentBuilder> (source)

Functions

agentConfig

expect fun agentConfig(config: AIAgentConfig): AIAgentBuilder

Configures the current builder instance using the provided AIAgentConfig.

fun agentConfig(config: AIAgentConfig): AIAgentBuilder

Configures the current builder instance using the provided AIAgentConfig.

fun agentConfig(config: AIAgentConfig): AIAgentBuilder

Configures the current builder instance using the provided AIAgentConfig.

build

fun build(): AIAgent<String, String>

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

fun build(): AIAgent<String, String>

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

fun build(): AIAgent<String, String>

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

clock

expect fun clock(clock: KoogClock): AIAgentBuilder

Sets the clock for the agent.

fun clock(clock: ai/koog/utils/time/KoogClock): AIAgentBuilder

Sets the clock for the agent.

fun clock(clock: KoogClock): AIAgentBuilder

Sets the clock for the agent.

functionalStrategy

fun <Input, Output> functionalStrategy(strategy: AIAgentFunctionalStrategy<Input, Output>): FunctionalAgentBuilder<Input, Output>

Sets the functional strategy to be used by the agent builder.

fun <Input, Output> functionalStrategy(name: String = "funStrategy", strategy: BiFunction<AIAgentFunctionalContext, Input, Output>): FunctionalAgentBuilder<Input, Output>

Creates a functional agent builder using the provided strategy configuration.

fun <Input, Output> functionalStrategy(strategy: AIAgentFunctionalStrategy<Input, Output>): FunctionalAgentBuilder<Input, Output>

Sets the functional strategy to be used by the agent builder.

fun <Input, Output> functionalStrategy(strategy: AIAgentFunctionalStrategy<Input, Output>): FunctionalAgentBuilder<Input, Output>

Sets the functional strategy to be used by the agent builder.

graphStrategy

fun <Input, Output> graphStrategy(strategy: AIAgentGraphStrategy<Input, Output>): GraphAgentBuilder<Input, Output>

Configures and returns a GraphAgentBuilder instance using the specified AIAgentGraphStrategy.

fun <Input, Output> graphStrategy(name: String = "graphStrategy", build: BuilderChainAction<GraphStrategyBuilder, AIAgentGraphStrategy<Input, Output>>): GraphAgentBuilder<Input, Output>

Creates a graph agent builder using the provided strategy configuration.

fun <Input, Output> graphStrategy(strategy: AIAgentGraphStrategy<Input, Output>): GraphAgentBuilder<Input, Output>

Configures and returns a GraphAgentBuilder instance using the specified AIAgentGraphStrategy.

fun <Input, Output> graphStrategy(strategy: AIAgentGraphStrategy<Input, Output>): GraphAgentBuilder<Input, Output>

Configures and returns a GraphAgentBuilder instance using the specified AIAgentGraphStrategy.

expect fun id(id: String?): AIAgentBuilder

Sets the identifier for the builder configuration.

fun id(id: String?): AIAgentBuilder

Sets the identifier for the builder configuration.

fun id(id: String?): AIAgentBuilder

Sets the identifier for the builder configuration.

install

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

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

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

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

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

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

llmModel

expect fun llmModel(model: LLModel): AIAgentBuilder

Sets the LLModel instance to be used by the builder.

fun llmModel(model: ai/koog/prompt/llm/LLModel): AIAgentBuilder

Sets the LLModel instance to be used by the builder.

fun llmModel(model: LLModel): AIAgentBuilder

Sets the LLModel instance to be used by the builder.

maxIterations

expect fun maxIterations(maxIterations: Int): AIAgentBuilder

Sets the maximum number of iterations for the builder.

fun maxIterations(maxIterations: Int): AIAgentBuilder

Sets the maximum number of iterations for the builder.

fun maxIterations(maxIterations: Int): AIAgentBuilder

Sets the maximum number of iterations for the builder.

numberOfChoices

expect fun numberOfChoices(numberOfChoices: Int): AIAgentBuilder

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

fun numberOfChoices(numberOfChoices: Int): AIAgentBuilder

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

fun numberOfChoices(numberOfChoices: Int): AIAgentBuilder

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

plannerStrategy

fun <Input, Output> plannerStrategy(strategy: AIAgentPlannerStrategy<Input, Output>): PlannerAgentBuilder<Input, Output>

Configures the planner strategy to be used by an AI agent planner.

fun <Input, Output> plannerStrategy(strategy: AIAgentPlannerStrategy<Input, Output>): PlannerAgentBuilder<Input, Output>

Configures the planner strategy to be used by an AI agent planner.

fun <Input, Output> plannerStrategy(strategy: AIAgentPlannerStrategy<Input, Output>): PlannerAgentBuilder<Input, Output>

Configures the planner strategy to be used by an AI agent planner.

prompt

expect fun prompt(prompt: Prompt): AIAgentBuilder

Sets the prompt to be used by the builder.

fun prompt(prompt: ai/koog/prompt/Prompt): AIAgentBuilder

Sets the prompt to be used by the builder.

fun prompt(prompt: Prompt): AIAgentBuilder

Sets the prompt to be used by the builder.

promptExecutor

expect fun promptExecutor(promptExecutor: PromptExecutor): AIAgentBuilder

Sets the PromptExecutor to be used by the builder instance.

fun promptExecutor(promptExecutor: ai/koog/prompt/executor/model/PromptExecutor): AIAgentBuilder

Sets the PromptExecutor to be used by the builder instance.

fun promptExecutor(promptExecutor: PromptExecutor): AIAgentBuilder

Sets the PromptExecutor to be used by the builder instance.

responseProcessor

expect fun responseProcessor(responseProcessor: ResponseProcessor): AIAgentBuilder

Sets the response processor for the agent.

fun responseProcessor(responseProcessor: ai/koog/prompt/processor/ResponseProcessor): AIAgentBuilder

Sets the response processor for the agent.

fun responseProcessor(responseProcessor: ResponseProcessor): AIAgentBuilder

Sets the response processor for the agent.

systemPrompt

expect fun systemPrompt(systemPrompt: String): AIAgentBuilder

Sets the system prompt to be used by the builder.

fun systemPrompt(systemPrompt: String): AIAgentBuilder

Sets the system prompt to be used by the builder.

fun systemPrompt(systemPrompt: String): AIAgentBuilder

Sets the system prompt to be used by the builder.

temperature

expect fun temperature(temperature: Double): AIAgentBuilder

Sets the temperature value for the builder.

fun temperature(temperature: Double): AIAgentBuilder

Sets the temperature value for the builder.

fun temperature(temperature: Double): AIAgentBuilder

Sets the temperature value for the builder.

toolRegistry

expect fun toolRegistry(toolRegistry: ToolRegistry): AIAgentBuilder

Sets the given ToolRegistry instance to the builder configuration.

fun toolRegistry(toolRegistry: ai/koog/agents/core/tools/ToolRegistry): AIAgentBuilder

Sets the given ToolRegistry instance to the builder configuration.

fun toolRegistry(toolRegistry: ToolRegistry): AIAgentBuilder

Sets the given ToolRegistry instance to the builder configuration.