Package org.springframework.ai.tool.toolsearch

Record Class ToolSearchRequest

java.lang.Object
java.lang.Record
org.springframework.ai.tool.toolsearch.ToolSearchRequest
Record Components:
sessionId - identifies the session whose tool index is searched
query - natural-language description of the needed capability
maxResults - maximum number of results to return; null lets the tool index apply its own default
categoryFilter - optional hint to narrow the search to a specific tool category; support depends on the org.springframework.ai.chat.client.advisor.toolsearch.ToolIndex implementation
public record ToolSearchRequest(String sessionId, String query, @Nullable Integer maxResults, @Nullable String categoryFilter) extends Record
Request for searching tools within a session's index.
Since:
2.0.0
Author:
Christian Tzolov

  • Constructor Details

    • ToolSearchRequest

      public ToolSearchRequest(String sessionId, String query, @Nullable Integer maxResults, @Nullable String categoryFilter)
      Creates an instance of a ToolSearchRequest record class.
      Parameters:
      sessionId - the value for the sessionId record component
      query - the value for the query record component
      maxResults - the value for the maxResults record component
      categoryFilter - the value for the categoryFilter record component

  • Method Details

    • 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.

    • sessionId

      public String sessionId()
      Returns the value of the sessionId record component.
      Returns:
      the value of the sessionId record component

    • query

      public String query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component

    • maxResults

      public @Nullable Integer maxResults()
      Returns the value of the maxResults record component.
      Returns:
      the value of the maxResults record component

    • categoryFilter

      public @Nullable String categoryFilter()
      Returns the value of the categoryFilter record component.
      Returns:
      the value of the categoryFilter record component