fix: improve Document __repr__

[anakin87]

Related Issues

• fixes Schema representation bug on Jupyter #3382

Proposed Changes:

As reported in #3382, there was a minor bug in __repr__ method of the Document class.
Since "The truth value of an array with more than one element is ambiguous.", I check instead that the embedding is not None.

How did you test it?

Manual tests

Notes for the reviewer

Other small fixes

Checklist

• I have read the contributors guidelines and the code of conduct
• I have updated the related issue with new insights and changes
• I added tests that demonstrate the correct behavior of the change
• I've used the conventional commit convention for my PR title
• I documented my code
• I ran pre-commit hooks and fixed any issue

[masci]

Hey @anakin87 thanks for the PR but I found out that the bug was already addressed in https://github.com/deepset-ai/haystack/pull/2891/files#diff-33a10a124046ca252619f7aee1dc2d1656668fa7cb5c23fef9c4ba0824d538e8R232 so I'm closing this one along with the related issue 🙏

[anakin87]

Hey @masci!
I agree that #3382 has been fixed by #2891.

Anyway, while working on this PR, I discovered another bug that is still present in the main branch and would have been fixed by this PR.

import numpy as np
from haystack import Document
d = Document(
        content="some text",
        content_type="text",
        score=0.99988,
        meta={"name": "doc1"},
        embedding=np.random.rand(5).astype(np.float32),
    )

repr(d) is:

<Document: {'content': 'some text', 'content_type': 'text', 'score': 0.99988, 'meta': {'name': 'doc1'}, 
'embedding': array([0.19878574, 0.44114766, 0.93554574, 0.84111285, 0.03531026],
      dtype=float32), 'id': 'c216d056ab381f2f730e4b3639f4dbc5'}>

Bug: the embedding is still included in repr instead of its shape, because of this line

haystack/haystack/schema.py

Line 234 in 16723bf

return f"<Document: {str(self.to_dict())}>"

[masci]

@anakin87 I completely missed that. Let's rebase on main then!

[anakin87]

@masci done!

[masci]

LGTM!