Merge #560

560: New ndjson handlers r=alallema a=Azanul

# Pull Request

## Related issue
Fixes #347 

## What does this PR do?
- Adds handler for updating documents with raw string
- Adds handler for updating documents with ndjson string.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Azanul <[email protected]>
Co-authored-by: Azanul Haque <[email protected]>

Author: bors[bot]

meilisearch/_httprequests.py

@@ -78,7 +78,7 @@ def patch(
     def put(
         self,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | None = None,
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
         content_type: str | None = 'application/json',
     ) -> Any:
         return self.send_request(requests.put, path, body, content_type)

meilisearch/index.py

@@ -535,6 +535,65 @@ def update_documents(
         response = self.http.put(url, documents)
         return TaskInfo(**response)
 
+    def update_documents_ndjson(
+        self,
+        str_documents: str,
+        primary_key: str | None = None,
+    ) -> TaskInfo:
+        """Update documents as a ndjson string in the index.
+
+        Parameters
+        ----------
+        str_documents:
+            String of document from a NDJSON 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/x-ndjson')
+
+    def update_documents_raw(
+        self,
+        str_documents: str,
+        primary_key: str | None = None,
+        content_type: str | None = None,
+    ) -> TaskInfo:
+        """Update documents as a string in the index.
+
+        Parameters
+        ----------
+        str_documents:
+            String of document.
+        primary_key (optional):
+            The primary-key used in index. Ignored if already set up.
+        type:
+            The type of document. Type available: 'csv', 'json', 'jsonl'
+
+        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
+        """
+        url = self._build_url(primary_key)
+        response = self.http.put(url, str_documents, content_type)
+        return TaskInfo(**response)
+
     def update_documents_in_batches(
         self,
         documents: list[dict[str, Any]],

tests/index/test_index_document_meilisearch.py

@@ -193,3 +193,13 @@ def test_add_documents_ndjson(empty_index, songs_ndjson):
     task = index.wait_for_task(response.task_uid)
     assert task.status == 'succeeded'
     assert index.get_primary_key() == 'id'
+
+def test_update_documents_ndjson(index_with_documents, songs_ndjson):
+    """Tests updating a single document with ndjson string."""
+    index = index_with_documents()
+    response = index.update_documents_ndjson(songs_ndjson)
+    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'