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

AIAgentServiceBase

abstract class AIAgentServiceBase<Input, Output, TAgent : AIAgent<Input, Output>> : AIAgentService<Input, Output, TAgent> (source)

Abstract base class for implementing an AI Agent Service. This class provides foundational functionality for managing and interacting with AI agents.

The class maintains a list of AI agents under its management and defines common operations, such as creation, removal, querying, and shutting down agents. Concrete implementations are expected to define the behavior for creating managed agents.

Parameters

Input

the input type expected by the AI agents.

Output

the output type expected from the AI agents.

Inheritors

GraphAIAgentService

FunctionalAIAgentService

Constructors

AIAgentServiceBase

constructor()

Properties

agentConfig

abstract val agentConfig: AIAgentConfig

Holds the configuration details for an AI agent.

promptExecutor

abstract val promptExecutor: PromptExecutor

Represents an instance of PromptExecutor responsible for executing prompt-based operations.

toolRegistry

abstract val toolRegistry: ToolRegistry

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

Functions

agentById

suspend override fun agentById(id: String): TAgent?

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): TAgent

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

abstract fun createManagedAgent(id: String? = null, additionalToolRegistry: ToolRegistry, agentConfig: AIAgentConfig, clock: Clock = Clock.System): TAgent

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

listActiveAgents