Embabel Agent Documentation/com.embabel.agent.spi.loop/ToolLoopResult

ToolLoopResult

data class ToolLoopResult<O>(val result: O, val rawResponseText: String = "", val conversationHistory: List<Message>, val totalIterations: Int, val injectedTools: List<Tool>, val removedTools: List<Tool> = emptyList(), val totalUsage: Usage? = null, val replanRequested: Boolean = false, val replanReason: String? = null, val blackboardUpdater: BlackboardUpdater = BlackboardUpdater {}, val thinkingBlocks: List<<Error class: unknown class>> = emptyList())

Result of executing an Embabel tool loop.

Parameters

The output type

result

The parsed result

rawResponseText

The raw LLM response text before parsing, preserved for guardrail validation

conversationHistory

Full conversation history including tool calls

totalIterations

Number of LLM inference iterations

injectedTools

All tools added during the conversation via injection strategies

removedTools

All tools removed during the conversation via injection strategies

totalUsage

Accumulated usage across all LLM calls in the loop

replanRequested

True if the loop terminated due to a tool requesting replanning

replanReason

Human-readable explanation of why replan was requested

blackboardUpdater

Callback to update the blackboard before replanning

Constructors

ToolLoopResult

constructor(result: O, rawResponseText: String = "", conversationHistory: List<Message>, totalIterations: Int, injectedTools: List<Tool>, removedTools: List<Tool> = emptyList(), totalUsage: Usage? = null, replanRequested: Boolean = false, replanReason: String? = null, blackboardUpdater: BlackboardUpdater = BlackboardUpdater {}, thinkingBlocks: List<<Error class: unknown class>> = emptyList())

Properties

blackboardUpdater

val blackboardUpdater: BlackboardUpdater

conversationHistory

val conversationHistory: List<Message>

injectedTools

val injectedTools: List<Tool>

rawResponseText

val rawResponseText: String

removedTools

val removedTools: List<Tool>

replanReason

val replanReason: String? = null

replanRequested

val replanRequested: Boolean = false

result

val result: O

thinkingBlocks

val thinkingBlocks: List<<Error class: unknown class>>

Thinking blocks accumulated in iteration order across all tool loop calls. Populated only when the sender is wrapped with ThinkingCapturingLlmMessageSender, which merges native + prompt-based blocks per iteration. Empty on non-thinking paths.

totalIterations

val totalIterations: Int

totalUsage

val totalUsage: Usage? = null