Package de.espirit.firstspirit.ai.dto

Interface ResponseFormatJsonSchema

All Superinterfaces:

ResponseFormat

@Experimental
public interface ResponseFormatJsonSchema
extends ResponseFormat

Definition of a structured output format for a Request.

Since:

5.2.251303

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ResponseFormatJsonSchema.Builder	Creates a new builder for creating a ResponseFormatJsonSchema definition.

Method Summary

Modifier and Type	Method	Description
static @NotNull ResponseFormatJsonSchema.Builder	builder()	Creates a new builder for creating a ResponseFormatJsonSchema definition.
@NotNull JsonSchema	getSchema()	Returns a JSON schema descriptor for a structured output.
@NotNull StrictMode	getStrictMode()	Returns the strict mode to be used when using structured output using a pre-defined JSON schema.

Method Details

builder

@NotNull
static @NotNull ResponseFormatJsonSchema.Builder builder()

Creates a new builder for creating a ResponseFormatJsonSchema definition.

Returns:

The new builder instance.

Since:

5.2.251303

getSchema

@NotNull
@NotNull JsonSchema getSchema()

Returns a JSON schema descriptor for a structured output.

Returns:

The JSON schema descriptor, if available.

Since:

5.2.251303

getStrictMode

@NotNull
@NotNull StrictMode getStrictMode()

Returns the strict mode to be used when using structured output using a pre-defined JSON schema.

Returns:

The strict mode to be used for structured outputs.

Since:

5.2.251303