Add multiple searches

Author: alallema

meilisearch/client.py

@@ -1,3 +1,5 @@
+# pylint: disable=too-many-public-methods
+
 from __future__ import annotations
 
 import base64
@@ -205,6 +207,31 @@ def index(self, uid: str) -> Index:
             return Index(self.config, uid=uid)
         raise ValueError("The index UID should not be None")
 
+
+    def multi_search(self, queries: Dict[str, Any]) -> Dict[str, Any]:
+        """Multi Search in the index.
+
+        Parameters
+        ----------
+        queries:
+            Dictionary containing the query searched word(s) and the query parameters
+            https://docs.meilisearch.com/reference/api/search.html#search-in-an-index
+
+        Returns
+        -------
+        results:
+            Dictionary of results for each index with hits, offset, limit, processingTime and initial query
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.post(
+            f"{self.config.paths.multi_search}",
+            body={'queries': queries},
+        )
+
     def get_all_stats(self) -> Dict[str, Any]:
         """Get all stats of Meilisearch
 

meilisearch/config.py

@@ -16,6 +16,7 @@ class Paths:
         task = "tasks"
         stat = "stats"
         search = "search"
+        multi_search = "multi-search"
         document = "documents"
         setting = "settings"
         ranking_rules = "ranking-rules"

tests/client/test_client_multi_search_meilisearch.py

@@ -0,0 +1,34 @@
+import pytest
+
+def test_basic_multi_search(client, empty_index):
+    """Tests multi-search on two indexes."""
+    empty_index("indexA")
+    empty_index("indexB")
+    response = client.multi_search([
+        { 'indexUid': 'indexA', 'q': ''},
+        { 'indexUid': 'indexB', 'q': ''}
+    ])
+
+    assert isinstance(response, dict)
+    assert response["results"][0]["indexUid"] == "indexA"
+    assert response["results"][1]["indexUid"] == "indexB"
+    assert response["results"][0]["limit"] == 20
+    assert response["results"][1]["limit"] == 20
+
+def test_multi_search_one_index(client, empty_index):
+    """Tests multi-search on a simple query."""
+    empty_index("indexA")
+    response = client.multi_search([
+        { 'indexUid': 'indexA', 'q': ''}
+    ])
+
+    assert isinstance(response, dict)
+    assert response["results"][0]["indexUid"] == "indexA"
+    assert response["results"][0]["limit"] == 20
+
+def test_multi_search_on_no_index(client):
+    """Tests multi-search on a non existing index."""
+    with pytest.raises(Exception):
+        client.multi_search([
+        { 'indexUid': 'indexDoesNotExist', 'q': ''}
+    ])