Skip to content

GH-5116: Fix openai default null tool arguments to empty JSON string #5232

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

Open
thisishwan2 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

GH-5116: Fix openai default null tool arguments to empty JSON string #5232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a910cf9
Fix openai default null tool arguments to empty JSON string
thisishwan2 Jan 13, 2026
1e2eefd
Fix code formatting
thisishwan2 Jan 13, 2026
e724059
translate comments to English
thisishwan2 Jan 14, 2026
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
6 changes: 6 additions & 0 deletions models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1684,6 +1684,12 @@ public ToolCall(String id, String type, ChatCompletionFunction function) {
public record ChatCompletionFunction(// @formatter:off
@JsonProperty("name") String name,
@JsonProperty("arguments") String arguments) { // @formatter:on

public ChatCompletionFunction {
if (arguments == null) {
arguments = "{}";
}
}
}

/**
Expand Down
17 changes: 17 additions & 0 deletions models/spring-ai-openai/src/test/java/org/springframework/ai/openai/api/OpenAiApiIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.testcontainers.shaded.com.fasterxml.jackson.core.JsonProcessingException;
import org.testcontainers.shaded.com.fasterxml.jackson.databind.ObjectMapper;
import reactor.core.publisher.Flux;

import org.springframework.ai.openai.api.OpenAiApi.ChatCompletion;
Expand Down Expand Up @@ -295,4 +297,19 @@ void userAgentHeaderIsSentInChatCompletionRequests() throws Exception {
}
}

@Test
void nullArgumentsDefaultsToEmpty() throws JsonProcessingException {
final String TOOL_FUNCTION_NAME = "CurrentWeather";

var function = new ChatCompletionMessage.ChatCompletionFunction(TOOL_FUNCTION_NAME, null);

ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(function);

assertThat(function.arguments()).isEqualTo("{}");

// Verify that the JSON string contains the "arguments" field ("arguments": "{}")
assertThat(json).contains("\"arguments\":\"{}\"");
}

}