Package org.springframework.ai.model.function

Interface FunctionCallingOptions

All Superinterfaces:

ChatOptions, ModelOptions

All Known Implementing Classes:

AnthropicChatOptions, AzureOpenAiChatOptions, DefaultFunctionCallingOptions, FunctionCallingOptionsBuilder.PortableFunctionCallingOptions, MiniMaxChatOptions, MistralAiChatOptions, MoonshotChatOptions, OllamaOptions, OpenAiChatOptions, VertexAiGeminiChatOptions, ZhiPuAiChatOptions

public interface FunctionCallingOptions
extends ChatOptions

FunctionCallingOptions is a set of options that can be used to configure the function calling behavior of the ChatModel.

Author:

Christian Tzolov, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FunctionCallingOptions.Builder	Builder for creating FunctionCallingOptions instance.

Method Summary

Modifier and Type	Method	Description
static FunctionCallingOptions.Builder	builder()	Creates a new ChatOptions.Builder to create the default ChatOptions.
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
default Boolean	getProxyToolCalls()
Map<String,Object>	getToolContext()
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatModel.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
default void	setProxyToolCalls(Boolean proxyToolCalls)
void	setToolContext(Map<String,Object> tooContext)

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

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

Method Details

builder

static FunctionCallingOptions.Builder builder()

Description copied from interface: ChatOptions

Creates a new ChatOptions.Builder to create the default ChatOptions.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

getFunctionCallbacks

List<FunctionCallback> getFunctionCallbacks()

Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Set the Function Callbacks to be registered with the ChatModel.

Parameters:

functionCallbacks - the Function Callbacks to be registered with the ChatModel.

getFunctions

Set<String> getFunctions()

Returns:

Set of function names from the ChatModel registry to be used in the next chat completion requests.

setFunctions

void setFunctions(Set<String> functions)

Set the list of function names from the ChatModel registry to be used in the next chat completion requests.

Parameters:

functions - the list of function names from the ChatModel registry to be used in the next chat completion requests.

getProxyToolCalls

default Boolean getProxyToolCalls()

setProxyToolCalls

default void setProxyToolCalls(Boolean proxyToolCalls)

getToolContext

Map<String,Object> getToolContext()

setToolContext

void setToolContext(Map<String,Object> tooContext)