Package org.springframework.ai.model.tool

Record Class DefaultToolExecutionResult

java.lang.Object

java.lang.Record

org.springframework.ai.model.tool.DefaultToolExecutionResult

All Implemented Interfaces:

ToolExecutionResult

public record DefaultToolExecutionResult(List<Message> conversationHistory, boolean returnDirect)
extends Record
implements ToolExecutionResult

Default implementation of ToolExecutionResult.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultToolExecutionResult.Builder

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolExecutionResult

FINISH_REASON, METADATA_TOOL_ID, METADATA_TOOL_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultToolExecutionResult(List<Message> conversationHistory, boolean returnDirect)	Creates an instance of a DefaultToolExecutionResult record class.

Method Summary

Modifier and Type	Method	Description
static DefaultToolExecutionResult.Builder	builder()	Create a default ToolExecutionResult builder.
List<Message>	conversationHistory()	Returns the value of the conversationHistory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	returnDirect()	Returns the value of the returnDirect record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultToolExecutionResult

public DefaultToolExecutionResult(List<Message> conversationHistory,
 boolean returnDirect)

Creates an instance of a DefaultToolExecutionResult record class.

Parameters:

conversationHistory - the value for the conversationHistory record component

returnDirect - the value for the returnDirect record component

Method Details

builder

public static DefaultToolExecutionResult.Builder builder()

Description copied from interface: ToolExecutionResult

Create a default ToolExecutionResult builder.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

conversationHistory

public List<Message> conversationHistory()

Returns the value of the conversationHistory record component.

Specified by:

conversationHistory in interface ToolExecutionResult

Returns:

the value of the conversationHistory record component

returnDirect

public boolean returnDirect()

Returns the value of the returnDirect record component.

Specified by:

returnDirect in interface ToolExecutionResult

Returns:

the value of the returnDirect record component