feat: Add support to deserialize chat messages serialized with pydantic - #12025
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
github-actions
Bot
added
topic:tests
type:documentation
Contributor
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
sjrl
marked this pull request as ready for review
July 16, 2026 06:12
sjrl
requested review from
anakin87 and
bogdankostic
and removed request for
a team and
bogdankostic
July 16, 2026 06:12
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Related Issues
Proposed Changes:
When a ChatMessage is a field of a Pydantic model (e.g. an API request/response DTO), model_dump() silently serializes it as a plain dataclass: raw fields (_role, _content) with content parts unwrapped ({"tool_name": ..., "arguments": ...} instead of {"tool_call": {...}}). ChatMessage.from_dict rejected this format for anything containing tool calls, tool results, reasoning, images, and files.
This was causing issues in platform because they couldn't easily deserialize incoming ChatMessages using
ChatMessage.from_dictbefore passing it off to the Haystack pipeline. SoChatMessage.from_dictnow also accepts the Pydantic auto-serialized format to help make it easier in platform to deserialize ChatMessages.How did you test it?
Added new tests.
Notes for the reviewer
cc @tstadel
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.