Package org.springframework.ai.model.tool

Class DefaultToolCallingChatOptions

java.lang.Object

org.springframework.ai.model.tool.DefaultToolCallingChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class DefaultToolCallingChatOptions
extends Object
implements ToolCallingChatOptions

Default implementation of ToolCallingChatOptions.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultToolCallingChatOptions.Builder<B extends DefaultToolCallingChatOptions.Builder<B>>	Default implementation of ToolCallingChatOptions.Builder.

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
DefaultToolCallingChatOptions()

Method Summary

Modifier and Type	Method	Description
static DefaultToolCallingChatOptions.Builder<?>	builder()	A builder to create a new ToolCallingChatOptions instance.
<T extends ChatOptions> T	copy()	Returns a copy of this ChatOptions.
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Boolean	getInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
@Nullable Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
@Nullable String	getModel()	Returns the model to use for the chat.
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
@Nullable Double	getTemperature()	Returns the temperature to use for the chat.
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Map<String,Object>	getToolContext()	Get the configured tool context.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
@Nullable Double	getTopP()	Returns the top P to use for the chat.
ToolCallingChatOptions.Builder<?>	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultToolCallingChatOptions

public DefaultToolCallingChatOptions()

Method Details

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getToolNames in interface ToolCallingChatOptions

getToolContext

public Map<String,Object> getToolContext()

Description copied from interface: ToolCallingChatOptions

Get the configured tool context.

Specified by:

getToolContext in interface ToolCallingChatOptions

Returns:

the tool context map.

getInternalToolExecutionEnabled

public @Nullable Boolean getInternalToolExecutionEnabled()

Description copied from interface: ToolCallingChatOptions

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:

getInternalToolExecutionEnabled in interface ToolCallingChatOptions

getModel

public @Nullable String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

getFrequencyPenalty

public @Nullable Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

getMaxTokens

public @Nullable Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

getPresencePenalty

public @Nullable Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

getStopSequences

public @Nullable List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

getTemperature

public @Nullable Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

getTopK

public @Nullable Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

getTopP

public @Nullable Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

copy

public <T extends ChatOptions> T copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

mutate

public ToolCallingChatOptions.Builder<?> mutate()

Description copied from interface: ToolCallingChatOptions

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions. Narrows the return type of ChatOptions.mutate() so generic tool calling code can chain methods without casting.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface ToolCallingChatOptions

builder

public static DefaultToolCallingChatOptions.Builder<?> builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.