Package org.springframework.ai.model.function

Record Class FunctionCallingHelper.FunctionDefinition

java.lang.Object
java.lang.Record
org.springframework.ai.model.function.FunctionCallingHelper.FunctionDefinition
Record Components:
name - the function name
description - the function description
inputTypeSchema - the input type schema
All Implemented Interfaces:
FunctionCallback
Enclosing class:
FunctionCallingHelper
public static record FunctionCallingHelper.FunctionDefinition(String name, String description, String inputTypeSchema) extends Record implements FunctionCallback
Helper used to provide only the function definition, without the actual function call implementation.

  • Constructor Details

    • FunctionDefinition

      public FunctionDefinition(String name, String description, String inputTypeSchema)
      Creates an instance of a FunctionDefinition record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      inputTypeSchema - the value for the inputTypeSchema record component

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface FunctionCallback
      Returns:
      Returns the Function name. Unique within the model.

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface FunctionCallback
      Returns:
      Returns the function description. This description is used by the model do decide if the function should be called or not.

    • getInputTypeSchema

      public String getInputTypeSchema()
      Specified by:
      getInputTypeSchema in interface FunctionCallback
      Returns:
      Returns the JSON schema of the function input type.

    • call

      public String call(String functionInput)
      Description copied from interface: FunctionCallback
      Called when a model detects and triggers a function call. The model is responsible to pass the function arguments in the pre-configured JSON schema format.
      Specified by:
      call in interface FunctionCallback
      Parameters:
      functionInput - JSON string with the function arguments to be passed to the function. The arguments are defined as JSON schema usually registered with the model.
      Returns:
      String containing the function call response.

    • 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

    • inputTypeSchema

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