Package org.springframework.ai.model.tool

Interface ToolExecutionResult

All Known Implementing Classes:

DefaultToolExecutionResult

public interface ToolExecutionResult

The result of a tool execution.

Since:

1.0.0

Author:

Thomas Vitale

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FINISH_REASON
static final String	METADATA_TOOL_ID
static final String	METADATA_TOOL_NAME

Method Summary

Modifier and Type	Method	Description
static DefaultToolExecutionResult.Builder	builder()	Create a default ToolExecutionResult builder.
static List<Generation>	buildGenerations(ToolExecutionResult toolExecutionResult)	Build a list of Generation from the tool execution result, useful for sending the tool execution result to the client directly.
List<Message>	conversationHistory()	The history of messages exchanged during the conversation, including the tool execution result.
default boolean	returnDirect()	Whether the tool execution result should be returned directly or passed back to the model.

Field Details

FINISH_REASON

static final String FINISH_REASON

See Also:

• Constant Field Values

METADATA_TOOL_ID

static final String METADATA_TOOL_ID

See Also:

• Constant Field Values

METADATA_TOOL_NAME

static final String METADATA_TOOL_NAME

See Also:

• Constant Field Values

Method Details

conversationHistory

List<Message> conversationHistory()

The history of messages exchanged during the conversation, including the tool execution result.

returnDirect

default boolean returnDirect()

Whether the tool execution result should be returned directly or passed back to the model.

builder

static DefaultToolExecutionResult.Builder builder()

Create a default ToolExecutionResult builder.

buildGenerations

static List<Generation> buildGenerations(ToolExecutionResult toolExecutionResult)

Build a list of Generation from the tool execution result, useful for sending the tool execution result to the client directly.