Package de.espirit.firstspirit.ai.dto

Interface Function

All Superinterfaces:
Tool
@Experimental public interface Function extends Tool
Definition of a function.
Since:
5.2.250908

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Function.Builder
    Builder for a function definition.

  • Field Summary

    Fields inherited from interface de.espirit.firstspirit.ai.dto.Tool

    TYPE_FUNCTION

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Function.Builder
    builder()
    Creates a new builder for creating a Function definition.
    @NotNull String
    getDescription()
    A description of what the function does, used by the model to choose when and how to call the function.
    @NotNull String
    getName()
    The name of the function.
    @NotNull List<FunctionParameter>
    getParameters()
    A list of parameters for this function.

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

    getType

  • Method Details

    • builder

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

    • getName

      @NotNull @NotNull String getName()
      The name of the function.
      Returns:
      The function name.
      Since:
      5.2.250908

    • getDescription

      @NotNull @NotNull String getDescription()
      A description of what the function does, used by the model to choose when and how to call the function.
      Returns:
      The description of the function.
      Since:
      5.2.250908

    • getParameters

      @NotNull @NotNull List<FunctionParameter> getParameters()
      A list of parameters for this function.
      Returns:
      The function parameters.
      Since:
      5.2.250908