Package org.springframework.ai.model.tool

Class DefaultToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder<B>

All Implemented Interfaces:

ChatOptions.Builder<B>, ToolCallingChatOptions.Builder<B>

Direct Known Subclasses:

AnthropicChatOptions.AbstractBuilder, AzureOpenAiChatOptions.AbstractBuilder, BedrockChatOptions.AbstractBuilder, DeepSeekChatOptions.AbstractBuilder, GoogleGenAiChatOptions.AbstractBuilder, MiniMaxChatOptions.AbstractBuilder, MistralAiChatOptions.AbstractBuilder, OllamaChatOptions.AbstractBuilder, OpenAiSdkChatOptions.AbstractBuilder, ZhiPuAiChatOptions.AbstractBuilder

Enclosing class:

DefaultToolCallingChatOptions

public static class DefaultToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>
extends DefaultChatOptionsBuilder<B>
implements ToolCallingChatOptions.Builder<B>

Default implementation of ToolCallingChatOptions.Builder.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Boolean	internalToolExecutionEnabled
protected @Nullable List<ToolCallback>	toolCallbacks
protected @Nullable Map<String,Object>	toolContext
protected @Nullable Set<String>	toolNames

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolCallingChatOptions	build()	Build the ChatOptions.
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	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.
B	toolCallbacks(@Nullable List<ToolCallback> toolCallbacks)	ToolCallbacks to be registered with the ChatModel.
B	toolCallbacks(ToolCallback... toolCallbacks)	ToolCallbacks to be registered with the ChatModel.
B	toolContext(String key, Object value)	Add a specific key/value pair to the tool context.
B	toolContext(@Nullable Map<String,Object> context)	Add a Map of context values into tool context.
B	toolNames(String... toolNames)	Names of the tools to register with the ChatModel.
B	toolNames(@Nullable Set<String> toolNames)	Names of the tools to register with the ChatModel.

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Field Details

toolCallbacks

protected @Nullable List<ToolCallback> toolCallbacks

toolNames

protected @Nullable Set<String> toolNames

toolContext

protected @Nullable Map<String,Object> toolContext

internalToolExecutionEnabled

protected @Nullable Boolean internalToolExecutionEnabled

Constructor Details

Builder

public Builder()

Method Details

toolCallbacks

public B toolCallbacks(@Nullable List<ToolCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions.Builder

ToolCallbacks to be registered with the ChatModel.

Specified by:

toolCallbacks in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

toolCallbacks

public B toolCallbacks(ToolCallback... toolCallbacks)

Description copied from interface: ToolCallingChatOptions.Builder

ToolCallbacks to be registered with the ChatModel.

Specified by:

toolCallbacks in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

toolNames

public B toolNames(@Nullable Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions.Builder

Names of the tools to register with the ChatModel.

Specified by:

toolNames in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

toolNames

public B toolNames(String... toolNames)

Description copied from interface: ToolCallingChatOptions.Builder

Names of the tools to register with the ChatModel.

Specified by:

toolNames in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

toolContext

public B toolContext(@Nullable Map<String,Object> context)

Description copied from interface: ToolCallingChatOptions.Builder

Add a Map of context values into tool context.

Specified by:

toolContext in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

Parameters:

context - the map representing the tool context.

Returns:

the ToolCallingChatOptions Builder.

toolContext

public B toolContext(String key,
 Object value)

Description copied from interface: ToolCallingChatOptions.Builder

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

Specified by:

toolContext in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

Parameters:

key - the key to use.

value - the corresponding value.

Returns:

the ToolCallingChatOptions Builder.

internalToolExecutionEnabled

public B internalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled)

Description copied from interface: ToolCallingChatOptions.Builder

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

Specified by:

internalToolExecutionEnabled in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

build

public ToolCallingChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

Specified by:

build in interface ToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

Overrides:

build in class DefaultChatOptionsBuilder<B extends DefaultToolCallingChatOptions.Builder<B>>

Returns:

the Chat options.

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>

Overrides:

combineWith in class DefaultChatOptionsBuilder<B extends DefaultToolCallingChatOptions.Builder<B>>