Skip to content

fix: prevent IllegalStateException when ToolResponseMessage has no responses (GH-6197) #6213

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
suryateja-g13 wants to merge 1 commit into
base: main
Choose a base branch
from
+80 −14
Open

fix: prevent IllegalStateException when ToolResponseMessage has no responses (GH-6197) #6213

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
24 changes: 10 additions & 14 deletions models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,20 +815,16 @@ else if (message.getMessageType() == MessageType.ASSISTANT) {
else if (message.getMessageType() == MessageType.TOOL) {
ToolResponseMessage toolMessage = (ToolResponseMessage) message;

ChatCompletionToolMessageParam.Builder builder = ChatCompletionToolMessageParam.builder();
builder.content(toolMessage.getText() != null ? toolMessage.getText() : "");
builder.role(JsonValue.from(MessageType.TOOL.getValue()));

if (toolMessage.getResponses().isEmpty()) {
return List.of(ChatCompletionMessageParam.ofTool(builder.build()));
}
return toolMessage.getResponses().stream().map(response -> {
String callId = response.id();
String callResponse = response.responseData();

return ChatCompletionMessageParam
.ofTool(builder.toolCallId(callId).content(callResponse).build());
}).toList();
return toolMessage.getResponses()
.stream()
.filter(response -> StringUtils.hasText(response.id()))
.map(response -> {
ChatCompletionToolMessageParam.Builder builder = ChatCompletionToolMessageParam.builder();
builder.role(JsonValue.from(MessageType.TOOL.getValue()));
return ChatCompletionMessageParam
.ofTool(builder.toolCallId(response.id()).content(response.responseData()).build());
})
.toList();
}
else {
throw new IllegalArgumentException("Unsupported message type: " + message.getMessageType());
Expand Down
70 changes: 70 additions & 0 deletions ...ls/spring-ai-openai/src/test/java/org/springframework/ai/openai/OpenAiChatModelTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

import com.openai.client.OpenAIClient;
import com.openai.client.OpenAIClientAsync;
Expand All @@ -36,6 +37,8 @@
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import org.springframework.ai.chat.messages.ToolResponseMessage;
import org.springframework.ai.chat.messages.UserMessage;
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
import org.springframework.ai.chat.metadata.PromptMetadata;
import org.springframework.ai.chat.metadata.RateLimit;
Expand Down Expand Up @@ -193,6 +196,73 @@ void toolChoiceInvalidJson() {
.hasMessageContaining("Failed to parse toolChoice JSON");
}

@Test
void toolResponseMessageWithPopulatedResponses_mapsToOneParamPerResponse() {
OpenAiChatOptions options = OpenAiChatOptions.builder().model("test-model").build();
OpenAiChatModel chatModel = OpenAiChatModel.builder()
.openAiClient(this.openAiClient)
.openAiClientAsync(this.openAiClientAsync)
.options(options)
.build();

ToolResponseMessage toolMsg = ToolResponseMessage.builder()
.responses(List.of(new ToolResponseMessage.ToolResponse("call_1", "myTool", "result1"),
new ToolResponseMessage.ToolResponse("call_2", "myTool", "result2")))
.build();

ChatCompletionCreateParams request = chatModel.createRequest(new Prompt(List.of(toolMsg), options), false);

List<String> toolCallIds = request.messages()
.stream()
.filter(msg -> msg.isTool())
.map(msg -> msg.asTool().toolCallId())
.collect(Collectors.toList());

assertThat(toolCallIds).containsExactly("call_1", "call_2");
}

@Test
void toolResponseMessageWithEmptyResponses_producesNoMessages() {
OpenAiChatOptions options = OpenAiChatOptions.builder().model("test-model").build();
OpenAiChatModel chatModel = OpenAiChatModel.builder()
.openAiClient(this.openAiClient)
.openAiClientAsync(this.openAiClientAsync)
.options(options)
.build();

ToolResponseMessage emptyToolMsg = ToolResponseMessage.builder().build();

ChatCompletionCreateParams request = chatModel
.createRequest(new Prompt(List.of(new UserMessage("hello"), emptyToolMsg), options), false);

assertThat(request.messages().stream().filter(msg -> msg.isTool()).toList()).isEmpty();
}

@Test
void toolResponseMessageWithNullId_skipsResponse() {
OpenAiChatOptions options = OpenAiChatOptions.builder().model("test-model").build();
OpenAiChatModel chatModel = OpenAiChatModel.builder()
.openAiClient(this.openAiClient)
.openAiClientAsync(this.openAiClientAsync)
.options(options)
.build();

ToolResponseMessage toolMsg = ToolResponseMessage.builder()
.responses(List.of(new ToolResponseMessage.ToolResponse("call_1", "myTool", "result1"),
new ToolResponseMessage.ToolResponse(null, "badTool", "result2")))
.build();

ChatCompletionCreateParams request = chatModel.createRequest(new Prompt(List.of(toolMsg), options), false);

List<String> toolCallIds = request.messages()
.stream()
.filter(msg -> msg.isTool())
.map(msg -> msg.asTool().toolCallId())
.collect(Collectors.toList());

assertThat(toolCallIds).containsExactly("call_1");
}

@Test
void preserveRateLimitAndPromptMetadataInAggregation() throws Exception {
RateLimit rateLimit = mock(RateLimit.class);
Expand Down