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

ReceivedToolResult

data class ReceivedToolResult(val id: String?, val tool: String, val toolArgs: JSONObject, val toolDescription: String?, val content: String, val resultKind: ToolResultKind, val result: JSONElement?)(source)

Represents the result or response received from a tool operation.

Constructors

ReceivedToolResult

constructor(id: String?, tool: String, toolArgs: JSONObject, toolDescription: String?, content: String, resultKind: ToolResultKind, result: JSONElement?)

constructor(id: String?, tool: String, toolArgs: JsonObject, toolDescription: String?, content: String, resultKind: ToolResultKind, result: JsonElement?)

Properties

val content: String

The main content or message associated with the tool result.

val id: String?

An optional identifier for the tool result.

val result: JSONElement?

The result produced by the tool.

val resultKind: ToolResultKind

The kind of result produced by the tool, indicating success, failure, or validation error.

val tool: String

The name or type of the tool that generated the result.

val toolArgs: JSONObject

The arguments provided to the tool during execution.

toolDescription

val toolDescription: String?

An optional description of the tool's functionality.

Functions

fun toMessage(clock: Clock = Clock.System): Message.Tool.Result

Converts the current ReceivedToolResult instance into a Message.Tool.Result object.

fun <TResult> ReceivedToolResult.toSafeResult(tool: Tool<*, TResult>, serializer: JSONSerializer): SafeTool.Result<TResult>

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