Package org.springframework.ai.tool.toolsearch

Record Class ToolSearchResponse

java.lang.Object

java.lang.Record

org.springframework.ai.tool.toolsearch.ToolSearchResponse

public record ToolSearchResponse(List<ToolReference> toolReferences, @Nullable Integer totalMatches, @Nullable ToolSearchResponse.SearchMetadata searchMetadata)
extends Record

Response containing a list of ToolReferences matching the search criteria, total matches, and search metadata.

Since:

2.0.0

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolSearchResponse.Builder
static final record	ToolSearchResponse.SearchMetadata	Metadata about how a search was performed.

Constructor Summary

Constructors

Constructor	Description
ToolSearchResponse(List<ToolReference> toolReferences, @Nullable Integer totalMatches, @Nullable ToolSearchResponse.SearchMetadata searchMetadata)	Creates an instance of a ToolSearchResponse record class.

Method Summary

Modifier and Type	Method	Description
static ToolSearchResponse.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 ToolSearchResponse.SearchMetadata	searchMetadata()	Returns the value of the searchMetadata record component.
List<ToolReference>	toolReferences()	Returns the value of the toolReferences record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Integer	totalMatches()	Returns the value of the totalMatches record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ToolSearchResponse

public ToolSearchResponse(List<ToolReference> toolReferences,
 @Nullable Integer totalMatches,
 @Nullable ToolSearchResponse.SearchMetadata searchMetadata)

Creates an instance of a ToolSearchResponse record class.

Parameters:

toolReferences - the value for the toolReferences record component

totalMatches - the value for the totalMatches record component

searchMetadata - the value for the searchMetadata record component

Method Details

builder

public static ToolSearchResponse.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.

toolReferences

public List<ToolReference> toolReferences()

Returns the value of the toolReferences record component.

Returns:

the value of the toolReferences record component

totalMatches

public @Nullable Integer totalMatches()

Returns the value of the totalMatches record component.

Returns:

the value of the totalMatches record component

searchMetadata

public @Nullable ToolSearchResponse.SearchMetadata searchMetadata()

Returns the value of the searchMetadata record component.

Returns:

the value of the searchMetadata record component