Package de.espirit.firstspirit.ai

Interface GenerativeAIFunctionRequest.FunctionCallHandle

Enclosing interface:
GenerativeAIFunctionRequest
public static interface GenerativeAIFunctionRequest.FunctionCallHandle
Information about a specific requested function call.
Since:
5.2.250908

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull GenerativeAIFunctionArguments
    getArguments()
    The arguments the function has been request to be invoked with.
    @NotNull Function
    getFunction()
    The associated function requested to be called.
    @NotNull FunctionCall
    getFunctionCall()
    The associated function call requested by the generative AI.
    void
    perform()
    Performs the registered function using the requested arguments.

  • Method Details

    • getFunction

      @NotNull @NotNull Function getFunction()
      The associated function requested to be called.
      Returns:
      The associated function definition.
      Since:
      5.2.250908

    • getFunctionCall

      @NotNull @NotNull FunctionCall getFunctionCall()
      The associated function call requested by the generative AI.
      Returns:
      The function call.
      Since:
      5.2.250908

    • getArguments

      @NotNull @NotNull GenerativeAIFunctionArguments getArguments() throws IOException
      The arguments the function has been request to be invoked with.
      Returns:
      The function arguments.
      Throws:
      IOException - If the function arguments JSON string could not be parsed.
      Since:
      5.2.250908

    • perform

      void perform() throws IOException
      Performs the registered function using the requested arguments.
      Throws:
      IOException - If an error occurs while processing the arguments or function result as JSON string.
      Since:
      5.2.250908