Package org.springframework.ai.model.tool

Class DefaultToolCallingChatOptions

java.lang.Object

org.springframework.ai.model.tool.DefaultToolCallingChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions, ToolCallingChatOptions

public class DefaultToolCallingChatOptions
extends Object
implements ToolCallingChatOptions

Default implementation of ToolCallingChatOptions.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultToolCallingChatOptions.Builder	Default implementation of ToolCallingChatOptions.Builder.

Constructor Summary

Constructors

Constructor	Description
DefaultToolCallingChatOptions()

Method Summary

Modifier and Type	Method	Description
static DefaultToolCallingChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
<T extends ChatOptions> T	copy()	Returns a copy of this ChatOptions.
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
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.
Boolean	getProxyToolCalls()
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.
Boolean	getToolCallReturnDirect()	Whether the result of each tool call should be returned directly or passed back to the model.
Map<String,Object>	getToolContext()
Set<String>	getTools()	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.
ToolCallingChatOptions	merge(ChatOptions options)	Merge the given ChatOptions into this instance.
void	setFrequencyPenalty(Double frequencyPenalty)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatModel.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setPresencePenalty(Double presencePenalty)
void	setProxyToolCalls(Boolean proxyToolCalls)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolCallbacks(ToolCallback... toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolCallReturnDirect(Boolean toolCallReturnDirect)	Set whether the result of each tool call should be returned directly or passed back to the model.
void	setToolContext(Map<String,Object> toolContext)
void	setTools(String... tools)	Set the names of the tools to register with the ChatModel.
void	setTools(Set<String> tools)	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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultToolCallingChatOptions

public DefaultToolCallingChatOptions()

Method Details

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

setToolCallbacks

public void setToolCallbacks(ToolCallback... toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getTools

public Set<String> getTools()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getTools in interface ToolCallingChatOptions

setTools

public void setTools(Set<String> tools)

Description copied from interface: ToolCallingChatOptions

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

Specified by:

setTools in interface ToolCallingChatOptions

setTools

public void setTools(String... tools)

Description copied from interface: ToolCallingChatOptions

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

Specified by:

setTools in interface ToolCallingChatOptions

getToolContext

public Map<String,Object> getToolContext()

Specified by:

getToolContext in interface FunctionCallingOptions

setToolContext

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

Specified by:

setToolContext in interface FunctionCallingOptions

getToolCallReturnDirect

@Nullable
public Boolean getToolCallReturnDirect()

Description copied from interface: ToolCallingChatOptions

Whether the result of each tool call should be returned directly or passed back to the model. It can be overridden for each ToolCallback instance via ToolMetadata.returnDirect().

Specified by:

getToolCallReturnDirect in interface ToolCallingChatOptions

setToolCallReturnDirect

public void setToolCallReturnDirect(@Nullable
 Boolean toolCallReturnDirect)

Description copied from interface: ToolCallingChatOptions

Set whether the result of each tool call should be returned directly or passed back to the model. It can be overridden for each ToolCallback instance via ToolMetadata.returnDirect().

Specified by:

setToolCallReturnDirect in interface ToolCallingChatOptions

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatModel.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

functionCallbacks - the Function Callbacks to be registered with the ChatModel.

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

Set of function names from the ChatModel registry to be used in the next chat completion requests.

setFunctions

public void setFunctions(Set<String> functions)

Description copied from interface: FunctionCallingOptions

Set the list of function names from the ChatModel registry to be used in the next chat completion requests.

Specified by:

setFunctions in interface FunctionCallingOptions

Parameters:

functions - the list of function names from the ChatModel registry to be used in the next chat completion requests.

getProxyToolCalls

@Nullable
public Boolean getProxyToolCalls()

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

public void setProxyToolCalls(@Nullable
 Boolean proxyToolCalls)

Specified by:

setProxyToolCalls in interface FunctionCallingOptions

getModel

@Nullable
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(@Nullable
 String model)

getFrequencyPenalty

@Nullable
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(@Nullable
 Double frequencyPenalty)

getMaxTokens

@Nullable
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(@Nullable
 Integer maxTokens)

getPresencePenalty

@Nullable
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(@Nullable
 Double presencePenalty)

getStopSequences

@Nullable
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(@Nullable
 List<String> stopSequences)

getTemperature

@Nullable
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(@Nullable
 Double temperature)

getTopK

@Nullable
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(@Nullable
 Integer topK)

getTopP

@Nullable
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(@Nullable
 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

merge

public ToolCallingChatOptions merge(ChatOptions options)

Merge the given ChatOptions into this instance.

builder

public static DefaultToolCallingChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.