Package org.springframework.ai.model.tool

Interface ToolCallingChatOptions.Builder

All Superinterfaces:

ChatOptions.Builder

All Known Implementing Classes:

DefaultToolCallingChatOptions.Builder

Enclosing interface:

ToolCallingChatOptions

public static interface ToolCallingChatOptions.Builder
extends ChatOptions.Builder

A builder to create a ToolCallingChatOptions instance.

Method Summary

Modifier and Type	Method	Description
ToolCallingChatOptions	build()	Build the ChatOptions.
ToolCallingChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
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	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	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<ToolCallback> toolCallbacks)

ToolCallbacks to be registered with the ChatModel.

toolCallbacks

ToolCallingChatOptions.Builder toolCallbacks(ToolCallback... toolCallbacks)

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)

Add a Map of context values into tool context.

Parameters:

context - the map representing the tool context.

Returns:

the ToolCallingChatOptions Builder.

toolContext

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

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

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

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

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

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

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

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

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

Returns:

the builder.

build

ToolCallingChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder

Returns:

the Chat options.