From 1f3cb68d9f211237f4772157a85ff70b04549f49 Mon Sep 17 00:00:00 2001 From: "David S. Batista" Date: Tue, 3 Sep 2024 10:57:11 +0200 Subject: [PATCH] fix: `meta` prefix missing in the sentence window retriever filters (#8309) * initial import * listing supported doc stores in docstring * adding release notes --- .../retrievers/sentence_window_retriever.py | 13 ++++++++++--- ...ce-window-retriever-filter-b7b136eedf6e8488.yaml | 4 ++++ 2 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 releasenotes/notes/fix-sentence-window-retriever-filter-b7b136eedf6e8488.yaml diff --git a/haystack/components/retrievers/sentence_window_retriever.py b/haystack/components/retrievers/sentence_window_retriever.py index 36cc5c23f..7b7a7d859 100644 --- a/haystack/components/retrievers/sentence_window_retriever.py +++ b/haystack/components/retrievers/sentence_window_retriever.py @@ -24,6 +24,13 @@ class SentenceWindowRetriever: EmbeddingRetriever. First, use a Retriever to find documents based on a query and then use SentenceWindowRetriever to get the surrounding documents for context. + The SentenceWindowRetriever is compatible with the following DocumentStores: + - (Astra)[https://docs.haystack.deepset.ai/docs/astradocumentstore] + - (Elasticsearch)[https://docs.haystack.deepset.ai/docs/elasticsearch-document-store] + - (OpenSearch)[https://docs.haystack.deepset.ai/docs/opensearch-document-store] + - (Pgvector)[https://docs.haystack.deepset.ai/docs/pgvectordocumentstore] + - (Pinecone)[https://docs.haystack.deepset.ai/docs/pinecone-document-store] + - (Qdrant)[https://docs.haystack.deepset.ai/docs/qdrant-document-store] ### Usage example @@ -172,9 +179,9 @@ class SentenceWindowRetriever: { "operator": "AND", "conditions": [ - {"field": "source_id", "operator": "==", "value": source_id}, - {"field": "split_id", "operator": ">=", "value": min_before}, - {"field": "split_id", "operator": "<=", "value": max_after}, + {"field": "meta.source_id", "operator": "==", "value": source_id}, + {"field": "meta.split_id", "operator": ">=", "value": min_before}, + {"field": "meta.split_id", "operator": "<=", "value": max_after}, ], } ) diff --git a/releasenotes/notes/fix-sentence-window-retriever-filter-b7b136eedf6e8488.yaml b/releasenotes/notes/fix-sentence-window-retriever-filter-b7b136eedf6e8488.yaml new file mode 100644 index 000000000..3e29f416d --- /dev/null +++ b/releasenotes/notes/fix-sentence-window-retriever-filter-b7b136eedf6e8488.yaml @@ -0,0 +1,4 @@ +--- +fixes: + - | + Fixing the filters in the `SentenceWindowRetriever` allowing now support for 3 more DocumentStores: Astra, PGVector, Qdrant