Record Class FunctionDefinition

java.lang.Object
java.lang.Record
smile.llm.FunctionDefinition
Record Components:
name - function name (required).
description - human-readable description; may be null.
parameters - JSON Schema object as a map; may be null.
public record FunctionDefinition(String name, String description, Map<String,Object> parameters) extends Record
OpenAI-style function definition inside a ToolDefinition.

  • Constructor Details

    • FunctionDefinition

      public FunctionDefinition(String name, String description, Map<String,Object> parameters)
      Compact canonical constructor.

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

    • name

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

    • description

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

    • parameters

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