Package org.springframework.ai.openai.responses

Record Class HostedTool.FileSearch

java.lang.Object
java.lang.Record
org.springframework.ai.openai.responses.HostedTool.FileSearch
Record Components:
vectorStoreIds - the vector stores to search; at least one is required
maxNumResults - maximum number of results, or null for the provider default
All Implemented Interfaces:
HostedTool
Enclosing interface:
HostedTool
public static record HostedTool.FileSearch(List<String> vectorStoreIds, @Nullable Integer maxNumResults) extends Record implements HostedTool
Search vector stores hosted at OpenAI.

  • Constructor Details

    • FileSearch

      public FileSearch(List<String> vectorStoreIds, @Nullable Integer maxNumResults)
      Creates an instance of a FileSearch record class.
      Parameters:
      vectorStoreIds - the value for the vectorStoreIds record component
      maxNumResults - the value for the maxNumResults record component

  • Method Details

    • of

      public static HostedTool.FileSearch of(String... vectorStoreIds)

    • toTool

      public com.openai.models.responses.Tool toTool()
      Description copied from interface: HostedTool
      Convert this tool to the SDK request representation.
      Specified by:
      toTool in interface HostedTool

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

    • vectorStoreIds

      public List<String> vectorStoreIds()
      Returns the value of the vectorStoreIds record component.
      Returns:
      the value of the vectorStoreIds record component

    • maxNumResults

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