Merge branch 'main' into dependabot/pip/pylint-2.15.10

Author: alallema

.code-samples.meilisearch.yaml

@@ -506,6 +506,10 @@ getting_started_configure_settings: |-
 getting_started_communicating_with_a_protected_instance: |-
   client = Client('http://localhost:7700', 'apiKey')
   client.index('movies').search()
+getting_started_faceting: |-
+  client.index('movies').update_faceting_settings({'maxValuesPerFacet': 2})
+getting_started_pagination: |-
+  client.index('movies').update_pagination_settings({'maxTotalHits': 500})
 faceted_search_update_settings_1: |-
   client.index('movies').update_filterable_attributes([
       'director',
@@ -665,6 +669,11 @@ settings_guide_pagination_1: |-
       'maxTotalHits': 50
     }
   })
+synonyms_guide_1: |-
+  client.index('movies').update_synonyms({
+    'great': ['fantastic'],
+    'fantastic': ['great']
+  })
 async_guide_filter_by_date_1: |-
   client.get_tasks({'afterEnqueuedAt': '2020-10-11T11:49:53.000Z'})
 async_guide_multiple_filters_1: |-
@@ -685,3 +694,21 @@ async_guide_filter_by_index_uids_1: |-
   client.get_tasks({'indexUids': ['movies']})
 async_guide_canceled_by_1: |-
   client.get_tasks({'canceledBy': ['9', '15']})
+date_guide_index_1: |-
+  import json
+
+  json_file = open('./games.json')
+  games = json.load(json_file)
+  client.index('games').add_documents(games)
+date_guide_filterable_attributes_1: |-
+  client.index('games').update_filterable_attributes(['release_timestamp'])
+date_guide_filter_1: |-
+  client.index('games').search('', {
+    'filter': 'release_timestamp >= 1514761200 AND release_timestamp < 1672527600'
+  })
+date_guide_sortable_attributes_1: |-
+  client.index('games').update_sortable_attributes(['release_timestamp'])
+date_guide_sort_1: |-
+  client.index('games').search('', {
+    'sort': ['release_timestamp:desc']
+  })

meilisearch/index.py

@@ -592,6 +592,33 @@ def update_documents_json(
         """
         return self.update_documents_raw(str_documents, primary_key, "application/json")
 
+    def update_documents_csv(
+        self,
+        str_documents: str,
+        primary_key: Optional[str] = None,
+    ) -> TaskInfo:
+        """Update documents as a csv string in the index.
+
+        Parameters
+        ----------
+        str_documents:
+            String of document from a CSV 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, "text/csv")
+
     def update_documents_raw(
         self,
         str_documents: str,

meilisearch/models/task.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
-from typing import Any, Dict, List, Union
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
 
 from camel_converter.pydantic_base import CamelBase
 
@@ -10,21 +11,21 @@ class Task(CamelBase):
     index_uid: Union[str, None]
     status: str
     type: str
-    details: Dict[str, Any]
+    details: Union[Dict[str, Any], None]
     error: Union[Dict[str, Any], None]
     canceled_by: Union[int, None]
-    duration: str
-    enqueued_at: str
-    started_at: str
-    finished_at: str
+    duration: Optional[str]
+    enqueued_at: datetime
+    started_at: Optional[datetime]
+    finished_at: Optional[datetime]
 
 
 class TaskInfo(CamelBase):
     task_uid: int
     index_uid: Union[str, None]
     status: str
     type: str
-    enqueued_at: str
+    enqueued_at: datetime
 
 
 class TaskResults:

tests/index/test_index_document_meilisearch.py

@@ -197,6 +197,17 @@ def test_add_documents_csv(empty_index, songs_csv):
     assert index.get_primary_key() == "id"
 
 
+def test_update_documents_csv(index_with_documents, songs_csv):
+    """Tests updating a single document with csv string."""
+    index = index_with_documents()
+    response = index.update_documents_csv(songs_csv)
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid is not None
+    task = index.wait_for_task(response.task_uid)
+    assert task.status == "succeeded"
+    assert index.get_primary_key() == "id"
+
+
 def test_add_documents_json(empty_index, small_movies_json_file):
     """Tests adding new documents to a clean index."""
     index = empty_index()