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

AIAgent

expect abstract class AIAgent<Input, Output> : Closeable(source)

Represents a basic interface for AI agent.

Inheritors

AIAgentBase

actual abstract class AIAgent<Input, Output> : <ERROR CLASS> ERROR CLASS: Symbol not found for Closeable(source)

Represents a basic interface for AI agent.

actual abstract class AIAgent<Input, Output> : Closeable(source)

Represents a basic interface for AI agent.

Constructors

AIAgent

expect constructor()

constructor()

Types

Companion

expect object Companion

Companion object with builder for AIAgent

actual object Companion

Companion object with builder for AIAgent

actual object Companion

Companion object with builder for AIAgent

Properties

agentConfig

expect abstract val agentConfig: AIAgentConfig

The configuration for the AI agent.

actual abstract val agentConfig: AIAgentConfig

The configuration for the AI agent.

actual abstract val agentConfig: AIAgentConfig

The configuration for the AI agent.

expect abstract val id: String

Represents the unique identifier for the AI agent.

actual abstract val id: String

Represents the unique identifier for the AI agent.

actual 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.AgentToolInput<Input>, AIAgentTool.AgentToolResult<Output>>

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

abstract suspend fun close()

createSession

expect abstract fun createSession(sessionId: String? = null): AIAgentRunSession<Input, Output, out AIAgentContext>

Creates a new session for executing the agent with the given input.

actual abstract fun createSession(sessionId: String?): AIAgentRunSession<Input, Output, out AIAgentContext>

Creates a new session for executing the agent with the given input.

actual abstract fun createSession(sessionId: String?): AIAgentRunSession<Input, Output, out AIAgentContext>

Creates a new session for executing the agent with the given input.

run

expect abstract suspend fun run(agentInput: Input, sessionId: String? = null): Output

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

actual abstract suspend fun run(agentInput: Input, sessionId: String?): Output

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

actual abstract suspend fun run(agentInput: Input, sessionId: String?): Output

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

runBlocking

fun runBlocking(agentInput: Input, sessionId: String? = null): Output

Executes the AI agent task based on the provided input.