Package org.springframework.ai.model.tool

Interface StructuredOutputChatOptions

All Superinterfaces:

ChatOptions, ModelOptions

All Known Implementing Classes:

DefaultStructuredOutputChatOptions

public interface StructuredOutputChatOptions
extends ChatOptions

Mixin interface for ChatModels that support structured output. Provides a unified way to set and get the output JSON schema.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StructuredOutputChatOptions.Builder<B extends StructuredOutputChatOptions.Builder<B>>

Method Summary

Modifier and Type	Method	Description
static StructuredOutputChatOptions.Builder<?>	builder()	A builder to create a new StructuredOutputChatOptions instance.
@Nullable String	getOutputSchema()
StructuredOutputChatOptions.Builder<?>	mutate()	Returns a new StructuredOutputChatOptions.Builder initialized with the values of this StructuredOutputChatOptions.

Methods inherited from interface org.springframework.ai.chat.prompt.ChatOptions

getFrequencyPenalty, getMaxTokens, getModel, getPresencePenalty, getStopSequences, getTemperature, getTopK, getTopP

Method Details

getOutputSchema

@Nullable String getOutputSchema()

mutate

StructuredOutputChatOptions.Builder<?> mutate()

Returns a new StructuredOutputChatOptions.Builder initialized with the values of this StructuredOutputChatOptions. Narrows the return type of ChatOptions.mutate() so generic structured output code can chain structuredOptions.mutate().outputSchema(schema).build() without casting.

Specified by:

mutate in interface ChatOptions

builder

static StructuredOutputChatOptions.Builder<?> builder()

A builder to create a new StructuredOutputChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.