From d26d4201fc85b498c8eb57b8bb32a85524689448 Mon Sep 17 00:00:00 2001
From: tstadel <60758086+tstadel@users.noreply.github.com>
Date: Fri, 4 Aug 2023 11:13:05 +0200
Subject: [PATCH] feat: support search_fields in DeepsetCloudDocumentStore
 (#5455)

* feat: support search_fields in DeepsetCloudDocumentStore

* add reno file

* make search_fields plain init arg

* Update lg

* Update releasenotes/notes/deepset-cloud-document-store-search-fields-40b2322466f808a3.yaml

* Update haystack/document_stores/deepsetcloud.py

---------

Co-authored-by: agnieszka-m <amarzec13@gmail.com>
---
 haystack/document_stores/deepsetcloud.py                      | 3 +++
 ...t-cloud-document-store-search-fields-40b2322466f808a3.yaml | 4 ++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/notes/deepset-cloud-document-store-search-fields-40b2322466f808a3.yaml

diff --git a/haystack/document_stores/deepsetcloud.py b/haystack/document_stores/deepsetcloud.py
index 1a9dbec83..a9c8caccc 100644
--- a/haystack/document_stores/deepsetcloud.py
+++ b/haystack/document_stores/deepsetcloud.py
@@ -47,6 +47,7 @@ class DeepsetCloudDocumentStore(KeywordDocumentStore):
         label_index: str = "default",
         embedding_dim: int = 768,
         use_prefiltering: bool = False,
+        search_fields: Union[str, list] = "content",
     ):
         """
         A DocumentStore facade enabling you to interact with the documents stored in deepset Cloud.
@@ -90,6 +91,7 @@ class DeepsetCloudDocumentStore(KeywordDocumentStore):
         :param use_prefiltering: By default, DeepsetCloudDocumentStore uses post-filtering when querying with filters.
                                  To use pre-filtering instead, set this parameter to `True`. Note that pre-filtering
                                  comes at the cost of higher latency.
+        :param search_fields: Names of fields BM25Retriever uses to find matches to the incoming query in the documents, for example: ["content", "title"].
         """
         self.index = index
         self.label_index = label_index
@@ -98,6 +100,7 @@ class DeepsetCloudDocumentStore(KeywordDocumentStore):
         self.return_embedding = return_embedding
         self.embedding_dim = embedding_dim
         self.use_prefiltering = use_prefiltering
+        self.search_fields = search_fields
         self.client = DeepsetCloud.get_index_client(
             api_key=api_key, api_endpoint=api_endpoint, workspace=workspace, index=index
         )
diff --git a/releasenotes/notes/deepset-cloud-document-store-search-fields-40b2322466f808a3.yaml b/releasenotes/notes/deepset-cloud-document-store-search-fields-40b2322466f808a3.yaml
new file mode 100644
index 000000000..643678eb5
--- /dev/null
+++ b/releasenotes/notes/deepset-cloud-document-store-search-fields-40b2322466f808a3.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    `DeepsetCloudDocumentStore` supports searching multiple fields in sparse queries. This enables you to search meta fields as well when using `BM25Retriever`. For example set `search_fields=["content", "title"]` to search the `title` meta field along with the document `content`.