fix(chat): handle multiple returnDirect responses in DefaultChatClient (#4655) #4661
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes an issue where
ChatClient.content()
returned only the first generation when multiple tools usedreturnDirect = true
.The update ensures that all
returnDirect
generations are aggregated consistently across bothcall()
andstream()
flows, independent of the provider implementation.Changes
File updated:
spring-ai-client-chat/src/main/java/org/springframework/ai/chat/client/DefaultChatClient.java
getContentFromChatResponse
(around L525):finishReason = "returnDirect"
:→ Concatenate all generation texts using a newline (
\n
).stream().content()
aggregation logic:Updated to mirror the same multi-generation handling for consistency with synchronous responses.
Tests
New test class:
spring-ai-client-chat/src/test/java/org/springframework/ai/chat/client/DefaultChatClientReturnDirectAggregationTests.java
aggregatesMultipleReturnDirectGenerationsInContent
:Verifies that multiple
returnDirect
generations are joined with newlines.returnsFirstWhenNotAllReturnDirect
:Ensures fallback to the first generation when not all generations use
returnDirect
.Compatibility
✅ No breaking changes.
Behavior remains identical when:
returnDirect
.This enhancement improves content consistency and tool aggregation behavior without altering existing APIs.
Notes
call()
andstream()
methods.