Package org.springframework.ai.model.function

Class DefaultFunctionCallingOptionsBuilder

java.lang.Object

org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder

All Implemented Interfaces:

ChatOptions.Builder, FunctionCallingOptions.Builder

public class DefaultFunctionCallingOptionsBuilder
extends Object
implements FunctionCallingOptions.Builder

Default implementation of FunctionCallingOptions.Builder.

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor	Description
DefaultFunctionCallingOptionsBuilder()

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> stop)	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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFunctionCallingOptionsBuilder

public DefaultFunctionCallingOptionsBuilder()

Method Details

functionCallbacks

public FunctionCallingOptions.Builder functionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions.Builder

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

Specified by:

functionCallbacks in interface FunctionCallingOptions.Builder

Parameters:

functionCallbacks - the list of Function Callbacks.

Returns:

the FunctionCallOptions Builder.

functionCallbacks

public FunctionCallingOptions.Builder functionCallbacks(FunctionCallback... functionCallbacks)

Description copied from interface: FunctionCallingOptions.Builder

The Function Callbacks to be registered with the Chat model.

Specified by:

functionCallbacks in interface FunctionCallingOptions.Builder

Parameters:

functionCallbacks - the function callbacks.

Returns:

the FunctionCallOptions Builder.

functions

public FunctionCallingOptions.Builder functions(Set<String> functions)

Description copied from interface: FunctionCallingOptions.Builder

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

Specified by:

functions in interface FunctionCallingOptions.Builder

Parameters:

functions - the Set of function names

Returns:

the FunctionCallOptions Builder.

function

public FunctionCallingOptions.Builder function(String function)

Description copied from interface: FunctionCallingOptions.Builder

The function name to be registered with the chat model.

Specified by:

function in interface FunctionCallingOptions.Builder

Parameters:

function - the name of the function.

Returns:

the FunctionCallOptions Builder.

proxyToolCalls

public FunctionCallingOptions.Builder proxyToolCalls(Boolean proxyToolCalls)

Description copied from interface: FunctionCallingOptions.Builder

Boolean flag to indicate if the proxy ToolCalls is enabled.

Specified by:

proxyToolCalls in interface FunctionCallingOptions.Builder

Parameters:

proxyToolCalls - boolean value to enable proxy ToolCalls.

Returns:

the FunctionCallOptions Builder.

toolContext

public FunctionCallingOptions.Builder toolContext(Map<String,Object> context)

Description copied from interface: FunctionCallingOptions.Builder

Add a Map of context values into tool context.

Specified by:

toolContext in interface FunctionCallingOptions.Builder

Parameters:

context - the map representing the tool context.

Returns:

the FunctionCallOptions Builder.

toolContext

public FunctionCallingOptions.Builder toolContext(String key,
 Object value)

Description copied from interface: FunctionCallingOptions.Builder

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

Specified by:

toolContext in interface FunctionCallingOptions.Builder

Parameters:

key - the key to use.

value - the corresponding value.

Returns:

the FunctionCallOptions Builder.

model

public 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

Specified by:

model in interface FunctionCallingOptions.Builder

Returns:

the builder

frequencyPenalty

public 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

Specified by:

frequencyPenalty in interface FunctionCallingOptions.Builder

Returns:

the builder.

maxTokens

public 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

Specified by:

maxTokens in interface FunctionCallingOptions.Builder

Returns:

the builder.

presencePenalty

public 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

Specified by:

presencePenalty in interface FunctionCallingOptions.Builder

Returns:

the builder.

stopSequences

public FunctionCallingOptions.Builder stopSequences(List<String> stop)

Description copied from interface: ChatOptions.Builder

Builds with the stop sequences to use for the chat.

Specified by:

stopSequences in interface ChatOptions.Builder

Specified by:

stopSequences in interface FunctionCallingOptions.Builder

Returns:

the builder.

temperature

public 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

Specified by:

temperature in interface FunctionCallingOptions.Builder

Returns:

the builder.

topK

public 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

Specified by:

topK in interface FunctionCallingOptions.Builder

Returns:

the builder.

topP

public 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

Specified by:

topP in interface FunctionCallingOptions.Builder

Returns:

the builder.

build

public FunctionCallingOptions build()

Description copied from interface: FunctionCallingOptions.Builder

Builds the FunctionCallingOptions.

Specified by:

build in interface ChatOptions.Builder

Specified by:

build in interface FunctionCallingOptions.Builder

Returns:

the FunctionCalling options.