haystack/test/nodes/test_join_documents.py
Stefano Fiorucci 2b3c77e41d
fix: make JoinDocuments correctly handle duplicate documents w null scores (#6261)
* fix error with null values

* release note

* simplify
2023-11-09 14:28:56 +01:00

116 lines
4.3 KiB
Python

import pytest
from haystack import Document
from haystack.nodes.other.join_docs import JoinDocuments
@pytest.mark.unit
@pytest.mark.parametrize("join_mode", ["concatenate", "merge", "reciprocal_rank_fusion"])
def test_joindocuments(join_mode):
inputs = [
{"documents": [Document(content="text document 1", content_type="text", score=0.2)]},
{"documents": [Document(content="text document 2", content_type="text", score=0.7)]},
]
join_docs = JoinDocuments(join_mode=join_mode)
result, _ = join_docs.run(inputs)
assert len(result["documents"]) == 2
assert result["documents"] == sorted(result["documents"], reverse=True)
result, _ = join_docs.run(inputs, top_k_join=1)
assert len(result["documents"]) == 1
if join_mode == "reciprocal_rank_fusion":
assert result["documents"][0].content == "text document 1"
else:
assert result["documents"][0].content == "text document 2"
@pytest.mark.unit
@pytest.mark.parametrize("join_mode", ["concatenate", "merge", "reciprocal_rank_fusion"])
@pytest.mark.parametrize("sort_by_score", [True, False])
def test_joindocuments_score_none(join_mode, sort_by_score):
"""Testing JoinDocuments() node when some of the documents have `score=None`"""
inputs = [
{"documents": [Document(content="text document 1", content_type="text", score=0.2)]},
{"documents": [Document(content="text document 2", content_type="text", score=None)]},
]
join_docs = JoinDocuments(join_mode=join_mode, sort_by_score=sort_by_score)
result, _ = join_docs.run(inputs)
assert len(result["documents"]) == 2
result, _ = join_docs.run(inputs, top_k_join=1)
assert len(result["documents"]) == 1
@pytest.mark.unit
def test_joindocuments_preserves_root_node():
# https://github.com/deepset-ai/haystack-private/issues/51
inputs = [
{"documents": [Document(content="text document 1", content_type="text", score=0.2)], "root_node": "File"},
{"documents": [Document(content="text document 2", content_type="text", score=None)], "root_node": "File"},
]
join_docs = JoinDocuments()
result, _ = join_docs.run(inputs)
assert result["root_node"] == "File"
@pytest.mark.unit
def test_joindocuments_concatenate_keep_only_highest_ranking_duplicate():
inputs = [
{
"documents": [
Document(content="text document 1", content_type="text", score=0.2),
Document(content="text document 2", content_type="text", score=0.3),
]
},
{"documents": [Document(content="text document 2", content_type="text", score=0.7)]},
]
expected_outputs = {
"documents": [
Document(content="text document 2", content_type="text", score=0.7),
Document(content="text document 1", content_type="text", score=0.2),
]
}
join_docs = JoinDocuments(join_mode="concatenate")
result, _ = join_docs.run(inputs)
assert len(result["documents"]) == 2
assert result["documents"] == expected_outputs["documents"]
@pytest.mark.unit
def test_joindocuments_concatenate_duplicate_docs_null_score():
"""
Test that the concatenate method correctly handles duplicate documents,
when one has a null score.
"""
inputs = [
{
"documents": [
Document(content="text document 1", content_type="text", score=0.2),
Document(content="text document 2", content_type="text", score=0.3),
Document(content="text document 3", content_type="text", score=None),
]
},
{
"documents": [
Document(content="text document 2", content_type="text", score=0.7),
Document(content="text document 1", content_type="text", score=None),
]
},
]
expected_outputs = {
"documents": [
Document(content="text document 2", content_type="text", score=0.7),
Document(content="text document 1", content_type="text", score=0.2),
Document(content="text document 3", content_type="text", score=None),
]
}
join_docs = JoinDocuments(join_mode="concatenate")
result, _ = join_docs.run(inputs)
assert len(result["documents"]) == 3
assert result["documents"] == expected_outputs["documents"]