Package org.springframework.ai.model.function

Class FunctionCallingOptionsBuilder.PortableFunctionCallingOptions

java.lang.Object

org.springframework.ai.model.function.FunctionCallingOptionsBuilder.PortableFunctionCallingOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

Enclosing class:

FunctionCallingOptionsBuilder

public static class FunctionCallingOptionsBuilder.PortableFunctionCallingOptions
extends Object
implements FunctionCallingOptions

Constructor Summary

Constructors

Constructor	Description
PortableFunctionCallingOptions()

Method Summary

Modifier and Type	Method	Description
static FunctionCallingOptionsBuilder	builder()
ChatOptions	copy()	Returns a copy of this ChatOptions.
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Boolean	getProxyToolCalls()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
Map<String,Object>	getToolContext()
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
FunctionCallingOptionsBuilder.PortableFunctionCallingOptions	merge(ChatOptions options)
FunctionCallingOptionsBuilder.PortableFunctionCallingOptions	merge(FunctionCallingOptions options)
void	setFrequencyPenalty(Double frequencyPenalty)
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.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setPresencePenalty(Double presencePenalty)
void	setProxyToolCalls(Boolean proxyToolCalls)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolContext(Map<String,Object> context)
void	setTopK(Integer topK)
void	setTopP(Double topP)

Methods inherited from class java.lang.Object

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

Constructor Details

PortableFunctionCallingOptions

public PortableFunctionCallingOptions()

Method Details

builder

public static FunctionCallingOptionsBuilder builder()

Returns:

Returns FunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

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.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatModel.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

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

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

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

setFunctions

public void setFunctions(Set<String> functions)

Description copied from interface: FunctionCallingOptions

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

Specified by:

setFunctions in interface FunctionCallingOptions

Parameters:

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

getModel

public 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

setModel

public void setModel(String model)

getFrequencyPenalty

public 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

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

getMaxTokens

public 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

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getPresencePenalty

public 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

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getStopSequences

public 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

setStopSequences

public void setStopSequences(List<String> stopSequences)

getTemperature

public 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

setTemperature

public void setTemperature(Double temperature)

getTopK

public 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

setTopK

public void setTopK(Integer topK)

getTopP

public 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

setTopP

public void setTopP(Double topP)

getProxyToolCalls

public Boolean getProxyToolCalls()

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

public void setProxyToolCalls(Boolean proxyToolCalls)

Specified by:

setProxyToolCalls in interface FunctionCallingOptions

getToolContext

public Map<String,Object> getToolContext()

Specified by:

getToolContext in interface FunctionCallingOptions

setToolContext

public void setToolContext(Map<String,Object> context)

Specified by:

setToolContext in interface FunctionCallingOptions

copy

public ChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

merge

public FunctionCallingOptionsBuilder.PortableFunctionCallingOptions merge(FunctionCallingOptions options)

merge

public FunctionCallingOptionsBuilder.PortableFunctionCallingOptions merge(ChatOptions options)