Package org.springframework.ai.model.tool

Class DefaultStructuredOutputChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultStructuredOutputChatOptions.Builder<B>

All Implemented Interfaces:

Cloneable, ChatOptions.Builder<B>, StructuredOutputChatOptions.Builder<B>

Enclosing class:

DefaultStructuredOutputChatOptions

public static class DefaultStructuredOutputChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>
extends DefaultChatOptionsBuilder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	outputSchema

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StructuredOutputChatOptions	build()	Build the ChatOptions.
B	clone()
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	outputSchema(@Nullable String outputSchema)

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

frequencyPenalty, maxTokens, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Field Details

outputSchema

protected @Nullable String outputSchema

Constructor Details

Builder

public Builder()

Method Details

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

clone

public B clone()

Specified by:

clone in interface ChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

Overrides:

clone in class DefaultChatOptionsBuilder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

build

public StructuredOutputChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

Overrides:

build in class DefaultChatOptionsBuilder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

Returns:

the Chat options.

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends DefaultStructuredOutputChatOptions.Builder<B>>

Overrides:

combineWith in class DefaultChatOptionsBuilder<B extends DefaultStructuredOutputChatOptions.Builder<B>>