Package de.espirit.firstspirit.ai.dto

Interface ResponseFormatJsonSchema.Builder

Enclosing interface:
ResponseFormatJsonSchema
public static interface ResponseFormatJsonSchema.Builder
Creates a new builder for creating a ResponseFormatJsonSchema definition.
Since:
5.2.251303

  • Method Details

    • schema

      @Contract("_ -> this") @NotNull @NotNull ResponseFormatJsonSchema.Builder schema(@NotNull @NotNull JsonSchema schema)
      Configures the JSON schema descriptor for the structured output.
      Parameters:
      schema - The schema descriptor.
      Returns:
      This builder instance.
      Since:
      5.2.251303

    • strictMode

      @Contract("_ -> this") @NotNull @NotNull ResponseFormatJsonSchema.Builder strictMode(@NotNull @NotNull StrictMode strictMode)
      Configures the strict mode when using structured output using a pre-defined JSON schema.
      Parameters:
      strictMode - The strict mode to be used for structured outputs.
      Since:
      5.2.251303

    • create

      @NotNull @NotNull ResponseFormatJsonSchema create()
      Builds the ResponseFormatJsonSchema instance.
      Returns:
      The created instance.
      Since:
      5.2.251303