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, ChatOptions

Constructor Summary

Constructors

Constructor	Description
PortableFunctionCallingOptions()

Method Summary

Modifier and Type	Method	Description
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatClient.
Set<String>	getFunctions()
Float	getTemperature()
Integer	getTopK()
Float	getTopP()
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatClient.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatClient registry to be used in the next chat completion requests.
void	setTemperature(Float temperature)
void	setTopK(Integer topK)
void	setTopP(Float 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

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatClient. 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 ChatClient 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 ChatClient.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatClient.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

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

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

List of function names from the ChatClient 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 ChatClient 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 ChatClient registry to be used in the next chat completion requests.

getTemperature

public Float getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Float temperature)

getTopP

public Float getTopP()

Specified by:

getTopP in interface ChatOptions

setTopP

public void setTopP(Float topP)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

setTopK

public void setTopK(Integer topK)