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

AIAgentBuilderAPI

interface AIAgentBuilderAPI(source)

A platform-agnostic API describing the full surface of AIAgentBuilder.

Note on return types:

Methods that previously returned AIAgentBuilder now return AIAgentBuilderAPI here so that common implementation classes can return this while platform actual classes can covariantly narrow the return type back to AIAgentBuilder.

Inheritors

AIAgentBuilder

Functions

agentConfig

abstract fun agentConfig(config: AIAgentConfig): AIAgentBuilderAPI

Configures the current AIAgentBuilder instance using the provided AIAgentConfig.

build

abstract fun build(): AIAgent<String, String>

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

functionalStrategy

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

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

graphStrategy

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

Configures and returns a GraphAgentBuilder instance using the specified AIAgentGraphStrategy.

abstract fun id(id: String?): AIAgentBuilderAPI

Sets the identifier for the builder configuration.

install

abstract 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

abstract fun llmModel(model: LLModel): AIAgentBuilderAPI

Sets the LLModel instance to be used by the builder.

maxIterations

abstract fun maxIterations(maxIterations: Int): AIAgentBuilderAPI

Sets the maximum number of iterations for the builder.

numberOfChoices

abstract fun numberOfChoices(numberOfChoices: Int): AIAgentBuilderAPI

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

plannerStrategy

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

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

abstract fun <Input : Any, Output : Any> plannerStrategy(name: String, buildStrategy: BuilderChainAction<AIAgentPlannerStrategyBuilder, TypedAgentPlannerStrategyBuilder<Input, Output>>): PlannerAgentBuilder<Input, Output>

Defines a strategy for the planner using a specified builder chain action.

prompt

abstract fun prompt(prompt: Prompt): AIAgentBuilderAPI

Sets the prompt to be used by the builder.

promptExecutor

abstract fun promptExecutor(promptExecutor: PromptExecutor): AIAgentBuilderAPI

Sets the PromptExecutor to be used by the builder instance.

systemPrompt

abstract fun systemPrompt(systemPrompt: String): AIAgentBuilderAPI

Sets the system prompt to be used by the builder.

temperature

abstract fun temperature(temperature: Double): AIAgentBuilderAPI

Sets the temperature value for the builder.

toolRegistry

abstract fun toolRegistry(toolRegistry: ToolRegistry): AIAgentBuilderAPI

Sets the given ToolRegistry instance to the builder configuration.