Update Documents with Functions

Author: MuddyHope

meilisearch/client.py

@@ -248,6 +248,29 @@ def multi_search(
             body={"queries": queries, "federation": federation},
         )
 
+    def update_documents_by_function(self, index_uid: str, queries: Dict[str, List[Dict[str, Any]]]) -> Dict[str, Any]:
+        """Update Documents by function
+        Parameters
+        ----------
+        index_uid:
+            The index_uid where you want to update documents of.
+        queries:
+            List of dictionaries containing functions with or without filters that you want to use to update documents.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        return self.http.post(path=f"{self.config.paths.index}/{index_uid}/{self.config.paths.document}/{self.config.paths.edit}",
+                              body=dict(queries))
+
     def get_all_stats(self) -> Dict[str, Any]:
         """Get all stats of Meilisearch
 

meilisearch/config.py

@@ -44,6 +44,7 @@ class Paths:
         search_cutoff_ms = "search-cutoff-ms"
         proximity_precision = "proximity-precision"
         localized_attributes = "localized-attributes"
+        edit = "edit"
 
     def __init__(
         self,

tests/client/test_client_update_document_by_functions.py

@@ -0,0 +1,15 @@
+import pytest
+
+from meilisearch.errors import MeilisearchApiError
+from tests.common import INDEX_UID
+from tests.conftest import index_with_documents
+
+def test_basic_multi_search(client, index_with_documents):
+    """Delete the document with id."""
+    index_with_documents()
+    response = client.update_documents_by_function(
+        "indexA", {"function": "if doc.id == \"522681\" {doc = () } else {doc.title = `* ${doc.title} *`}"}
+    )
+
+    assert isinstance(response, dict)
+    assert response['indexUid'] == INDEX_UID