Package org.openhab.core.voice.text.interpreter.llm

Record Class LLMToolParam

java.lang.Object
java.lang.Record
org.openhab.core.voice.text.interpreter.llm.LLMToolParam
Record Components:
name - unique name of the parameter
type - type of the parameter
description - parameter description
options - if not empty, defines a list of allowed values for the parameter
required - whether the parameter is required
@NonNullByDefault public record LLMToolParam(String name, LLMToolParamType type, String description, List<String> options, boolean required) extends Record
The LLMToolParam class describe each of the parameters of a LLMTool.
Author:
Miguel Álvarez Díez - Initial contribution

  • Constructor Details

    • LLMToolParam

      public LLMToolParam(String name, LLMToolParamType type, String description, List<String> options, boolean required)
      Creates an instance of a LLMToolParam 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
      options - the value for the options record component
      required - the value for the required 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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 LLMToolParamType 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

    • options

      public List<String> options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • required

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