Package org.springframework.ai.chat.prompt

Class DefaultChatOptionsBuilder

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

All Implemented Interfaces:

ChatOptions.Builder

public class DefaultChatOptionsBuilder
extends Object
implements ChatOptions.Builder

Implementation of ChatOptions.Builder to create DefaultChatOptions.

Field Summary

Fields

Modifier and Type	Field	Description
protected DefaultChatOptions	options

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultChatOptionsBuilder()
protected	DefaultChatOptionsBuilder(DefaultChatOptions options)

Method Summary

Modifier and Type	Method	Description
ChatOptions	build()	Build the ChatOptions.
DefaultChatOptionsBuilder	frequencyPenalty(Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
DefaultChatOptionsBuilder	maxTokens(Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
DefaultChatOptionsBuilder	model(String model)	Builds with the model to use for the chat.
DefaultChatOptionsBuilder	presencePenalty(Double presencePenalty)	Builds with the presence penalty to use for the chat.
DefaultChatOptionsBuilder	stopSequences(List<String> stop)	Builds with the stop sequences to use for the chat.
DefaultChatOptionsBuilder	temperature(Double temperature)	Builds with the temperature to use for the chat.
DefaultChatOptionsBuilder	topK(Integer topK)	Builds with the top K to use for the chat.
DefaultChatOptionsBuilder	topP(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

options

protected DefaultChatOptions options

Constructor Details

DefaultChatOptionsBuilder

public DefaultChatOptionsBuilder()

DefaultChatOptionsBuilder

protected DefaultChatOptionsBuilder(DefaultChatOptions options)

Method Details

model

public DefaultChatOptionsBuilder model(String model)

Description copied from interface: ChatOptions.Builder

Builds with the model to use for the chat.

Specified by:

model in interface ChatOptions.Builder

Returns:

the builder

frequencyPenalty

public DefaultChatOptionsBuilder frequencyPenalty(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

Returns:

the builder.

maxTokens

public DefaultChatOptionsBuilder maxTokens(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

Returns:

the builder.

presencePenalty

public DefaultChatOptionsBuilder presencePenalty(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

Returns:

the builder.

stopSequences

public DefaultChatOptionsBuilder stopSequences(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

Returns:

the builder.

temperature

public DefaultChatOptionsBuilder temperature(Double temperature)

Description copied from interface: ChatOptions.Builder

Builds with the temperature to use for the chat.

Specified by:

temperature in interface ChatOptions.Builder

Returns:

the builder.

topK

public DefaultChatOptionsBuilder topK(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

Returns:

the builder.

topP

public DefaultChatOptionsBuilder topP(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

Returns:

the builder.

build

public ChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder

Returns:

the Chat options.