feat: support multimodal tool results and improve tool message handling #6816
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a temporary `ToolResult` type that mirrors the structure returned by tools (text, image data, URLs, errors). - Implemented `convertToolPartToApiContentPart` to translate each tool output part into the format expected by the OpenAI chat completion API. - Updated `CompletionMessagesBuilder.addToolMessage` to accept a full `ToolResult` instead of a plain string and to: - Detect multimodal content (base64 images, image URLs) and build a structured `content` array. - Properly handle plain‑text results, tool execution errors, and unexpected formats with sensible fallbacks. - Cast the final content to `any` for the `tool` role as required by the API. - Modified `postMessageProcessing` to pass the raw tool result (`result as any`) to `addToolMessage`, avoiding premature extraction of only the first text part. - Refactored several formatting and type‑annotation sections: - Added multiline guard for empty user messages to insert a placeholder. - Split the image URL construction into a clearer multiline object. - Adjusted method signatures and added minor line‑breaks for readability. - Included extensive comments explaining the new logic and edge‑case handling. These changes enable the chat system to handle richer tool outputs (e.g., images, mixed content) and provide more robust error handling.
urmauur
requested review from
dinhlongviolin1 and
louis-jan
and removed request for
louis-jan
urmauur
approved these changes
Oct 24, 2025
Contributor
Barecheck - Code coverage reportTotal: 29.57%Your code coverage diff: 0.00% ▴ Uncovered files and lines
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe Your Changes
ToolResulttype that mirrors the structure returned by tools (text, image data, URLs, errors).convertToolPartToApiContentPartto translate each tool output part into the format expected by the OpenAI chat completion API.CompletionMessagesBuilder.addToolMessageto accept a fullToolResultinstead of a plain string and to:contentarray.anytype for thetoolrole as required by the API.postMessageProcessingto pass the raw tool result (result as ToolResult) toaddToolMessage, avoiding premature extraction of only the first text part.These changes enable the chat system to handle richer tool outputs (e.g., images, mixed content) and provide more robust error handling.
Fixes Issues
Self Checklist