agents-core/ai.koog.agents.core.environment/AIAgentEnvironment

AIAgentEnvironment

AIAgentEnvironment provides a mechanism for AI agents to interface with an external environment. It offers methods for tool execution, error reporting, and sending termination messages.

Inheritors

ContextualAgentEnvironment

GenericAgentEnvironment

Functions

executeTool

abstract suspend fun executeTool(toolCall: MessagePart.Tool.Call): ReceivedToolResult

Executes a tool call and returns its result.

open suspend fun executeTool(toolCall: MessagePart.Tool.Call, metadata: ToolCallMetadata): ReceivedToolResult

Executes a tool call with caller-supplied metadata and returns its result.

executeTools

open suspend fun executeTools(toolCalls: List<MessagePart.Tool.Call>): List<ReceivedToolResult>

Executes a batch of tool calls within the AI agent environment and processes their results.

open suspend fun executeTools(toolCalls: List<MessagePart.Tool.Call>, metadata: ToolCallMetadata): List<ReceivedToolResult>

Executes a batch of tool calls with shared caller-supplied metadata and returns their results.

reportProblem

abstract suspend fun reportProblem(exception: Throwable)

Reports a problem that occurred within the environment.