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

Class SpringAiSchemaModule

java.lang.Object

org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

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

All Implemented Interfaces:

com.github.victools.jsonschema.generator.Module

public final class SpringAiSchemaModule
extends AbstractSpringAiSchemaModule

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 extracting 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/interfaces inherited from class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

AbstractSpringAiSchemaModule.Option

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected @Nullable String	resolveToolParamDescription(com.github.victools.jsonschema.generator.MemberScope<?,?> member)	Extract the description from the tool-param annotation for the given member, or return null if the annotation is absent or its description is blank.
protected @Nullable Boolean	resolveToolParamRequired(com.github.victools.jsonschema.generator.MemberScope<?,?> member)	Extract the required flag from the tool-param annotation for the given member, or return null if the annotation is absent.

Methods inherited from class org.springframework.ai.util.json.schema.AbstractSpringAiSchemaModule

applyToConfigBuilder

Methods inherited from class java.lang.Object

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

Constructor Details

SpringAiSchemaModule

public SpringAiSchemaModule(AbstractSpringAiSchemaModule.Option... options)

Method Details

resolveToolParamDescription

protected @Nullable String resolveToolParamDescription(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Description copied from class: AbstractSpringAiSchemaModule

Extract the description from the tool-param annotation for the given member, or return null if the annotation is absent or its description is blank.

Specified by:

resolveToolParamDescription in class AbstractSpringAiSchemaModule

resolveToolParamRequired

protected @Nullable Boolean resolveToolParamRequired(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Description copied from class: AbstractSpringAiSchemaModule

Extract the required flag from the tool-param annotation for the given member, or return null if the annotation is absent.

Specified by:

resolveToolParamRequired in class AbstractSpringAiSchemaModule