chore: deprecate SentenceWindowRetrieval

deepset-ai / haystack

:mag: AI orchestration framework to build customizable, production-ready LLM applications. Connect components (models, vector DBs, file converters) to pipelines or agents that can interact with your data. With advanced retrieval methods, it's best suited for building RAG, question answering, semantic search or conversational agent chatbots.

Apache License 2.0

16.94k stars 1.85k forks source link

Proposed Changes:

Created a stub class named SentenceWindowRetrieval that inherits from SentenceWindowRetriever. This stub issues a deprecation warning to guide users to transition to the SentenceWindowRetriever class while maintaining backward compatibility.

How did you test it?

Ran the existing tests
Added new tests to check inheritance in SentenceWindowRetrieval

Notes for the reviewer

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 unit tests and updated the docstrings
I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.
I documented my code
I ran pre-commit hooks and fixed any issue

Totals
Change from base Build 10351241196:	0.009%
Covered Lines:	6961
Relevant Lines:	7724

Totals

Change from base Build 10351241196:

0.009%

Covered Lines:

6961

Relevant Lines:

7724

deepset-ai / haystack