Package org.springframework.ai.model.tool

Class DefaultStructuredOutputChatOptions

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptions

org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, StructuredOutputChatOptions

public class DefaultStructuredOutputChatOptions
extends DefaultChatOptions
implements StructuredOutputChatOptions

Default implementation of StructuredOutputChatOptions. Mainly to be used in model generic tests, as concrete chat implementations typically use dedicated sub implementations specific to the model.

Author:

Eric Bottard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultStructuredOutputChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultStructuredOutputChatOptions(@Nullable String model, @Nullable Double frequencyPenalty, @Nullable Integer maxTokens, @Nullable Double presencePenalty, @Nullable List<String> stopSequences, @Nullable Double temperature, @Nullable Integer topK, @Nullable Double topP, @Nullable String outputSchema)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getOutputSchema()
StructuredOutputChatOptions.Builder<?>	mutate()	Returns a new ChatOptions.Builder initialized with the values of this ChatOptions.

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptions

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Details

DefaultStructuredOutputChatOptions

protected DefaultStructuredOutputChatOptions(@Nullable String model,
 @Nullable Double frequencyPenalty,
 @Nullable Integer maxTokens,
 @Nullable Double presencePenalty,
 @Nullable List<String> stopSequences,
 @Nullable Double temperature,
 @Nullable Integer topK,
 @Nullable Double topP,
 @Nullable String outputSchema)

Method Details

getOutputSchema

public @Nullable String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

mutate

public StructuredOutputChatOptions.Builder<?> mutate()

Description copied from interface: ChatOptions

Returns a new ChatOptions.Builder initialized with the values of this ChatOptions. Concrete ChatOptions classes must override this to return the most concrete builder implementation.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface StructuredOutputChatOptions

Overrides:

mutate in class DefaultChatOptions