Package org.springframework.ai.chat.prompt

Class DefaultChatOptions

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions

public class DefaultChatOptions
extends Object
implements ChatOptions

Default implementation for the ChatOptions.

Nested Class Summary

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

ChatOptions.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultChatOptions()

Method Summary

Modifier and Type	Method	Description
<T extends ChatOptions> T	copy()	Returns a copy of this ChatOptions.
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
@Nullable String	getModel()	Returns the model to use for the chat.
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
@Nullable Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
@Nullable Double	getTopP()	Returns the top P to use for the chat.
void	setFrequencyPenalty(Double frequencyPenalty)
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setPresencePenalty(Double presencePenalty)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setTopK(Integer topK)
void	setTopP(Double topP)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultChatOptions

public DefaultChatOptions()

Method Details

getModel

public @Nullable String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

setModel

public void setModel(String model)

getFrequencyPenalty

public @Nullable Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

getMaxTokens

public @Nullable Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getPresencePenalty

public @Nullable Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getStopSequences

public @Nullable List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

setStopSequences

public void setStopSequences(List<String> stopSequences)

getTemperature

public @Nullable Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

setTemperature

public void setTemperature(Double temperature)

getTopK

public @Nullable Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

setTopK

public void setTopK(Integer topK)

getTopP

public @Nullable Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

setTopP

public void setTopP(Double topP)

copy

public <T extends ChatOptions> T copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions