Package org.springframework.ai.chat.prompt

Class DefaultChatOptionsBuilder<B extends DefaultChatOptionsBuilder<B>>

java.lang.Object

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

All Implemented Interfaces:

ChatOptions.Builder<B>

Direct Known Subclasses:

DefaultToolCallingChatOptions.Builder

public class DefaultChatOptionsBuilder<B extends DefaultChatOptionsBuilder<B>>
extends Object
implements ChatOptions.Builder<B>

Implementation of ChatOptions.Builder to create DefaultChatOptions.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Double	frequencyPenalty
protected @Nullable Integer	maxTokens
protected @Nullable String	model
protected @Nullable Double	presencePenalty
protected @Nullable List<String>	stopSequences
protected @Nullable Double	temperature
protected @Nullable Integer	topK
protected @Nullable Double	topP

Constructor Summary

Constructors

Constructor	Description
DefaultChatOptionsBuilder()

Method Summary

Modifier and Type	Method	Description
ChatOptions	build()	Build the ChatOptions.
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	frequencyPenalty(@Nullable Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
B	maxTokens(@Nullable Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
B	model(@Nullable String model)	Builds with the model to use for the chat.
B	presencePenalty(@Nullable Double presencePenalty)	Builds with the presence penalty to use for the chat.
protected B	self()
B	stopSequences(@Nullable List<String> stop)	Builds with the stop sequences to use for the chat.
B	temperature(@Nullable Double temperature)	Builds with the temperature to use for the chat.
B	topK(@Nullable Integer topK)	Builds with the top K to use for the chat.
B	topP(@Nullable Double topP)	Builds with the top P to use for the chat.

Methods inherited from class java.lang.Object

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

Field Details

model

protected @Nullable String model

frequencyPenalty

protected @Nullable Double frequencyPenalty

maxTokens

protected @Nullable Integer maxTokens

presencePenalty

protected @Nullable Double presencePenalty

stopSequences

protected @Nullable List<String> stopSequences

temperature

protected @Nullable Double temperature

topK

protected @Nullable Integer topK

topP

protected @Nullable Double topP

Constructor Details

DefaultChatOptionsBuilder

public DefaultChatOptionsBuilder()

Method Details

self

protected B self()

model

public B model(@Nullable String model)

Description copied from interface: ChatOptions.Builder

Builds with the model to use for the chat.

Specified by:

model in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

model -

Returns:

the builder

frequencyPenalty

public B frequencyPenalty(@Nullable Double frequencyPenalty)

Description copied from interface: ChatOptions.Builder

Builds with the frequency penalty to use for the chat.

Specified by:

frequencyPenalty in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

frequencyPenalty -

Returns:

the builder.

maxTokens

public B maxTokens(@Nullable Integer maxTokens)

Description copied from interface: ChatOptions.Builder

Builds with the maximum number of tokens to use for the chat.

Specified by:

maxTokens in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

maxTokens -

Returns:

the builder.

presencePenalty

public B presencePenalty(@Nullable Double presencePenalty)

Description copied from interface: ChatOptions.Builder

Builds with the presence penalty to use for the chat.

Specified by:

presencePenalty in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

presencePenalty -

Returns:

the builder.

stopSequences

public B stopSequences(@Nullable List<String> stop)

Description copied from interface: ChatOptions.Builder

Builds with the stop sequences to use for the chat.

Specified by:

stopSequences in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

stop -

Returns:

the builder.

temperature

public B temperature(@Nullable Double temperature)

Description copied from interface: ChatOptions.Builder

Builds with the temperature to use for the chat.

Specified by:

temperature in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

temperature -

Returns:

the builder.

topK

public B topK(@Nullable Integer topK)

Description copied from interface: ChatOptions.Builder

Builds with the top K to use for the chat.

Specified by:

topK in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

topK -

Returns:

the builder.

topP

public B topP(@Nullable Double topP)

Description copied from interface: ChatOptions.Builder

Builds with the top P to use for the chat.

Specified by:

topP in interface ChatOptions.Builder<B extends DefaultChatOptionsBuilder<B>>

Parameters:

topP -

Returns:

the builder.

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 DefaultChatOptionsBuilder<B>>

build

public ChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

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

Returns:

the Chat options.