Package de.espirit.firstspirit.ai.dto

Interface FunctionParameter

@Experimental public interface FunctionParameter
Definition of a function parameter.
Since:
5.2.250908

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull FunctionParameter.Builder
    builder()
    Creates a new builder for creating a FunctionParameter definition.
    @NotNull String
    getDescription()
    A description of the parameter, used by the model to choose how to call the function.
    @NotNull String
    getName()
    The name of the function parameter.
    @NotNull String
    getType()
    The type of the parameter value (e.g.
    boolean
    isRequired()
    Returns whether the parameter is required or optional.

  • Method Details

    • builder

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

    • getName

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

    • getType

      @NotNull @NotNull String getType()
      The type of the parameter value (e.g. `string`, `boolean`, `integer`).
      Returns:
      The parameter value type.
      Since:
      5.2.250908

    • getDescription

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

    • isRequired

      boolean isRequired()
      Returns whether the parameter is required or optional.
      Returns:
      true if required, false if optional.
      Since:
      5.2.250908