Package org.springframework.ai.bedrock.converse

Class BedrockChatOptions

java.lang.Object

org.springframework.ai.bedrock.converse.BedrockChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class BedrockChatOptions
extends Object
implements ToolCallingChatOptions

The options to be used when sending a chat request to the Bedrock API.

Author:

Sun Yuhan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BedrockChatOptions.Builder

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
BedrockChatOptions()

Method Summary

Modifier and Type	Method	Description
static BedrockChatOptions.Builder	builder()
BedrockChatOptions	copy()	Returns a copy of this ChatOptions.
boolean	equals(Object o)
static BedrockChatOptions	fromOptions(BedrockChatOptions fromOptions)
BedrockCacheOptions	getCacheOptions()
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
Boolean	getInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Map<String,String>	getRequestParameters()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Map<String,Object>	getToolContext()	Get the configured tool context.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
int	hashCode()
void	setCacheOptions(BedrockCacheOptions cacheOptions)
void	setFrequencyPenalty(Double frequencyPenalty)
void	setInternalToolExecutionEnabled(Boolean internalToolExecutionEnabled)	Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setPresencePenalty(Double presencePenalty)
void	setRequestParameters(Map<String,String> requestParameters)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolContext(Map<String,Object> toolContext)	Set the tool context values as map.
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTopK(Integer topK)
void	setTopP(Double topP)

Methods inherited from class java.lang.Object

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

Constructor Details

BedrockChatOptions

public BedrockChatOptions()

Method Details

builder

public static BedrockChatOptions.Builder builder()

fromOptions

public static BedrockChatOptions fromOptions(BedrockChatOptions fromOptions)

getModel

public 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 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 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)

getRequestParameters

public Map<String,String> getRequestParameters()

setRequestParameters

public void setRequestParameters(Map<String,String> requestParameters)

getPresencePenalty

public 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 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 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 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 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)

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<ToolCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions

Set the names of the tools to register with the ChatModel.

Specified by:

setToolNames in interface ToolCallingChatOptions

getToolContext

public Map<String,Object> getToolContext()

Description copied from interface: ToolCallingChatOptions

Get the configured tool context.

Specified by:

getToolContext in interface ToolCallingChatOptions

Returns:

the tool context map.

setToolContext

public void setToolContext(Map<String,Object> toolContext)

Description copied from interface: ToolCallingChatOptions

Set the tool context values as map.

Specified by:

setToolContext in interface ToolCallingChatOptions

Parameters:

toolContext - as map

getInternalToolExecutionEnabled

@Nullable
public Boolean getInternalToolExecutionEnabled()

Description copied from interface: ToolCallingChatOptions

Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

getInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

Description copied from interface: ToolCallingChatOptions

Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

setInternalToolExecutionEnabled in interface ToolCallingChatOptions

getCacheOptions

public BedrockCacheOptions getCacheOptions()

setCacheOptions

public void setCacheOptions(BedrockCacheOptions cacheOptions)

copy

public BedrockChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object