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 output: String, val resultKind: ToolResultKind, val result: JSONElement?, val resultObject: Any? = null)(source)

Represents the result or response received from a tool operation.

Constructors

ReceivedToolResult

constructor(id: String?, tool: String, toolArgs: JSONObject, toolDescription: String?, output: String, resultKind: ToolResultKind, result: JSONElement?, resultObject: Any? = null)

Properties

val id: String?

An optional identifier for the tool result.

output

val output: String

The main content or message associated with the tool result.

result

val result: JSONElement?

The result produced by the tool.

resultKind

val resultKind: ToolResultKind

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

resultObject

@Transient

val resultObject: Any?

The raw result object produced by the tool. This value will not survive serialization, hence it should be used with caution and is marked as @InternalAgentsApi.

tool

val tool: String

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

toolArgs

val toolArgs: JSONObject

The arguments provided to the tool during execution.

toolDescription

val toolDescription: String?

An optional description of the tool's functionality.

Functions

toMessagePart

fun toMessagePart(): MessagePart.Tool.Result

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

toSafeResult

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

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