elasticsearch-haystack 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

{elasticsearch_haystack-0.2.0.dist-info → elasticsearch_haystack-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elasticsearch-haystack
-Version: 0.2.0
+Version: 0.3.0
 Summary: Haystack 2.x Document Store for ElasticSearch
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/elasticsearch#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues

{elasticsearch_haystack-0.2.0.dist-info → elasticsearch_haystack-0.3.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 haystack_integrations/components/retrievers/elasticsearch/__init__.py,sha256=cSJBsYjz_T4kK-M-auAHVUnYIcgUqqwwQe_hsF0_IG4,307
-haystack_integrations/components/retrievers/elasticsearch/bm25_retriever.py,sha256=Taq5pPDIu5lUuCgdbbZoGCMozUIoKqCVzcc085jGpNg,4277
-haystack_integrations/components/retrievers/elasticsearch/embedding_retriever.py,sha256=Y2C4Foeiqg2-bOEcc_WEyC62k96DqjnMqBllPcgCrxk,3392
+haystack_integrations/components/retrievers/elasticsearch/bm25_retriever.py,sha256=qu67WxyTjh1DbEEqg1_IcOkNl0BHtedLFjQVDC0bONE,4398
+haystack_integrations/components/retrievers/elasticsearch/embedding_retriever.py,sha256=6HhfAzOjec9R2PnjWT2hLcIWVEe6-bZuWhULu18gJCE,3513
 haystack_integrations/document_stores/elasticsearch/__init__.py,sha256=YTfu94dtVUBogbJFr1aJrKuaI6-Bw9VuHfPoyU7M8os,207
-haystack_integrations/document_stores/elasticsearch/document_store.py,sha256=SDaPCgK1B_O3G7pNa2Z71YktvgpAHDGgC_gHuzy2HTE,15416
+haystack_integrations/document_stores/elasticsearch/document_store.py,sha256=qFe9BmXaT6vNOF5EYZ8PNhC6Z1bZVzBoAZ5J2agwcZI,15586
 haystack_integrations/document_stores/elasticsearch/filters.py,sha256=L1tN7YCIDuNdhGrBQdPoqXFk37x__2-K038xZ6PRdNQ,9923
-elasticsearch_haystack-0.2.0.dist-info/METADATA,sha256=Enr2ufED5ISLsuRqZatL08Zg_Wss1x9A8uyS1eXCUsw,2105
-elasticsearch_haystack-0.2.0.dist-info/WHEEL,sha256=mRYSEL3Ih6g5a_CVMIcwiF__0Ae4_gLYh01YFNwiq1k,87
-elasticsearch_haystack-0.2.0.dist-info/licenses/LICENSE,sha256=_M2kulivnaiTHiW-5CRlZrPmH47tt04pBgAgeDvfYi4,11342
-elasticsearch_haystack-0.2.0.dist-info/RECORD,,
+elasticsearch_haystack-0.3.0.dist-info/METADATA,sha256=P5KpaBuMowYSFu5pf88YxHfyZI0oHJZ-4Z5-tdj7AwE,2105
+elasticsearch_haystack-0.3.0.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
+elasticsearch_haystack-0.3.0.dist-info/licenses/LICENSE,sha256=_M2kulivnaiTHiW-5CRlZrPmH47tt04pBgAgeDvfYi4,11342
+elasticsearch_haystack-0.3.0.dist-info/RECORD,,

{elasticsearch_haystack-0.2.0.dist-info → elasticsearch_haystack-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.21.0
+Generator: hatchling 1.21.1
 Root-Is-Purelib: true
 Tag: py3-none-any

haystack_integrations/components/retrievers/elasticsearch/bm25_retriever.py

@@ -89,17 +89,18 @@ class ElasticsearchBM25Retriever:
         return default_from_dict(cls, data)
 
     @component.output_types(documents=List[Document])
-    def run(self, query: str, top_k: Optional[int] = None):
+    def run(self, query: str, filters: Optional[Dict[str, Any]] = None, top_k: Optional[int] = None):
         """
         Retrieve documents using the BM25 keyword-based algorithm.
 
         :param query: String to search in Documents' text.
+        :param filters: Filters applied to the retrieved Documents.
         :param top_k: Maximum number of Documents to return.
         :return: List of Documents that match the query.
         """
         docs = self._document_store._bm25_retrieval(
             query=query,
-            filters=self._filters,
+            filters=filters or self._filters,
             fuzziness=self._fuzziness,
             top_k=top_k or self._top_k,
             scale_score=self._scale_score,

haystack_integrations/components/retrievers/elasticsearch/embedding_retriever.py

@@ -63,17 +63,18 @@ class ElasticsearchEmbeddingRetriever:
         return default_from_dict(cls, data)
 
     @component.output_types(documents=List[Document])
-    def run(self, query_embedding: List[float], top_k: Optional[int] = None):
+    def run(self, query_embedding: List[float], filters: Optional[Dict[str, Any]] = None, top_k: Optional[int] = None):
         """
         Retrieve documents using a vector similarity metric.
 
         :param query_embedding: Embedding of the query.
+        :param filters: Filters applied to the retrieved Documents.
         :param top_k: Maximum number of Documents to return.
         :return: List of Documents similar to `query_embedding`.
         """
         docs = self._document_store._embedding_retrieval(
             query_embedding=query_embedding,
-            filters=self._filters,
+            filters=filters or self._filters,
             top_k=top_k or self._top_k,
             num_candidates=self._num_candidates,
         )

haystack_integrations/document_stores/elasticsearch/document_store.py

@@ -13,6 +13,7 @@ from haystack.dataclasses import Document
 from haystack.document_stores.errors import DocumentStoreError, DuplicateDocumentError
 from haystack.document_stores.types import DuplicatePolicy
 from haystack.utils.filters import convert
+from haystack.version import __version__ as haystack_version
 
 from elasticsearch import Elasticsearch, helpers  # type: ignore[import-not-found]
 
@@ -90,7 +91,11 @@ class ElasticsearchDocumentStore:
         :param **kwargs: Optional arguments that ``Elasticsearch`` takes.
         """
         self._hosts = hosts
-        self._client = Elasticsearch(hosts, **kwargs)
+        self._client = Elasticsearch(
+            hosts,
+            headers={"user-agent": f"haystack-py-ds/{haystack_version}"},
+            **kwargs,
+        )
         self._index = index
         self._embedding_similarity_function = embedding_similarity_function
         self._kwargs = kwargs