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

FunctionalAIAgentService

class FunctionalAIAgentService<Input, Output>(val promptExecutor: PromptExecutor, val agentConfig: AIAgentConfig, val strategy: AIAgentFunctionalStrategy<Input, Output>, val toolRegistry: ToolRegistry, val installFeatures: FunctionalAIAgent.FeatureContext.() -> Unit) : AIAgentServiceBase<Input, Output, FunctionalAIAgent<Input, Output>> (source)

A service for managing functional AI agents that operate based on a specified execution strategy.

This class provides the infrastructure for creating and managing functional AI agents. It integrates an execution strategy with associated input and output types, a tool registry for additional functionalities, and a customizable feature installation context.

Parameters

Input

The type of input data that the functional AI agent will process.

Output

The type of output data produced by the functional AI agent.

Constructors

FunctionalAIAgentService

constructor(promptExecutor: PromptExecutor, agentConfig: AIAgentConfig, strategy: AIAgentFunctionalStrategy<Input, Output>, toolRegistry: ToolRegistry, installFeatures: FunctionalAIAgent.FeatureContext.() -> Unit)

Properties

agentConfig

open override val agentConfig: AIAgentConfig

The configuration settings for the AI agent, including model and prompt behavior.

installFeatures

val installFeatures: FunctionalAIAgent.FeatureContext.() -> Unit

promptExecutor

open override val promptExecutor: PromptExecutor

The executor responsible for handling and executing prompts.

strategy

val strategy: AIAgentFunctionalStrategy<Input, Output>

The functional strategy defining the agent's iteration logic and processing behavior.

toolRegistry

open override val toolRegistry: ToolRegistry

Represents the central repository or registry for managing tools within the system.

Functions

agentById

suspend override fun agentById(id: String): FunctionalAIAgent<Input, Output>?

Retrieves an AI agent managed by this service based on the provided unique identifier.

closeAll

open suspend fun closeAll()

Closes all AI agents currently managed by the service.

createAgent

suspend override fun createAgent(id: String?, additionalToolRegistry: ToolRegistry, agentConfig: AIAgentConfig, clock: Clock): FunctionalAIAgent<Input, Output>

Creates and registers a new managed AI agent with the specified configuration and tool registry.

createAgentAndRun

open suspend fun createAgentAndRun(agentInput: Input, id: String? = null, additionalToolRegistry: ToolRegistry = this.toolRegistry, agentConfig: AIAgentConfig = this.agentConfig, clock: Clock = Clock.System): Output

Creates an AI agent with the specified configuration and runs it using the provided input.

createAgentTool

inline fun <Input, Output> AIAgentService<Input, Output, *>.createAgentTool(agentName: String, agentDescription: String, inputDescription: String? = null, inputSerializer: KSerializer<Input> = serializer(), outputSerializer: KSerializer<Output> = serializer(), parentAgentId: String? = null, clock: Clock = Clock.System): Tool<Input, AIAgentTool.AgentToolResult<Output>>

Creates an AIAgent and converts it to a Tool that can be used by other AI Agents.

createManagedAgent

open override fun createManagedAgent(id: String?, additionalToolRegistry: ToolRegistry, agentConfig: AIAgentConfig, clock: Clock): FunctionalAIAgent<Input, Output>

Creates and returns a managed instance of FunctionalAIAgent.

listActiveAgents

suspend override fun listActiveAgents(): List<FunctionalAIAgent<Input, Output>>

Retrieves a list of all currently active AI agents managed by the service.

listAllAgents

open suspend override fun listAllAgents(): List<FunctionalAIAgent<Input, Output>>

Retrieves a list of all AI agents currently managed by the service, regardless of their state (e.g., active, inactive, or finished).

listFinishedAgents

suspend override fun listFinishedAgents(): List<FunctionalAIAgent<Input, Output>>

Retrieves a list of all agents that have already finished their task.

listInactiveAgents

suspend override fun listInactiveAgents(): List<FunctionalAIAgent<Input, Output>>

Retrieves a list of inactive AI agents managed by this service.

removeAgent

suspend override fun removeAgent(agent: FunctionalAIAgent<Input, Output>): Boolean

Removes the specified AI agent from the managed collection.

removeAgentWithId

suspend override fun removeAgentWithId(id: String): Boolean

Removes a managed AI agent identified by the specified unique identifier.