Package org.springframework.ai.model.function

Interface FunctionCallback.Builder

All Known Implementing Classes:

DefaultFunctionCallbackBuilder

Enclosing interface:

FunctionCallback

public static interface FunctionCallback.Builder

Builder for creating a FunctionCallback instance. This is a hierarchical builder with the following structure:

• FunctionCallback.Builder - The root builder interface.
• FunctionCallback.FunctionInvokingSpec - The function invoking builder interface.
• FunctionCallback.MethodInvokingSpec - The method invoking builder interface.

Method Summary

Modifier and Type	Method	Description
FunctionCallback.Builder	description(String description)	Function description.
<I, O> FunctionCallback.FunctionInvokingSpec<I,O>	function(String name, BiFunction<I,ToolContext,O> biFunction)	Builds a BiFunction invoking FunctionCallback instance.
<I> FunctionCallback.FunctionInvokingSpec<I,Void>	function(String name, Consumer<I> consumer)	Builds a Consumer invoking FunctionCallback instance.
<I, O> FunctionCallback.FunctionInvokingSpec<I,O>	function(String name, Function<I,O> function)	Builds a Function invoking FunctionCallback instance.
<O> FunctionCallback.FunctionInvokingSpec<Void,O>	function(String name, Supplier<O> supplier)	Builds a Supplier invoking FunctionCallback instance.
FunctionCallback.Builder	inputTypeSchema(String inputTypeSchema)	You can provide the Input Type Schema directly.
FunctionCallback.MethodInvokingSpec	method(String methodName, Class<?>... argumentTypes)	Builds a Method invoking FunctionCallback instance.
FunctionCallback.Builder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Custom object mapper for JSON operations.
FunctionCallback.Builder	responseConverter(Function<Object,String> responseConverter)	Function response converter.
FunctionCallback.Builder	schemaType(FunctionCallbackContext.SchemaType schemaType)	Specifies what FunctionCallbackContext.SchemaType is used by the AI model to validate the function input arguments.

Method Details

description

FunctionCallback.Builder description(String description)

Function description. This description is used by the model do decide if the function should be called or not.

schemaType

FunctionCallback.Builder schemaType(FunctionCallbackContext.SchemaType schemaType)

Specifies what FunctionCallbackContext.SchemaType is used by the AI model to validate the function input arguments. Most models use JSON Schema, except Vertex AI that uses OpenAPI types.

responseConverter

FunctionCallback.Builder responseConverter(Function<Object,String> responseConverter)

Function response converter. The default implementation converts the output into String before sending it to the Model. Provide a custom function responseConverter implementation to override this.

inputTypeSchema

FunctionCallback.Builder inputTypeSchema(String inputTypeSchema)

You can provide the Input Type Schema directly. In this case it won't be generated from the inputType.

objectMapper

FunctionCallback.Builder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Custom object mapper for JSON operations.

function

<I,
O> FunctionCallback.FunctionInvokingSpec<I,O> function(String name,
 Function<I,O> function)

Builds a Function invoking FunctionCallback instance.

function

<I,
O> FunctionCallback.FunctionInvokingSpec<I,O> function(String name,
 BiFunction<I,ToolContext,O> biFunction)

Builds a BiFunction invoking FunctionCallback instance.

function

<O> FunctionCallback.FunctionInvokingSpec<Void,O> function(String name,
 Supplier<O> supplier)

Builds a Supplier invoking FunctionCallback instance.

function

<I> FunctionCallback.FunctionInvokingSpec<I,Void> function(String name,
 Consumer<I> consumer)

Builds a Consumer invoking FunctionCallback instance.

method

FunctionCallback.MethodInvokingSpec method(String methodName,
 Class<?>... argumentTypes)

Builds a Method invoking FunctionCallback instance.