Package org.springframework.ai.model.function

Class FunctionInvokingFunctionCallback<I,O>

java.lang.Object
org.springframework.ai.model.function.FunctionInvokingFunctionCallback<I,O>
Type Parameters:
I - the input type
O - the output type
All Implemented Interfaces:
BiFunction<I,ToolContext,O>, FunctionCallback
public final class FunctionInvokingFunctionCallback<I,O> extends Object
Note that the underlying function is responsible for converting the output into format that can be consumed by the Model. The default implementation converts the output into String before sending it to the Model. Provide a custom function responseConverter implementation to override this.
Author:
Christian Tzolov

  • Method Details

    • apply

      public O apply(I input, ToolContext context)

    • 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, ToolContext toolContext)
      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. Additionally, the model can pass a context map to the function if available. The context is used to pass additional user provided state in addition to the arguments provided by the AI model.
      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. Arguments are provided by the AI model.
      toolContext - Map with the function context. The context is used to pass additional user provided state in addition to the arguments provided by the AI model.
      Returns:
      String containing the function call response.

    • call

      public String call(String functionArguments)
      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:
      functionArguments - 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.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object