Interface FunctionCall

All Superinterfaces:
ToolCall

@Experimental public interface FunctionCall extends ToolCall
Instructions for invoking a previously specified Function.
Since:
5.2.250908
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Builder for a FunctionCall instance.
  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull FunctionCall.Builder
    Creates a new builder for creating a FunctionCall definition.
    @NotNull String
    Returns the function arguments as JSON string.
    @NotNull String
    Returns the name of the function to be called.

    Methods inherited from interface de.espirit.firstspirit.ai.dto.ToolCall

    getId, getType
  • Method Details

    • builder

      @NotNull static @NotNull FunctionCall.Builder builder()
      Creates a new builder for creating a FunctionCall definition.
      Returns:
      The new builder instance.
      Since:
      5.2.250908
    • getName

      @NotNull @NotNull String getName()
      Returns the name of the function to be called.
      Returns:
      The function name.
      Since:
      5.2.250908
    • getArguments

      @NotNull @NotNull String getArguments()
      Returns the function arguments as JSON string. Maybe chunk-based for streamed responses.
      Returns:
      The function arguments.
      Since:
      5.2.250908