New json handlers

meilisearch/index.py

@@ -562,6 +562,33 @@ def update_documents_ndjson(
         """
         return self.update_documents_raw(str_documents, primary_key, 'application/x-ndjson')
 
+    def update_documents_json(
+        self,
+        str_documents: str,
+        primary_key: str | None = None,
+    ) -> TaskInfo:
+        """Update documents as a json string in the index.
+
+        Parameters
+        ----------
+        str_documents:
+            String of document from a JSON file.
+        primary_key (optional):
+            The primary-key used in index. Ignored if already set up
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        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.update_documents_raw(str_documents, primary_key, 'application/json')
+
     def update_documents_raw(
         self,
         str_documents: str,
@@ -1478,3 +1505,4 @@ def _build_url(
             return f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}'
         primary_key = parse.urlencode({'primaryKey': primary_key})
         return f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}?{primary_key}'
+

tests/index/test_index_document_meilisearch.py

@@ -184,6 +184,16 @@ def test_add_documents_json(empty_index, small_movies_json_file):
     assert task.status == 'succeeded'
     assert index.get_primary_key() == 'id'
 
+def test_update_documents_json(index_with_documents, small_movies_json_file):
+    """Tests updating a single document with json string."""
+    index = index_with_documents()
+    response = index.update_documents_json(small_movies_json_file)
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid != None
+    task = index.wait_for_task(response.task_uid)
+    assert task.status == 'succeeded'
+    assert index.get_primary_key() == 'id'
+
 def test_add_documents_ndjson(empty_index, songs_ndjson):
     """Tests adding new documents to a clean index."""
     index = empty_index()