Package org.springframework.ai.model.function

Interface FunctionCallingOptions.Builder

All Superinterfaces:

ChatOptions.Builder

All Known Implementing Classes:

DefaultFunctionCallingOptionsBuilder

Enclosing interface:

FunctionCallingOptions

public static interface FunctionCallingOptions.Builder
extends ChatOptions.Builder

Builder for creating FunctionCallingOptions instance.

Method Summary

Modifier and Type	Method	Description
FunctionCallingOptions	build()	Builds the FunctionCallingOptions.
FunctionCallingOptions.Builder	frequencyPenalty(Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
FunctionCallingOptions.Builder	function(String function)	The function name to be registered with the chat model.
FunctionCallingOptions.Builder	functionCallbacks(List<FunctionCallback> functionCallbacks)	The list of Function Callbacks to be registered with the Chat model.
FunctionCallingOptions.Builder	functionCallbacks(FunctionCallback... functionCallbacks)	The Function Callbacks to be registered with the Chat model.
FunctionCallingOptions.Builder	functions(Set<String> functions)	Set of function names to be registered with the Chat model.
FunctionCallingOptions.Builder	maxTokens(Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
FunctionCallingOptions.Builder	model(String model)	Builds with the model to use for the chat.
FunctionCallingOptions.Builder	presencePenalty(Double presencePenalty)	Builds with the presence penalty to use for the chat.
FunctionCallingOptions.Builder	proxyToolCalls(Boolean proxyToolCalls)	Boolean flag to indicate if the proxy ToolCalls is enabled.
FunctionCallingOptions.Builder	stopSequences(List<String> stopSequences)	Builds with the stop sequences to use for the chat.
FunctionCallingOptions.Builder	temperature(Double temperature)	Builds with the temperature to use for the chat.
FunctionCallingOptions.Builder	toolContext(String key, Object value)	Add a specific key/value pair to the tool context.
FunctionCallingOptions.Builder	toolContext(Map<String,Object> context)	Add a Map of context values into tool context.
FunctionCallingOptions.Builder	topK(Integer topK)	Builds with the top K to use for the chat.
FunctionCallingOptions.Builder	topP(Double topP)	Builds with the top P to use for the chat.
default FunctionCallingOptions.Builder	withFrequencyPenalty(Double frequencyPenalty)	Deprecated, for removal: This API element is subject to removal in a future version. Use frequencyPenalty(Double) instead.
default FunctionCallingOptions.Builder	withFunction(String function)	Deprecated, for removal: This API element is subject to removal in a future version. Use function(String) instead.
default FunctionCallingOptions.Builder	withFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. Use functionCallbacks(List) instead.
default FunctionCallingOptions.Builder	withFunctionCallbacks(FunctionCallback... functionCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. Use functionCallbacks(FunctionCallback...) instead.
default FunctionCallingOptions.Builder	withFunctions(Set<String> functions)	Deprecated, for removal: This API element is subject to removal in a future version. Use functions(Set) instead.
default FunctionCallingOptions.Builder	withMaxTokens(Integer maxTokens)	Deprecated, for removal: This API element is subject to removal in a future version. Use maxTokens(Integer) instead.
default FunctionCallingOptions.Builder	withModel(String model)	Deprecated, for removal: This API element is subject to removal in a future version. Use model(String) instead.
default FunctionCallingOptions.Builder	withPresencePenalty(Double presencePenalty)	Deprecated, for removal: This API element is subject to removal in a future version. Use presencePenalty(Double) instead.
default FunctionCallingOptions.Builder	withStopSequences(List<String> stopSequences)	Deprecated, for removal: This API element is subject to removal in a future version. Use stopSequences(List) instead.
default FunctionCallingOptions.Builder	withTemperature(Double temperature)	Deprecated, for removal: This API element is subject to removal in a future version. Use temperature(Double) instead.

Method Details

functionCallbacks

FunctionCallingOptions.Builder functionCallbacks(List<FunctionCallback> functionCallbacks)

The list of Function Callbacks to be registered with the Chat model.

Parameters:

functionCallbacks - the list of Function Callbacks.

Returns:

the FunctionCallOptions Builder.

functionCallbacks

FunctionCallingOptions.Builder functionCallbacks(FunctionCallback... functionCallbacks)

The Function Callbacks to be registered with the Chat model.

Parameters:

functionCallbacks - the function callbacks.

Returns:

the FunctionCallOptions Builder.

functions

FunctionCallingOptions.Builder functions(Set<String> functions)

Set of function names to be registered with the Chat model.

Parameters:

functions - the Set of function names

Returns:

the FunctionCallOptions Builder.

function

FunctionCallingOptions.Builder function(String function)

The function name to be registered with the chat model.

Parameters:

function - the name of the function.

Returns:

the FunctionCallOptions Builder.

proxyToolCalls

FunctionCallingOptions.Builder proxyToolCalls(Boolean proxyToolCalls)

Boolean flag to indicate if the proxy ToolCalls is enabled.

Parameters:

proxyToolCalls - boolean value to enable proxy ToolCalls.

Returns:

the FunctionCallOptions Builder.

toolContext

FunctionCallingOptions.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 FunctionCallOptions Builder.

toolContext

FunctionCallingOptions.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 FunctionCallOptions Builder.

build

FunctionCallingOptions build()

Builds the FunctionCallingOptions.

Specified by:

build in interface ChatOptions.Builder

Returns:

the FunctionCalling options.

model

FunctionCallingOptions.Builder model(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

FunctionCallingOptions.Builder frequencyPenalty(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

FunctionCallingOptions.Builder maxTokens(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

FunctionCallingOptions.Builder presencePenalty(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

FunctionCallingOptions.Builder stopSequences(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

FunctionCallingOptions.Builder temperature(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

FunctionCallingOptions.Builder topK(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

FunctionCallingOptions.Builder topP(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.

withModel

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withModel(String model)

Deprecated, for removal: This API element is subject to removal in a future version.

Use model(String) instead.

withFrequencyPenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withFrequencyPenalty(Double frequencyPenalty)

Deprecated, for removal: This API element is subject to removal in a future version.

Use frequencyPenalty(Double) instead.

withMaxTokens

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withMaxTokens(Integer maxTokens)

Deprecated, for removal: This API element is subject to removal in a future version.

Use maxTokens(Integer) instead.

withPresencePenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withPresencePenalty(Double presencePenalty)

Deprecated, for removal: This API element is subject to removal in a future version.

Use presencePenalty(Double) instead.

withStopSequences

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withStopSequences(List<String> stopSequences)

Deprecated, for removal: This API element is subject to removal in a future version.

Use stopSequences(List) instead.

withTemperature

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withTemperature(Double temperature)

Deprecated, for removal: This API element is subject to removal in a future version.

Use temperature(Double) instead.

withFunctionCallbacks

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated, for removal: This API element is subject to removal in a future version.

Use functionCallbacks(List) instead.

withFunctionCallbacks

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withFunctionCallbacks(FunctionCallback... functionCallbacks)

Deprecated, for removal: This API element is subject to removal in a future version.

Use functionCallbacks(FunctionCallback...) instead.

withFunctions

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withFunctions(Set<String> functions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use functions(Set) instead.

withFunction

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
default FunctionCallingOptions.Builder withFunction(String function)

Deprecated, for removal: This API element is subject to removal in a future version.

Use function(String) instead.