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.

Type 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

expect abstract val agentConfig: AIAgentConfig

Holds the configuration details for an AI agent.

promptExecutor

expect abstract val promptExecutor: PromptExecutor

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

toolRegistry

expect 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.

createAgent

suspend override fun createAgent(id: String? = null, additionalToolRegistry: ToolRegistry = ToolRegistry.EMPTY, agentConfig: AIAgentConfig = this.agentConfig, clock: Clock = Clock.System): TAgent

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

createAgentAndRun

open suspend override 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, inputType: TypeToken = typeToken<Input>(), outputType: TypeToken = typeToken<Output>(), parentAgentId: String? = null, clock: Clock = Clock.System): Tool<AIAgentTool.AgentToolInput<Input>, AIAgentTool.AgentToolResult<Output>>

inline fun <Input, Output> AIAgentService<Input, Output, *>.~~createAgentTool~~(agentName: String, agentDescription: String, inputDescription: String? = null, inputSerializer: KSerializer<Input>, outputSerializer: KSerializer<Output>, parentAgentId: String? = null, clock: Clock = Clock.System): Tool<AIAgentTool.AgentToolInput<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.

removeAgent

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