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

FunctionalAgentServiceBuilder

class FunctionalAgentServiceBuilder<Input, Output> : AIAgentBuilderBase<FunctionalAgentServiceBuilder<Input, Output>> (source)

A builder class for constructing a FunctionalAIAgentService, enabling a fluent configuration style.

This class allows customization of various parameters and components required for the AI agent service, including strategies, prompts, models, tool registries, and other operational settings.

Type Parameters

Input

The type of data input to the AI agent during execution.

Output

The type of data output by the AI agent after processing.

Functions

agentConfig

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

Configures the current builder instance using the provided AIAgentConfig.

build

fun build(): FunctionalAIAgentService<Input, Output>

Builds and returns a configured instance of FunctionalAIAgentService.

clock

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

Sets the clock for the agent.

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

Sets the identifier for the builder configuration.

install

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

Installs the specified feature into the functional service builder and applies the provided configuration.

llmModel

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

Sets the LLModel instance to be used by the builder.

maxIterations

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

Sets the maximum number of iterations for the builder.

numberOfChoices

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

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

prompt

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

Sets the prompt to be used by the builder.

promptExecutor

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

Sets the PromptExecutor to be used by the builder instance.

responseProcessor

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

Sets the response processor for the agent.

systemPrompt

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

Sets the system prompt to be used by the builder.

temperature

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

Sets the temperature value for the builder.

toolRegistry

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

Sets the given ToolRegistry instance to the builder configuration.