Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions.Builder<B extends ToolCallingChatOptions.Builder<B>>

All Superinterfaces:

ChatOptions.Builder<B>

All Known Implementing Classes:

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

Enclosing interface:

ToolCallingChatOptions

public static interface ToolCallingChatOptions.Builder<B extends ToolCallingChatOptions.Builder<B>>
extends ChatOptions.Builder<B>

A builder to create a ToolCallingChatOptions instance.

Method Summary

Modifier and Type	Method	Description
ToolCallingChatOptions	build()	Build the ChatOptions.
B	frequencyPenalty(@Nullable Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
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	maxTokens(@Nullable Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
B	model(@Nullable String model)	Builds with the model to use for the chat.
B	presencePenalty(@Nullable Double presencePenalty)	Builds with the presence penalty to use for the chat.
B	stopSequences(@Nullable List<String> stopSequences)	Builds with the stop sequences to use for the chat.
B	temperature(@Nullable Double temperature)	Builds with the temperature to use for the chat.
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.
B	topK(@Nullable Integer topK)	Builds with the top K to use for the chat.
B	topP(@Nullable Double topP)	Builds with the top P to use for the chat.

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

combineWith

Method Details

toolCallbacks

B toolCallbacks(@Nullable List<ToolCallback> toolCallbacks)

ToolCallbacks to be registered with the ChatModel.

toolCallbacks

B toolCallbacks(ToolCallback... toolCallbacks)

ToolCallbacks to be registered with the ChatModel.

toolNames

B toolNames(@Nullable Set<String> toolNames)

Names of the tools to register with the ChatModel.

toolNames

B toolNames(String... toolNames)

Names of the tools to register with the ChatModel.

internalToolExecutionEnabled

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.

toolContext

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

Add a Map of context values into tool context.

Parameters:

context - the map representing the tool context.

Returns:

the ToolCallingChatOptions Builder.

toolContext

B toolContext(String key,
 Object value)

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

Parameters:

key - the key to use.

value - the corresponding value.

Returns:

the ToolCallingChatOptions Builder.

model

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

model -

Returns:

the builder

frequencyPenalty

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

frequencyPenalty -

Returns:

the builder.

maxTokens

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

maxTokens -

Returns:

the builder.

presencePenalty

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

presencePenalty -

Returns:

the builder.

stopSequences

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

stopSequences -

Returns:

the builder.

temperature

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

temperature -

Returns:

the builder.

topK

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

topK -

Returns:

the builder.

topP

B 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<B extends ToolCallingChatOptions.Builder<B>>

Parameters:

topP -

Returns:

the builder.

build

ToolCallingChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

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

Returns:

the Chat options.