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

AIAgent

interface AIAgent<Input, Output> : Closeable(source)

Represents a basic interface for AI agent.

Inheritors

Types

The companion object for the AIAgent class, providing functionality to instantiate an AI agent with a flexible configuration, input/output types, and execution strategy.

Properties

agentConfig

abstract val agentConfig: AIAgentConfigBase

The configuration for the AI agent.

abstract val id: String

Represents the unique identifier for the AI agent.

Functions

asTool

inline fun <Input, Output> AIAgent<Input, Output>.~~asTool~~(agentName: String, agentDescription: String, inputDescription: String? = null, inputSerializer: KSerializer<Input> = serializer(), outputSerializer: KSerializer<Output> = serializer(), json: Json = Json.Default): Tool<AIAgentTool.AgentToolArgs, AIAgentTool.AgentToolResult>

Converts the current AI agent into a tool to allow using it in other agents as a tool.

abstract suspend fun close()

getState

abstract suspend fun getState(): AIAgent.Companion.State<Output>

Retrieves the current state of the AI agent during its lifecycle.

isFinished

suspend fun AIAgent<*, *>.isFinished(): Boolean

Checks whether the AI agent has reached a finished state.

isRunning

suspend fun AIAgent<*, *>.isRunning(): Boolean

Checks whether the AI agent is currently in a running state.

result

open suspend fun result(): Output

Retrieves the result of the operation if the current state is State.Finished. Throws an IllegalStateException if the operation is not in a finished state.

run

abstract suspend fun run(agentInput: Input): Output

Executes the AI agent with the given input and retrieves the resulting output.