Record Class ToolDefinition.ToolParameter

java.lang.Object
java.lang.Record
group.worldstandard.pudel.api.agent.ToolDefinition.ToolParameter
Enclosing class:
ToolDefinition
public static record ToolDefinition.ToolParameter(String name, Class<?> type, String description, boolean required, Object defaultValue) extends Record
Represents a parameter for a tool, defining its characteristics such as name, type, description, whether it is required, and its default value.

Provides a method to retrieve the type name suitable for LLM descriptions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolParameter(String name, Class<?> type, String description, boolean required, Object defaultValue)
    Creates an instance of a ToolParameter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    defaultValue()
    Returns the value of the defaultValue record component.
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getTypeName()
    Returns the name of the parameter type as a string suitable for LLM descriptions.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    boolean
    required()
    Returns the value of the required record component.
    final String
    toString()
    Returns a string representation of this record class.
    Class<?>
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ToolParameter

      public ToolParameter(String name, Class<?> type, String description, boolean required, Object defaultValue)
      Creates an instance of a ToolParameter record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      description - the value for the description record component
      required - the value for the required record component
      defaultValue - the value for the defaultValue record component

  • Method Details

    • getTypeName

      public String getTypeName()
      Returns the name of the parameter type as a string suitable for LLM descriptions.

      Maps Java primitive and wrapper types to their corresponding JSON schema type names. For example, Integer and int both map to "integer", while Double and double map to "number".

      Returns:
      the type name as a string; one of "string", "integer", "number", or "boolean"

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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

    • type

      public Class<?> type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • description

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

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • defaultValue

      public Object defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component