Deprecate SentenceWindowRetrieval (#8206) (#8223)

docs/pydoc/config/retrievers_api.yml

@@ -7,6 +7,7 @@ loaders:
         "in_memory/embedding_retriever",
         "filter_retriever",
         "sentence_window_retriever",
+        "sentence_window_retrieval"
       ]
     ignore_when_discovered: ["__init__"]
 processors:

haystack/components/retrievers/__init__.py

@@ -5,6 +5,13 @@
 from haystack.components.retrievers.filter_retriever import FilterRetriever
 from haystack.components.retrievers.in_memory.bm25_retriever import InMemoryBM25Retriever
 from haystack.components.retrievers.in_memory.embedding_retriever import InMemoryEmbeddingRetriever
+from haystack.components.retrievers.sentence_window_retrieval import SentenceWindowRetrieval
 from haystack.components.retrievers.sentence_window_retriever import SentenceWindowRetriever
 
-__all__ = ["FilterRetriever", "InMemoryEmbeddingRetriever", "InMemoryBM25Retriever", "SentenceWindowRetriever"]
+__all__ = [
+    "FilterRetriever",
+    "InMemoryEmbeddingRetriever",
+    "InMemoryBM25Retriever",
+    "SentenceWindowRetriever",
+    "SentenceWindowRetrieval",
+]

haystack/components/retrievers/sentence_window_retrieval.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import warnings
+
+from .sentence_window_retriever import SentenceWindowRetriever
+
+
+class SentenceWindowRetrieval(SentenceWindowRetriever):
+    """
+    This class is deprecated. Please use `SentenceWindowRetriever` instead.
+    """
+
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "The class `SentenceWindowRetrieval` is deprecated and will be removed in a future release. "
+            "Please use `SentenceWindowRetriever` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)

releasenotes/notes/deprecate-sentence-window-retrieval-9d7f8a61429a514b.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    `SentenceWindowRetrieval` is deprecated and will be removed in future. Use `SentenceWindowRetriever` instead.

test/components/retrievers/test_sentence_window_retrieval.py

@@ -0,0 +1,16 @@
+from haystack.components.retrievers.sentence_window_retrieval import SentenceWindowRetrieval
+from haystack.components.retrievers.sentence_window_retriever import SentenceWindowRetriever
+from haystack.document_stores.in_memory import InMemoryDocumentStore
+from unittest.mock import patch
+
+
+class TestSentenceWindowRetrieval:
+    def test_init_default(self):
+        retriever = SentenceWindowRetrieval(InMemoryDocumentStore())
+        assert retriever.window_size == 3
+
+    def test_init_calls_parent(self):
+        with patch.object(SentenceWindowRetriever, "__init__", return_value=None) as mock_init:
+            document_store = InMemoryDocumentStore()
+            retriever = SentenceWindowRetrieval(document_store)
+            mock_init.assert_called_once_with(document_store)