fix(cohere): use dataclass replace to avoid modifying input documents #2755
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
This PR fixes the Cohere document embedder and ranker to not modify input Documents in place when setting embeddings or scores. Instead of mutating the original documents: doc.embedding = embeddings doc.score = score We now create new document instances using dataclass replace: replace(doc, embedding=embeddings) replace(doc, score=score) This follows the established pattern from haystack-ai/haystack#9693 and aligns with other integrations (FastEmbed, Optimum, Nvidia, Bedrock). Related to: deepset-ai#2174
GunaPalanivel
requested review from
julian-risch
and removed request for
a team
8 tasks
julian-risch
approved these changes
Jan 16, 2026
Member
julian-risch
left a comment
julian-risch
left a comment
There was a problem hiding this comment.
Looks good to me! @GunaPalanivel Thank you for your contribution. Great job! I'll release a new version of the integration.
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 Cohere Document Embedder and Ranker to not modify input Documents in place when setting embeddings or scores.
Changes Made
CohereDocumentEmbedder:run()method: Usereplace(doc, embedding=embeddings)instead ofdoc.embedding = embeddingsrun_async()method: Usereplace(doc, embedding=embeddings)instead ofdoc.embedding = embeddingsCohereRanker:run()method: Usereplace(doc, score=score)instead ofdoc.score = scoreNote:
CohereDocumentImageEmbedderalready usesreplace()correctly and didn't need changes.Tests Added
test_run_does_not_modify_original_documentsfor document embeddertest_run_async_does_not_modify_original_documentsfor document embeddertest_run_does_not_modify_original_documentsfor rankerHow 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)