Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions.Builder

All Superinterfaces:

ChatOptions.Builder, FunctionCallingOptions.Builder

All Known Implementing Classes:

DefaultToolCallingChatOptions.Builder

Enclosing interface:

ToolCallingChatOptions

public static interface ToolCallingChatOptions.Builder
extends FunctionCallingOptions.Builder

A builder to create a ToolCallingChatOptions instance.

Method Summary

Modifier and Type	Method	Description
ToolCallingChatOptions	build()	Builds the FunctionCallingOptions.
ToolCallingChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
ToolCallingChatOptions.Builder	function(String function)	Deprecated.
ToolCallingChatOptions.Builder	functionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated.
ToolCallingChatOptions.Builder	functionCallbacks(FunctionCallback... functionCallbacks)	Deprecated.
ToolCallingChatOptions.Builder	functions(Set<String> functions)	Deprecated.
ToolCallingChatOptions.Builder	internalToolExecutionEnabled(Boolean internalToolExecutionEnabled)	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
ToolCallingChatOptions.Builder	maxTokens(Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
ToolCallingChatOptions.Builder	model(String model)	Builds with the model to use for the chat.
ToolCallingChatOptions.Builder	presencePenalty(Double presencePenalty)	Builds with the presence penalty to use for the chat.
ToolCallingChatOptions.Builder	proxyToolCalls(Boolean proxyToolCalls)	Deprecated.
ToolCallingChatOptions.Builder	stopSequences(List<String> stopSequences)	Builds with the stop sequences to use for the chat.
ToolCallingChatOptions.Builder	temperature(Double temperature)	Builds with the temperature to use for the chat.
ToolCallingChatOptions.Builder	toolCallbacks(List<FunctionCallback> functionCallbacks)	ToolCallbacks to be registered with the ChatModel.
ToolCallingChatOptions.Builder	toolCallbacks(FunctionCallback... functionCallbacks)	ToolCallbacks to be registered with the ChatModel.
ToolCallingChatOptions.Builder	toolContext(String key, Object value)	Add a specific key/value pair to the tool context.
ToolCallingChatOptions.Builder	toolContext(Map<String,Object> context)	Add a Map of context values into tool context.
ToolCallingChatOptions.Builder	toolNames(String... toolNames)	Names of the tools to register with the ChatModel.
ToolCallingChatOptions.Builder	toolNames(Set<String> toolNames)	Names of the tools to register with the ChatModel.
ToolCallingChatOptions.Builder	topK(Integer topK)	Builds with the top K to use for the chat.
ToolCallingChatOptions.Builder	topP(Double topP)	Builds with the top P to use for the chat.

Method Details

toolCallbacks

ToolCallingChatOptions.Builder toolCallbacks(List<FunctionCallback> functionCallbacks)

ToolCallbacks to be registered with the ChatModel.

toolCallbacks

ToolCallingChatOptions.Builder toolCallbacks(FunctionCallback... functionCallbacks)

ToolCallbacks to be registered with the ChatModel.

toolNames

ToolCallingChatOptions.Builder toolNames(Set<String> toolNames)

Names of the tools to register with the ChatModel.

toolNames

ToolCallingChatOptions.Builder toolNames(String... toolNames)

Names of the tools to register with the ChatModel.

internalToolExecutionEnabled

ToolCallingChatOptions.Builder internalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

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

toolContext

ToolCallingChatOptions.Builder toolContext(Map<String,Object> context)

Description copied from interface: FunctionCallingOptions.Builder

Add a Map of context values into tool context.

Specified by:

toolContext in interface FunctionCallingOptions.Builder

Parameters:

context - the map representing the tool context.

Returns:

the FunctionCallOptions Builder.

toolContext

ToolCallingChatOptions.Builder toolContext(String key,
 Object value)

Description copied from interface: FunctionCallingOptions.Builder

Add a specific key/value pair to the tool context.

Specified by:

toolContext in interface FunctionCallingOptions.Builder

Parameters:

key - the key to use.

value - the corresponding value.

Returns:

the FunctionCallOptions Builder.

functionCallbacks

@Deprecated
ToolCallingChatOptions.Builder functionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated.

Description copied from interface: FunctionCallingOptions.Builder

The list of Function Callbacks to be registered with the Chat model.

Specified by:

functionCallbacks in interface FunctionCallingOptions.Builder

Parameters:

functionCallbacks - the list of Function Callbacks.

Returns:

the FunctionCallOptions Builder.

functionCallbacks

@Deprecated
ToolCallingChatOptions.Builder functionCallbacks(FunctionCallback... functionCallbacks)

Deprecated.

Description copied from interface: FunctionCallingOptions.Builder

The Function Callbacks to be registered with the Chat model.

Specified by:

functionCallbacks in interface FunctionCallingOptions.Builder

Parameters:

functionCallbacks - the function callbacks.

Returns:

the FunctionCallOptions Builder.

functions

@Deprecated
ToolCallingChatOptions.Builder functions(Set<String> functions)

Deprecated.

Description copied from interface: FunctionCallingOptions.Builder

Set of function names to be registered with the Chat model.

Specified by:

functions in interface FunctionCallingOptions.Builder

Parameters:

functions - the Set of function names

Returns:

the FunctionCallOptions Builder.

function

@Deprecated
ToolCallingChatOptions.Builder function(String function)

Deprecated.

Description copied from interface: FunctionCallingOptions.Builder

The function name to be registered with the chat model.

Specified by:

function in interface FunctionCallingOptions.Builder

Parameters:

function - the name of the function.

Returns:

the FunctionCallOptions Builder.

proxyToolCalls

@Deprecated
ToolCallingChatOptions.Builder proxyToolCalls(@Nullable
 Boolean proxyToolCalls)

Deprecated.

Description copied from interface: FunctionCallingOptions.Builder

Boolean flag to indicate if the proxy ToolCalls is enabled.

Specified by:

proxyToolCalls in interface FunctionCallingOptions.Builder

Parameters:

proxyToolCalls - boolean value to enable proxy ToolCalls.

Returns:

the FunctionCallOptions Builder.

model

ToolCallingChatOptions.Builder model(@Nullable
 String model)

Description copied from interface: ChatOptions.Builder

Builds with the model to use for the chat.

Specified by:

model in interface ChatOptions.Builder

Specified by:

model in interface FunctionCallingOptions.Builder

Returns:

the builder

frequencyPenalty

ToolCallingChatOptions.Builder frequencyPenalty(@Nullable
 Double frequencyPenalty)

Description copied from interface: ChatOptions.Builder

Builds with the frequency penalty to use for the chat.

Specified by:

frequencyPenalty in interface ChatOptions.Builder

Specified by:

frequencyPenalty in interface FunctionCallingOptions.Builder

Returns:

the builder.

maxTokens

ToolCallingChatOptions.Builder maxTokens(@Nullable
 Integer maxTokens)

Description copied from interface: ChatOptions.Builder

Builds with the maximum number of tokens to use for the chat.

Specified by:

maxTokens in interface ChatOptions.Builder

Specified by:

maxTokens in interface FunctionCallingOptions.Builder

Returns:

the builder.

presencePenalty

ToolCallingChatOptions.Builder presencePenalty(@Nullable
 Double presencePenalty)

Description copied from interface: ChatOptions.Builder

Builds with the presence penalty to use for the chat.

Specified by:

presencePenalty in interface ChatOptions.Builder

Specified by:

presencePenalty in interface FunctionCallingOptions.Builder

Returns:

the builder.

stopSequences

ToolCallingChatOptions.Builder stopSequences(@Nullable
 List<String> stopSequences)

Description copied from interface: ChatOptions.Builder

Builds with the stop sequences to use for the chat.

Specified by:

stopSequences in interface ChatOptions.Builder

Specified by:

stopSequences in interface FunctionCallingOptions.Builder

Returns:

the builder.

temperature

ToolCallingChatOptions.Builder temperature(@Nullable
 Double temperature)

Description copied from interface: ChatOptions.Builder

Builds with the temperature to use for the chat.

Specified by:

temperature in interface ChatOptions.Builder

Specified by:

temperature in interface FunctionCallingOptions.Builder

Returns:

the builder.

topK

ToolCallingChatOptions.Builder topK(@Nullable
 Integer topK)

Description copied from interface: ChatOptions.Builder

Builds with the top K to use for the chat.

Specified by:

topK in interface ChatOptions.Builder

Specified by:

topK in interface FunctionCallingOptions.Builder

Returns:

the builder.

topP

ToolCallingChatOptions.Builder topP(@Nullable
 Double topP)

Description copied from interface: ChatOptions.Builder

Builds with the top P to use for the chat.

Specified by:

topP in interface ChatOptions.Builder

Specified by:

topP in interface FunctionCallingOptions.Builder

Returns:

the builder.

build

ToolCallingChatOptions build()

Description copied from interface: FunctionCallingOptions.Builder

Builds the FunctionCallingOptions.

Specified by:

build in interface ChatOptions.Builder

Specified by:

build in interface FunctionCallingOptions.Builder

Returns:

the FunctionCalling options.