Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions

All Superinterfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

All Known Implementing Classes:

AnthropicChatOptions, AzureOpenAiChatOptions, DefaultToolCallingChatOptions, MistralAiChatOptions, OllamaOptions, OpenAiChatOptions, VertexAiGeminiChatOptions

public interface ToolCallingChatOptions
extends FunctionCallingOptions

A set of options that can be used to configure the interaction with a chat model, including tool calling.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ToolCallingChatOptions.Builder	A builder to create a ToolCallingChatOptions instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_TOOL_EXECUTION_ENABLED

Method Summary

Modifier and Type	Method	Description
static ToolCallingChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
List<FunctionCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
Boolean	isInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
static boolean	isInternalToolExecutionEnabled(ChatOptions chatOptions)
static List<FunctionCallback>	mergeToolCallbacks(List<FunctionCallback> runtimeToolCallbacks, List<FunctionCallback> defaultToolCallbacks)
static Map<String,Object>	mergeToolContext(Map<String,Object> runtimeToolContext, Map<String,Object> defaultToolContext)
static Set<String>	mergeToolNames(Set<String> runtimeToolNames, Set<String> defaultToolNames)
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	setToolCallbacks(List<FunctionCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
static void	validateToolCallbacks(List<FunctionCallback> toolCallbacks)

Methods inherited from interface org.springframework.ai.chat.prompt.ChatOptions

copy, getFrequencyPenalty, getMaxTokens, getModel, getPresencePenalty, getStopSequences, getTemperature, getTopK, getTopP

Methods inherited from interface org.springframework.ai.model.function.FunctionCallingOptions

getFunctionCallbacks, getFunctions, getProxyToolCalls, getToolContext, setFunctionCallbacks, setFunctions, setProxyToolCalls, setToolContext

Field Details

DEFAULT_TOOL_EXECUTION_ENABLED

static final boolean DEFAULT_TOOL_EXECUTION_ENABLED

See Also:

• Constant Field Values

Method Details

getToolCallbacks

List<FunctionCallback> getToolCallbacks()

ToolCallbacks to be registered with the ChatModel.

setToolCallbacks

void setToolCallbacks(List<FunctionCallback> toolCallbacks)

Set the ToolCallbacks to be registered with the ChatModel.

getToolNames

Set<String> getToolNames()

Names of the tools to register with the ChatModel.

setToolNames

void setToolNames(Set<String> toolNames)

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

isInternalToolExecutionEnabled

@Nullable
Boolean isInternalToolExecutionEnabled()

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

setInternalToolExecutionEnabled

void setInternalToolExecutionEnabled(@Nullable
 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.

builder

static ToolCallingChatOptions.Builder builder()

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

isInternalToolExecutionEnabled

static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions)

mergeToolNames

static Set<String> mergeToolNames(Set<String> runtimeToolNames,
 Set<String> defaultToolNames)

mergeToolCallbacks

static List<FunctionCallback> mergeToolCallbacks(List<FunctionCallback> runtimeToolCallbacks,
 List<FunctionCallback> defaultToolCallbacks)

mergeToolContext

static Map<String,Object> mergeToolContext(Map<String,Object> runtimeToolContext,
 Map<String,Object> defaultToolContext)

validateToolCallbacks

static void validateToolCallbacks(List<FunctionCallback> toolCallbacks)