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
    getName()
    The name of the function parameter.
    @NotNull JsonSchema
    getSchema()
    JSON Schema descriptor for the type of object this parameter contains.
    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

    • getSchema

      @NotNull @NotNull JsonSchema getSchema()
      JSON Schema descriptor for the type of object this parameter contains.
      Returns:
      The JSON schema descriptor.
      Since:
      5.2.251104

    • isRequired

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