Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions

All Superinterfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

All Known Implementing Classes:

DefaultToolCallingChatOptions

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.

Method Summary

Modifier and Type	Method	Description
static ToolCallingChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
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.
Set<String>	getTools()	Names of the tools to register with the ChatModel.
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	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.

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

Method Details

getToolCallbacks

List<ToolCallback> getToolCallbacks()

ToolCallbacks to be registered with the ChatModel.

setToolCallbacks

void setToolCallbacks(List<ToolCallback> toolCallbacks)

Set the ToolCallbacks to be registered with the ChatModel.

setToolCallbacks

void setToolCallbacks(ToolCallback... toolCallbacks)

Set the ToolCallbacks to be registered with the ChatModel.

getTools

Set<String> getTools()

Names of the tools to register with the ChatModel.

setTools

void setTools(Set<String> tools)

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

setTools

void setTools(String... tools)

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

getToolCallReturnDirect

@Nullable
Boolean getToolCallReturnDirect()

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().

setToolCallReturnDirect

void setToolCallReturnDirect(@Nullable
 Boolean toolCallReturnDirect)

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().

builder

static ToolCallingChatOptions.Builder builder()

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.