Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions

All Superinterfaces:

ChatOptions, ModelOptions

All Known Implementing Classes:

AnthropicChatOptions, BedrockChatOptions, DeepSeekChatOptions, DefaultToolCallingChatOptions, GoogleGenAiChatOptions, MistralAiChatOptions, OllamaChatOptions, OpenAiChatOptions

public interface ToolCallingChatOptions
extends ChatOptions

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, Ilayaperumal Gopinathan, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ToolCallingChatOptions.Builder<B extends ToolCallingChatOptions.Builder<B>>	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.
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
static @Nullable List<ToolCallback>	mergeToolCallbacks(@Nullable List<ToolCallback> runtimeToolCallbacks, @Nullable List<ToolCallback> defaultToolCallbacks)
static @Nullable Map<String,Object>	mergeToolContext(@Nullable Map<String,Object> runtimeToolContext, @Nullable Map<String,Object> defaultToolContext)
ToolCallingChatOptions.Builder<?>	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.
static void	validateToolCallbacks(@Nullable List<ToolCallback> toolCallbacks)

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

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

Method Details

getToolCallbacks

@Nullable List<ToolCallback> getToolCallbacks()

ToolCallbacks to be registered with the ChatModel.

getToolContext

@Nullable Map<String,Object> getToolContext()

Get the configured tool context.

Returns:

the tool context map.

mutate

ToolCallingChatOptions.Builder<?> mutate()

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions. Narrows the return type of ChatOptions.mutate() so generic tool calling code can chain methods without casting.

Specified by:

mutate in interface ChatOptions

builder

static ToolCallingChatOptions.Builder<?> builder()

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.

mergeToolCallbacks

static @Nullable List<ToolCallback> mergeToolCallbacks(@Nullable List<ToolCallback> runtimeToolCallbacks,
 @Nullable List<ToolCallback> defaultToolCallbacks)

mergeToolContext

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

validateToolCallbacks

static void validateToolCallbacks(@Nullable List<ToolCallback> toolCallbacks)