Package org.springframework.ai.model.function

Class DefaultFunctionCallbackBuilder

java.lang.Object

org.springframework.ai.model.function.DefaultFunctionCallbackBuilder

All Implemented Interfaces:

FunctionCallback.Builder

public class DefaultFunctionCallbackBuilder
extends Object
implements FunctionCallback.Builder

Default implementation of the FunctionCallback.Builder.

Since:

1.0.0

Author:

Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
DefaultFunctionCallbackBuilder()

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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFunctionCallbackBuilder

public DefaultFunctionCallbackBuilder()

Method Details

description

public FunctionCallback.Builder description(String description)

Description copied from interface: FunctionCallback.Builder

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

Specified by:

description in interface FunctionCallback.Builder

schemaType

public FunctionCallback.Builder schemaType(FunctionCallbackContext.SchemaType schemaType)

Description copied from interface: FunctionCallback.Builder

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.

Specified by:

schemaType in interface FunctionCallback.Builder

responseConverter

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

Description copied from interface: FunctionCallback.Builder

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.

Specified by:

responseConverter in interface FunctionCallback.Builder

inputTypeSchema

public FunctionCallback.Builder inputTypeSchema(String inputTypeSchema)

Description copied from interface: FunctionCallback.Builder

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

Specified by:

inputTypeSchema in interface FunctionCallback.Builder

objectMapper

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

Description copied from interface: FunctionCallback.Builder

Custom object mapper for JSON operations.

Specified by:

objectMapper in interface FunctionCallback.Builder

function

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

Description copied from interface: FunctionCallback.Builder

Builds a Function invoking FunctionCallback instance.

Specified by:

function in interface FunctionCallback.Builder

function

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

Description copied from interface: FunctionCallback.Builder

Builds a BiFunction invoking FunctionCallback instance.

Specified by:

function in interface FunctionCallback.Builder

function

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

Description copied from interface: FunctionCallback.Builder

Builds a Supplier invoking FunctionCallback instance.

Specified by:

function in interface FunctionCallback.Builder

function

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

Description copied from interface: FunctionCallback.Builder

Builds a Consumer invoking FunctionCallback instance.

Specified by:

function in interface FunctionCallback.Builder

method

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

Description copied from interface: FunctionCallback.Builder

Builds a Method invoking FunctionCallback instance.

Specified by:

method in interface FunctionCallback.Builder