Package io.github.stefanbratanov.jvm.openai

Record Class ToolCall.RetrievalToolCall

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.ToolCall.RetrievalToolCall
All Implemented Interfaces:
ToolCall
Enclosing interface:
ToolCall
public static record ToolCall.RetrievalToolCall(String id, Map<String,Object> retrieval) extends Record implements ToolCall

  • Constructor Details

    • RetrievalToolCall

      public RetrievalToolCall(String id, Map<String,Object> retrieval)
      Creates an instance of a RetrievalToolCall record class.
      Parameters:
      id - the value for the id record component
      retrieval - the value for the retrieval record component

  • Method Details

    • type

      public String type()
      Description copied from interface: ToolCall
      The type of tool call
      Specified by:
      type in interface ToolCall

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

    • id

      public String id()
      Returns the value of the id record component.
      Specified by:
      id in interface ToolCall
      Returns:
      the value of the id record component

    • retrieval

      public Map<String,Object> retrieval()
      Returns the value of the retrieval record component.
      Returns:
      the value of the retrieval record component