Package org.springframework.ai.tool.augment

Class ToolInputSchemaAugmenter

java.lang.Object

org.springframework.ai.tool.augment.ToolInputSchemaAugmenter

public final class ToolInputSchemaAugmenter
extends Object

This utility provides functionality to augment a JSON Schema with additional fields based on a provided Record type. It uses a JSON Schema Generator to generate the schema for the Record's fields and integrates them into an existing JSON Schema. The augmented schema can then be used to re-define the tool inputs for tool calling.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ToolInputSchemaAugmenter.AugmentedArgumentType	Represents an extended argument type with additional metadata such as description and required status.

Method Summary

Modifier and Type	Method	Description
static String	augmentToolInputSchema(String jsonSchemaString, String propertyName, Type propertyType, String description, boolean required)
static String	augmentToolInputSchema(String jsonSchemaString, List<ToolInputSchemaAugmenter.AugmentedArgumentType> argumentType)
static <T extends Record> List<ToolInputSchemaAugmenter.AugmentedArgumentType>	toAugmentedArgumentTypes(Class<T> recordClass)	Extracts the tool argument types from a record class annotated with ToolParam.

Methods inherited from class java.lang.Object

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

Method Details

toAugmentedArgumentTypes

public static <T extends Record>
List<ToolInputSchemaAugmenter.AugmentedArgumentType> toAugmentedArgumentTypes(Class<T> recordClass)

Extracts the tool argument types from a record class annotated with ToolParam. It retrieves the field names, types, descriptions, and required status from the record components.

Parameters:

recordClass - The record class to extract argument types from.

Returns:

A list of ToolInputSchemaAugmenter.AugmentedArgumentType representing the tool input argument types.

augmentToolInputSchema

public static String augmentToolInputSchema(String jsonSchemaString,
 String propertyName,
 Type propertyType,
 String description,
 boolean required)

augmentToolInputSchema

public static String augmentToolInputSchema(String jsonSchemaString,
 List<ToolInputSchemaAugmenter.AugmentedArgumentType> argumentType)