Package org.springframework.ai.model.function

Class DefaultCommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

java.lang.Object

org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec<B>

All Implemented Interfaces:

FunctionCallback.CommonCallbackInvokingSpec<B>

public class DefaultCommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>
extends Object
implements FunctionCallback.CommonCallbackInvokingSpec<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	The description of the function callback.
protected String	inputTypeSchema	(Optional) Instead of generating the input type schema from the input type or method argument types, you can provide the schema directly.
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected Function<Object,String>	responseConverter	The function to convert the response object to a string.
protected FunctionCallback.SchemaType	schemaType	The schema type to use for the input type schema generation.

Constructor Summary

Constructors

Constructor	Description
DefaultCommonCallbackInvokingSpec()

Method Summary

Modifier and Type	Method	Description
B	description(String description)	Function description.
String	getDescription()
String	getInputTypeSchema()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Function<Object,String>	getResponseConverter()
FunctionCallback.SchemaType	getSchemaType()
B	inputTypeSchema(String inputTypeSchema)	You can provide the Input Type Schema directly.
B	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Custom object mapper for JSON operations.
B	responseConverter(Function<Object,String> responseConverter)	Function response converter.
B	schemaType(FunctionCallback.SchemaType schemaType)	Specifies what FunctionCallback.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

Field Details

description

protected String description

The description of the function callback. Used to hint the LLM model about the tool's purpose and when to use it.

schemaType

protected FunctionCallback.SchemaType schemaType

The schema type to use for the input type schema generation. The default is JSON Schema. Note: Vertex AI requires the input type schema to be in Open API schema

responseConverter

protected Function<Object,String> responseConverter

The function to convert the response object to a string. The default is to convert the response to a JSON string.

inputTypeSchema

protected String inputTypeSchema

(Optional) Instead of generating the input type schema from the input type or method argument types, you can provide the schema directly. This will override the generated schema.

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

DefaultCommonCallbackInvokingSpec

public DefaultCommonCallbackInvokingSpec()

Method Details

description

public B description(String description)

Description copied from interface: FunctionCallback.CommonCallbackInvokingSpec

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

Specified by:

description in interface FunctionCallback.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

schemaType

public B schemaType(FunctionCallback.SchemaType schemaType)

Description copied from interface: FunctionCallback.CommonCallbackInvokingSpec

Specifies what FunctionCallback.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.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

responseConverter

public B responseConverter(Function<Object,String> responseConverter)

Description copied from interface: FunctionCallback.CommonCallbackInvokingSpec

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.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

inputTypeSchema

public B inputTypeSchema(String inputTypeSchema)

Description copied from interface: FunctionCallback.CommonCallbackInvokingSpec

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.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

objectMapper

public B objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Description copied from interface: FunctionCallback.CommonCallbackInvokingSpec

Custom object mapper for JSON operations.

Specified by:

objectMapper in interface FunctionCallback.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>

getDescription

public String getDescription()

getSchemaType

public FunctionCallback.SchemaType getSchemaType()

getResponseConverter

public Function<Object,String> getResponseConverter()

getInputTypeSchema

public String getInputTypeSchema()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()