Skip to content

Fix JsonSchemaGenerator for method input parameters #4524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2025
Merged

Fix JsonSchemaGenerator for method input parameters #4524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...g-ai-model/src/main/java/org/springframework/ai/util/json/schema/JsonSchemaGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ public static String generateForMethodInput(Method method, SchemaOption... schem
required.add(parameterName);
}
ObjectNode parameterNode = SUBTYPE_SCHEMA_GENERATOR.generateSchema(parameterType);
// Remove OpenAPI format as some LLMs (like Mistral) don't handle them.
parameterNode.remove("format");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the parameterNode doesn't contain "format", this operation just returns null and hence we don't need explicit check on the existence of this property.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to find out what other cases the OpenAPI format can be used in the context of ChatClient request.

String parameterDescription = getMethodParameterDescription(method, i);
if (StringUtils.hasText(parameterDescription)) {
parameterNode.put("description", parameterDescription);
Expand Down
18 changes: 6 additions & 12 deletions spring-ai-model/src/test/java/org/springframework/ai/util/json/JsonSchemaGeneratorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ void generateSchemaForMethodWithSimpleParameters() throws Exception {
"type": "string"
},
"age": {
"type": "integer",
"format": "int32"
"type": "integer"
}
},
"required": [
Expand Down Expand Up @@ -265,8 +264,7 @@ void generateSchemaForMethodWithUpperCaseTypes() throws Exception {
"type": "STRING"
},
"age": {
"type": "INTEGER",
"format": "int32"
"type": "INTEGER"
}
},
"required": [
Expand Down Expand Up @@ -348,16 +346,13 @@ void generateSchemaForMethodWithTimeParameters() throws Exception {
"type": "object",
"properties": {
"duration": {
"type": "string",
"format": "duration"
"type": "string"
},
"localDateTime": {
"type": "string",
"format": "date-time"
"type": "string"
},
"instant": {
"type": "string",
"format": "date-time"
"type": "string"
}
},
"required": [
Expand Down Expand Up @@ -387,8 +382,7 @@ void generateSchemaForMethodWithToolContext() throws Exception {
"type": "string"
},
"expectedDelivery": {
"type": "string",
"format": "date-time"
"type": "string"
}
},
"required": [
Expand Down