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

Package-level declarations

Types

data class ReceivedToolResult(val id: String?, val tool: String, val content: String, val result: ToolResult?)

Represents the result or response received from a tool operation.

data class SafeTool<TArgs : Tool.Args, TResult : ToolResult>(tool: Tool<TArgs, TResult>, environment: AIAgentEnvironment, clock: Clock)

A wrapper class designed to safely execute a tool within a given AI agent environment. It provides mechanisms for handling tool execution results and differentiating between success and failure cases.

SafeToolFromCallable

data class SafeToolFromCallable<TResult>(val toolFunction: KFunction<TResult>, environment: AIAgentEnvironment, clock: Clock)

A wrapper class that creates a safer abstraction for executing a tool function alongside an associated environment. The tool function is backed by a callable in the form of a KFunction and interacts with the AIAgentEnvironment to perform operations and exchange data.

TerminationTool

object TerminationTool

Provides constants related to the termination tool functionality in an AI agent environment.

Functions

executeTool

suspend fun AIAgentEnvironment.executeTool(toolCall: Message.Tool.Call): ReceivedToolResult

result

fun PromptBuilder.ToolMessageBuilder.result(result: ReceivedToolResult)

Adds a tool result to the prompt.

toResult

fun AIAgentEnvironmentToolResultToAgentContent.toResult(): ReceivedToolResult

Converts an instance of AIAgentEnvironmentToolResultToAgentContent to a ReceivedToolResult.

fun EnvironmentToolResultToAgentContent.toResult(): ReceivedToolResult

Converts an instance of AIAgentEnvironmentToolResultToAgentContent to a ReceivedToolResult.

toSafeResult

fun <TResult : ToolResult> ReceivedToolResult.toSafeResult(): SafeTool.Result<TResult>

Converts a ReceivedToolResult instance into a SafeTool.Result for safer result handling.