haiku.rag/tests/test_reranker.py
2025-12-29 17:13:14 +02:00

230 lines
8.5 KiB
Python

from pathlib import Path
import pytest
from haiku.rag.config.models import AppConfig, ModelConfig, RerankingConfig
from haiku.rag.reranking import _reranker_cache, get_reranker
from haiku.rag.reranking.base import RerankerBase
from haiku.rag.store.models.chunk import Chunk
@pytest.fixture(scope="module")
def vcr_cassette_dir():
return str(Path(__file__).parent / "cassettes" / "test_reranker")
@pytest.fixture(autouse=True)
def clear_reranker_cache():
"""Clear the reranker cache before each test."""
_reranker_cache.clear()
yield
_reranker_cache.clear()
chunks = [
Chunk(content=content, document_id=str(i))
for i, content in enumerate(
[
"To Kill a Mockingbird is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
"The novel Moby-Dick was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil.",
"Harper Lee, an American novelist widely known for her novel To Kill a Mockingbird, was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
"Jane Austen was an English novelist known primarily for her six major novels, which interpret, critique and comment upon the British landed gentry at the end of the 18th century.",
"The Harry Potter series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era.",
"The Great Gatsby, a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan.",
]
)
]
@pytest.mark.asyncio
async def test_reranker_base():
from haiku.rag.config import Config
reranker = RerankerBase()
expected_model = Config.reranking.model.name if Config.reranking.model else None
assert reranker._model == expected_model
with pytest.raises(NotImplementedError):
await reranker.rerank("query", [])
@pytest.mark.asyncio
async def test_mxbai_reranker():
try:
from haiku.rag.config import Config
from haiku.rag.config.models import ModelConfig
from haiku.rag.reranking.mxbai import MxBAIReranker
Config.reranking.model = ModelConfig(
provider="mxbai", name="mixedbread-ai/mxbai-rerank-base-v2"
)
reranker = MxBAIReranker()
reranked = await reranker.rerank(
"Who wrote 'To Kill a Mockingbird'?", chunks, top_n=2
)
assert [chunk.document_id for chunk, score in reranked] == ["0", "2"]
assert all(isinstance(score, float) for chunk, score in reranked)
Config.reranking.model = None
except ImportError:
pytest.skip("MxBAI package not installed")
@pytest.mark.asyncio
@pytest.mark.vcr()
async def test_cohere_reranker():
try:
from haiku.rag.reranking.cohere import CohereReranker
reranker = CohereReranker()
reranker._model = "rerank-v3.5"
reranked = await reranker.rerank(
"Who wrote 'To Kill a Mockingbird'?", chunks, top_n=2
)
assert [chunk.document_id for chunk, score in reranked] == ["0", "2"]
assert all(isinstance(score, float) for chunk, score in reranked)
except ImportError:
pytest.skip("Cohere package not installed")
@pytest.mark.asyncio
@pytest.mark.vcr()
async def test_zeroentropy_reranker():
try:
from haiku.rag.reranking.zeroentropy import ZeroEntropyReranker
reranker = ZeroEntropyReranker("zerank-1")
reranked = await reranker.rerank(
"Who wrote 'To Kill a Mockingbird'?", chunks, top_n=2
)
assert len(reranked) == 2
assert all(isinstance(score, float) for chunk, score in reranked)
# Check that the top results are relevant to Harper Lee / To Kill a Mockingbird
top_ids = [chunk.document_id for chunk, score in reranked]
assert "0" in top_ids or "2" in top_ids # These chunks mention the book/author
except ImportError:
pytest.skip("Zero Entropy package not installed")
class TestGetReranker:
def test_returns_none_when_no_model_configured(self):
config = AppConfig(reranking=RerankingConfig(model=None))
result = get_reranker(config)
assert result is None
def test_mxbai_provider(self):
try:
from haiku.rag.reranking.mxbai import MxBAIReranker
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(
provider="mxbai", name="mixedbread-ai/mxbai-rerank-base-v2"
)
)
)
result = get_reranker(config)
assert isinstance(result, MxBAIReranker)
except ImportError:
pytest.skip("MxBAI package not installed")
def test_cohere_provider(self):
try:
from haiku.rag.reranking.cohere import CohereReranker
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(provider="cohere", name="rerank-v3.5")
)
)
result = get_reranker(config)
assert isinstance(result, CohereReranker)
except ImportError:
pytest.skip("Cohere package not installed")
def test_vllm_provider_with_base_url(self):
from haiku.rag.reranking.vllm import VLLMReranker
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(
provider="vllm",
name="BAAI/bge-reranker-v2-m3",
base_url="http://localhost:8000",
)
)
)
result = get_reranker(config)
assert isinstance(result, VLLMReranker)
assert result._model == "BAAI/bge-reranker-v2-m3"
assert result._base_url == "http://localhost:8000"
def test_vllm_provider_without_base_url_raises_error(self):
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(provider="vllm", name="BAAI/bge-reranker-v2-m3")
)
)
with pytest.raises(ValueError, match="vLLM reranker requires base_url"):
get_reranker(config)
def test_zeroentropy_provider(self):
try:
from haiku.rag.reranking.zeroentropy import ZeroEntropyReranker
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(provider="zeroentropy", name="zerank-1")
)
)
result = get_reranker(config)
assert isinstance(result, ZeroEntropyReranker)
assert result._model == "zerank-1"
except ImportError:
pytest.skip("Zero Entropy package not installed")
def test_zeroentropy_provider_default_model(self):
try:
from haiku.rag.reranking.zeroentropy import ZeroEntropyReranker
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(provider="zeroentropy", name="")
)
)
result = get_reranker(config)
assert isinstance(result, ZeroEntropyReranker)
assert result._model == "zerank-1"
except ImportError:
pytest.skip("Zero Entropy package not installed")
def test_caching_returns_same_instance(self):
config = AppConfig(reranking=RerankingConfig(model=None))
result1 = get_reranker(config)
result2 = get_reranker(config)
assert result1 is result2
def test_different_configs_get_separate_cache_entries(self):
config1 = AppConfig(reranking=RerankingConfig(model=None))
config2 = AppConfig(reranking=RerankingConfig(model=None))
result1 = get_reranker(config1)
result2 = get_reranker(config2)
# Both return None, but they should be cached separately
assert result1 is None
assert result2 is None
assert len(_reranker_cache) == 2
def test_unknown_provider_returns_none(self):
config = AppConfig(
reranking=RerankingConfig(
model=ModelConfig(provider="unknown_provider", name="some-model")
)
)
result = get_reranker(config)
assert result is None