Package io.github.glaforge.gemini.interactions.model

Record Class Tool.Function

java.lang.Object
java.lang.Record
io.github.glaforge.gemini.interactions.model.Tool.Function
Record Components:
type - The type of tool (must be "function").
name - The name of the function.
description - A description of the function.
parameters - The parameters of the function (JSON Schema).
All Implemented Interfaces:
Tool
Enclosing interface:
Tool
public static record Tool.Function(String type, String name, String description, Map<String,Object> parameters) extends Record implements Tool
Tool definition for a function.

  • Constructor Details

    • Function

      public Function(String name, String description, Map<String,Object> parameters)
      Creates a new Function tool.
      Parameters:
      name - The name of the function.
      description - A description of the function.
      parameters - The parameters of the function.

    • Function

      public Function(String type, String name, String description, Map<String,Object> parameters)
      Creates an instance of a Function record class.
      Parameters:
      type - the value for the type record component
      name - the value for the name record component
      description - the value for the description record component
      parameters - the value for the parameters record component

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

    • type

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

    • 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