Package org.springframework.ai.model.tool

Interface StructuredOutputChatOptions

All Superinterfaces:

ChatOptions, ModelOptions

All Known Implementing Classes:

AnthropicChatOptions, GoogleGenAiChatOptions, OpenAiChatOptions, OpenAiSdkChatOptions, VertexAiGeminiChatOptions

public interface StructuredOutputChatOptions
extends ChatOptions

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

Author:

Christian Tzolov

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.ai.chat.prompt.ChatOptions

ChatOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	getOutputSchema()
void	setOutputSchema(String outputSchema)

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

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

Method Details

getOutputSchema

String getOutputSchema()

setOutputSchema

void setOutputSchema(String outputSchema)