Package org.springframework.ai.model.tool

Class DefaultToolCallingChatOptions.Builder

java.lang.Object

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

All Implemented Interfaces:

ChatOptions.Builder, FunctionCallingOptions.Builder, ToolCallingChatOptions.Builder

Enclosing class:

DefaultToolCallingChatOptions

public static class DefaultToolCallingChatOptions.Builder
extends Object
implements ToolCallingChatOptions.Builder

Default implementation of ToolCallingChatOptions.Builder.

Constructor Summary

Constructors

Constructor	Description
Builder()

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	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<ToolCallback> toolCallbacks)	ToolCallbacks to be registered with the ChatModel.
ToolCallingChatOptions.Builder	toolCallbacks(ToolCallback... toolCallbacks)	ToolCallbacks to be registered with the ChatModel.
ToolCallingChatOptions.Builder	toolCallReturnDirect(Boolean toolCallReturnDirect)	Whether the result of each tool call should be returned directly or passed back to the model.
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	tools(String... toolNames)	Names of the tools to register with the ChatModel.
ToolCallingChatOptions.Builder	tools(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

toolCallbacks

public ToolCallingChatOptions.Builder toolCallbacks(List<ToolCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions.Builder

ToolCallbacks to be registered with the ChatModel.

Specified by:

toolCallbacks in interface ToolCallingChatOptions.Builder

toolCallbacks

public ToolCallingChatOptions.Builder toolCallbacks(ToolCallback... toolCallbacks)

Description copied from interface: ToolCallingChatOptions.Builder

ToolCallbacks to be registered with the ChatModel.

Specified by:

toolCallbacks in interface ToolCallingChatOptions.Builder

tools

public ToolCallingChatOptions.Builder tools(Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions.Builder

Names of the tools to register with the ChatModel.

Specified by:

tools in interface ToolCallingChatOptions.Builder

tools

public ToolCallingChatOptions.Builder tools(String... toolNames)

Description copied from interface: ToolCallingChatOptions.Builder

Names of the tools to register with the ChatModel.

Specified by:

tools in interface ToolCallingChatOptions.Builder

toolContext

public 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

Specified by:

toolContext in interface ToolCallingChatOptions.Builder

Parameters:

context - the map representing the tool context.

Returns:

the FunctionCallOptions Builder.

toolContext

public 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

Specified by:

toolContext in interface ToolCallingChatOptions.Builder

Parameters:

key - the key to use.

value - the corresponding value.

Returns:

the FunctionCallOptions Builder.

toolCallReturnDirect

public ToolCallingChatOptions.Builder toolCallReturnDirect(@Nullable
 Boolean toolCallReturnDirect)

Description copied from interface: ToolCallingChatOptions.Builder

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:

toolCallReturnDirect in interface ToolCallingChatOptions.Builder

functionCallbacks

@Deprecated
public 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

Specified by:

functionCallbacks in interface ToolCallingChatOptions.Builder

Parameters:

functionCallbacks - the list of Function Callbacks.

Returns:

the FunctionCallOptions Builder.

functionCallbacks

@Deprecated
public 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

Specified by:

functionCallbacks in interface ToolCallingChatOptions.Builder

Parameters:

functionCallbacks - the function callbacks.

Returns:

the FunctionCallOptions Builder.

functions

@Deprecated
public 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

Specified by:

functions in interface ToolCallingChatOptions.Builder

Parameters:

functions - the Set of function names

Returns:

the FunctionCallOptions Builder.

function

@Deprecated
public 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

Specified by:

function in interface ToolCallingChatOptions.Builder

Parameters:

function - the name of the function.

Returns:

the FunctionCallOptions Builder.

proxyToolCalls

@Deprecated
public 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

Specified by:

proxyToolCalls in interface ToolCallingChatOptions.Builder

Parameters:

proxyToolCalls - boolean value to enable proxy ToolCalls.

Returns:

the FunctionCallOptions Builder.

model

public 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

Specified by:

model in interface ToolCallingChatOptions.Builder

Returns:

the builder

frequencyPenalty

public 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

Specified by:

frequencyPenalty in interface ToolCallingChatOptions.Builder

Returns:

the builder.

maxTokens

public 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

Specified by:

maxTokens in interface ToolCallingChatOptions.Builder

Returns:

the builder.

presencePenalty

public 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

Specified by:

presencePenalty in interface ToolCallingChatOptions.Builder

Returns:

the builder.

stopSequences

public 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

Specified by:

stopSequences in interface ToolCallingChatOptions.Builder

Returns:

the builder.

temperature

public 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

Specified by:

temperature in interface ToolCallingChatOptions.Builder

Returns:

the builder.

topK

public 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

Specified by:

topK in interface ToolCallingChatOptions.Builder

Returns:

the builder.

topP

public 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

Specified by:

topP in interface ToolCallingChatOptions.Builder

Returns:

the builder.

build

public 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

Specified by:

build in interface ToolCallingChatOptions.Builder

Returns:

the FunctionCalling options.