fix(watsonx): use dataclass replace to avoid modifying input documents#2766
Merged
sjrl merged 1 commit intoJan 21, 2026
Conversation
This PR fixes the Watson X Document Embedder to avoid mutating input Documents when setting embeddings. Instead of mutating the original documents: doc.embedding = emb We now create new document instances using dataclass replace: replace(doc, embedding=emb) This follows the established pattern from haystack-ai/haystack#9693 and aligns with other integrations (FastEmbed, Optimum, Nvidia, Bedrock, Cohere, Google GenAI, Jina). Related to: deepset-ai#2174
github-actions
Bot
added
integration:watsonx
type:documentation
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
This PR fixes the Watson X Document Embedder to avoid mutating input Documents when setting embeddings.
Changes Made
WatsonxDocumentEmbedder:run()method: Usereplace(doc, embedding=emb)instead ofdoc.embedding = embTests Added
test_run_does_not_modify_original_documentsfor document embedderHow did you test it?
Notes for the reviewer
This follows the established pattern from:
warm_upand don't modify Documents in place #2678 (FastEmbed)warm_upand don't modify Documents in place #2675 (Optimum)warm_upand don't modify Documents in place #2680 (Nvidia)