Record Class ToolCall

Record Components:
id - client-visible call id (e.g. call_abc123).
type - always "function" for v1.
function - function name and JSON arguments.

public record ToolCall(String id, String type, FunctionCall function) extends Record
OpenAI-compatible tool call emitted by the assistant.
  • Constructor Details

  • Method Details

    • function

      public static ToolCall function(String id, FunctionCall function)
      Convenience factory for a function tool call.
      Parameters:
      id - call id.
      function - function payload.
      Returns:
      tool call with type = "function".
    • 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.
      Returns:
      the value of the id record component
    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component
    • function

      public FunctionCall function()
      Returns the value of the function record component.
      Returns:
      the value of the function record component