Package org.springframework.ai.util.json.schema

Class SpringAiSchemaModule

java.lang.Object

org.springframework.ai.util.json.schema.SpringAiSchemaModule

All Implemented Interfaces:

com.github.victools.jsonschema.generator.Module

public final class SpringAiSchemaModule
extends Object
implements com.github.victools.jsonschema.generator.Module

JSON Schema Generator Module for Spring AI.

This module provides a set of customizations to the JSON Schema generator to support the Spring AI framework. It allows to extract descriptions from @ToolParam(description = ...) annotations and to determine whether a property is required based on the presence of a series of annotations.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SpringAiSchemaModule.Option	Options for customizing the behavior of the module.

Constructor Summary

Constructors

Constructor	Description
SpringAiSchemaModule(SpringAiSchemaModule.Option... options)

Method Summary

Modifier and Type	Method	Description
void	applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)

Methods inherited from class java.lang.Object

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

Constructor Details

SpringAiSchemaModule

public SpringAiSchemaModule(SpringAiSchemaModule.Option... options)

Method Details

applyToConfigBuilder

public void applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)

Specified by:

applyToConfigBuilder in interface com.github.victools.jsonschema.generator.Module