Package org.springframework.ai.openai.responses

Record Class HostedTool.WebSearch

java.lang.Object
java.lang.Record
org.springframework.ai.openai.responses.HostedTool.WebSearch
Record Components:
searchContextSize - one of low, medium, high, or null for the provider default
allowedDomains - restricts results to these domains, or null for no restriction
All Implemented Interfaces:
HostedTool
Enclosing interface:
HostedTool
public static record HostedTool.WebSearch(@Nullable String searchContextSize, @Nullable List<String> allowedDomains) extends Record implements HostedTool
Search the public web. See the web search guide.

  • Constructor Details

    • WebSearch

      public WebSearch(@Nullable String searchContextSize, @Nullable List<String> allowedDomains)
      Creates an instance of a WebSearch record class.
      Parameters:
      searchContextSize - the value for the searchContextSize record component
      allowedDomains - the value for the allowedDomains record component

  • Method Details

    • of

      public static HostedTool.WebSearch of()

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

    • searchContextSize

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

    • allowedDomains

      public @Nullable List<String> allowedDomains()
      Returns the value of the allowedDomains record component.
      Returns:
      the value of the allowedDomains record component