Package org.springframework.ai.tool.toolsearch

Record Class ToolSearchResponse.SearchMetadata

java.lang.Object

java.lang.Record

org.springframework.ai.tool.toolsearch.ToolSearchResponse.SearchMetadata

Record Components:

searchType - a label identifying the ToolIndex implementation that produced this response — typically the simple class name (e.g. "LuceneToolIndex"). Custom implementations may return any non-null, non-empty string.

query - the original query string passed to the tool index

searchTimeMs - elapsed time in milliseconds, or null if not measured

Enclosing class:

ToolSearchResponse

public static record ToolSearchResponse.SearchMetadata(String searchType, String query, @Nullable Long searchTimeMs)
extends Record

Metadata about how a search was performed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolSearchResponse.SearchMetadata.Builder

Constructor Summary

Constructors

Constructor	Description
SearchMetadata(String searchType, String query, @Nullable Long searchTimeMs)	Creates an instance of a SearchMetadata record class.

Method Summary

Modifier and Type	Method	Description
static ToolSearchResponse.SearchMetadata.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.
String	query()	Returns the value of the query record component.
@Nullable Long	searchTimeMs()	Returns the value of the searchTimeMs record component.
String	searchType()	Returns the value of the searchType 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

SearchMetadata

public SearchMetadata(String searchType,
 String query,
 @Nullable Long searchTimeMs)

Creates an instance of a SearchMetadata record class.

Parameters:

searchType - the value for the searchType record component

query - the value for the query record component

searchTimeMs - the value for the searchTimeMs record component

Method Details

builder

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

searchType

public String searchType()

Returns the value of the searchType record component.

Returns:

the value of the searchType record component

query

public String query()

Returns the value of the query record component.

Returns:

the value of the query record component

searchTimeMs

public @Nullable Long searchTimeMs()

Returns the value of the searchTimeMs record component.

Returns:

the value of the searchTimeMs record component