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

AIAgentServiceBase

abstract class AIAgentServiceBase<Input, Output> : AIAgentService<Input, Output> (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): AIAgent<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?, clock: Clock): AIAgent<Input, Output>

Creates and registers a new AI agent using the provided agent ID and clock.

createAgentAndRun

open suspend fun createAgentAndRun(agentInput: Input, id: String? = null, clock: Clock = Clock.System): Output

Creates a new AI agent with the specified optional parameters (id, clock), executes it with the given input, and retrieves the resulting output.

createAgentTool

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

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

createManagedAgent

abstract fun createManagedAgent(id: String? = null, clock: Clock = Clock.System): AIAgent<Input, Output>

Creates and registers a managed AI agent with an optional identifier and clock instance.

listActiveAgents

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

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

listAllAgents

open suspend override fun listAllAgents(): List<AIAgent<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<AIAgent<Input, Output>>

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

listInactiveAgents

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

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

removeAgent

suspend override fun removeAgent(agent: AIAgent<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.