Package org.springframework.ai.tool.toolsearch

Record Class ToolReference

java.lang.Object

java.lang.Record

org.springframework.ai.tool.toolsearch.ToolReference

public record ToolReference(String toolName, @Nullable Double relevanceScore, String summary)
extends Record

Reference to a retrieved Tool with its name, relevance score, and summary.

Since:

2.0.0

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolReference.Builder

Constructor Summary

Constructors

Constructor	Description
ToolReference(String toolName, @Nullable Double relevanceScore, String summary)	Creates an instance of a ToolReference record class.

Method Summary

Modifier and Type	Method	Description
static ToolReference.Builder	builder()
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.
@Nullable Double	relevanceScore()	Returns the value of the relevanceScore record component.
String	summary()	Returns the value of the summary record component.
String	toolName()	Returns the value of the toolName 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

ToolReference

public ToolReference(String toolName,
 @Nullable Double relevanceScore,
 String summary)

Creates an instance of a ToolReference record class.

Parameters:

toolName - the value for the toolName record component

relevanceScore - the value for the relevanceScore record component

summary - the value for the summary record component

Method Details

builder

public static ToolReference.Builder 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

toolName

public String toolName()

Returns the value of the toolName record component.

Returns:

the value of the toolName record component

relevanceScore

public @Nullable Double relevanceScore()

Returns the value of the relevanceScore record component.

Returns:

the value of the relevanceScore record component

summary

public String summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component