Package org.springframework.ai.model.tool

Class DefaultToolCallingChatOptions

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptions

org.springframework.ai.model.tool.DefaultToolCallingChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class DefaultToolCallingChatOptions
extends DefaultChatOptions
implements ToolCallingChatOptions

Default implementation of ToolCallingChatOptions.

Since:

1.0.0

Author:

Thomas Vitale, Sebastien Deleuze, Christian Tzolov

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultToolCallingChatOptions(@Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext, @Nullable String model, @Nullable Double frequencyPenalty, @Nullable Integer maxTokens, @Nullable Double presencePenalty, @Nullable List<String> stopSequences, @Nullable Double temperature, @Nullable Integer topK, @Nullable Double topP)

Method Summary

Modifier and Type	Method	Description
static DefaultToolCallingChatOptions.Builder<?>	builder()	A builder to create a new ToolCallingChatOptions instance.
boolean	equals(@Nullable Object o)
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
int	hashCode()
ToolCallingChatOptions.Builder<?>	mutate()	Returns a new ChatOptions.Builder initialized with the values of this ChatOptions.

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

getFrequencyPenalty, getMaxTokens, getModel, getPresencePenalty, getStopSequences, getTemperature, getTopK, getTopP

Methods inherited from class java.lang.Object

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

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

getFrequencyPenalty, getMaxTokens, getModel, getPresencePenalty, getStopSequences, getTemperature, getTopK, getTopP

Constructor Details

DefaultToolCallingChatOptions

protected DefaultToolCallingChatOptions(@Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext,
 @Nullable String model,
 @Nullable Double frequencyPenalty,
 @Nullable Integer maxTokens,
 @Nullable Double presencePenalty,
 @Nullable List<String> stopSequences,
 @Nullable Double temperature,
 @Nullable Integer topK,
 @Nullable Double topP)

Method Details

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

getToolContext

public @Nullable 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.

mutate

public ToolCallingChatOptions.Builder<?> mutate()

Description copied from interface: ChatOptions

Returns a new ChatOptions.Builder initialized with the values of this ChatOptions. Concrete ChatOptions classes must override this to return the most concrete builder implementation.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface ToolCallingChatOptions

Overrides:

mutate in class DefaultChatOptions

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class DefaultChatOptions

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultChatOptions

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.