Merge branch 'main' into bump-meilisearch-v1.13

Author: Strift

.code-samples.meilisearch.yaml

@@ -742,3 +742,14 @@ update_localized_attribute_settings_1: |-
   ])
 reset_localized_attribute_settings_1: |-
   client.index('INDEX_NAME').reset_localized_attributes()
+multi_search_federated_1: |-
+  client.multi_search(
+    [{"indexUid": "movies", "q": "batman"}, {"indexUid": "comics", "q": "batman"}],
+    {}
+  )
+get_all_batches_1: |-
+  client.get_batches()
+get_batch_1: |-
+  client.get_batch(BATCH_UID)
+get_similar_post_1: |-
+  client.index("INDEX_NAME").get_similar_documents({"id": "TARGET_DOCUMENT_ID", "embedder": "default"})

Pipfile.lock

@@ -16,7 +16,7 @@
 from meilisearch.errors import MeilisearchError
 from meilisearch.index import Index
 from meilisearch.models.key import Key, KeysResults
-from meilisearch.models.task import Task, TaskInfo, TaskResults
+from meilisearch.models.task import Batch, BatchResults, Task, TaskInfo, TaskResults
 from meilisearch.task import TaskHandler
 
 
@@ -611,6 +611,46 @@ def wait_for_task(
         """
         return self.task_handler.wait_for_task(uid, timeout_in_ms, interval_in_ms)
 
+    def get_batches(self, parameters: Optional[MutableMapping[str, Any]] = None) -> BatchResults:
+        """Get all batches.
+
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get batches route: https://www.meilisearch.com/docs/reference/api/batches#get-batches.
+
+        Returns
+        -------
+        batch:
+            BatchResult instance containing limit, from, next and results containing a list of all batches.
+
+        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.task_handler.get_batches(parameters=parameters)
+
+    def get_batch(self, uid: int) -> Batch:
+        """Get one tasks batch.
+
+        Parameters
+        ----------
+        uid:
+            Identifier of the batch.
+
+        Returns
+        -------
+        batch:
+            Batch instance containing information about the progress of the asynchronous batch.
+
+        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.task_handler.get_batch(uid)
+
     def generate_tenant_token(
         self,
         api_key_uid: str,

meilisearch/client.py

@@ -14,11 +14,13 @@ class Paths:
         version = "version"
         index = "indexes"
         task = "tasks"
+        batch = "batches"
         stat = "stats"
         search = "search"
         facet_search = "facet-search"
         multi_search = "multi-search"
         document = "documents"
+        similar = "similar"
         setting = "settings"
         ranking_rules = "ranking-rules"
         distinct_attribute = "distinct-attribute"

meilisearch/config.py

@@ -401,6 +401,30 @@ def get_documents(
         )
         return DocumentsResults(response)
 
+    def get_similar_documents(self, parameters: Mapping[str, Any]) -> Dict[str, Any]:
+        """Get the documents similar to a document.
+
+        Parameters
+        ----------
+        parameters:
+            parameters accepted by the get similar documents route: https://www.meilisearch.com/docs/reference/api/similar#body
+            "id" and "embedder" are required.
+
+        Returns
+        -------
+        results:
+            Dictionary with hits, offset, limit, processingTimeMs, and id
+
+        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(
+            f"{self.config.paths.index}/{self.uid}/{self.config.paths.similar}",
+            body=parameters,
+        )
+
     def add_documents(
         self,
         documents: Sequence[Mapping[str, Any]],

meilisearch/index.py

@@ -113,3 +113,46 @@ def __init__(self, resp: Dict[str, Any]) -> None:
         self.total: int = resp["total"]
         self.from_: int = resp["from"]
         self.next_: int = resp["next"]
+
+
+class Batch(CamelBase):
+    uid: int
+    details: Optional[Dict[str, Any]] = None
+    stats: Optional[Dict[str, Union[int, Dict[str, Any]]]] = None
+    duration: Optional[str] = None
+    started_at: Optional[datetime] = None
+    finished_at: Optional[datetime] = None
+    progress: Optional[Dict[str, Union[float, List[Dict[str, Any]]]]] = None
+
+    if is_pydantic_2():
+
+        @pydantic.field_validator("started_at", mode="before")  # type: ignore[attr-defined]
+        @classmethod
+        def validate_started_at(cls, v: str) -> Optional[datetime]:  # pylint: disable=invalid-name
+            return iso_to_date_time(v)
+
+        @pydantic.field_validator("finished_at", mode="before")  # type: ignore[attr-defined]
+        @classmethod
+        def validate_finished_at(cls, v: str) -> Optional[datetime]:  # pylint: disable=invalid-name
+            return iso_to_date_time(v)
+
+    else:  # pragma: no cover
+
+        @pydantic.validator("started_at", pre=True)
+        @classmethod
+        def validate_started_at(cls, v: str) -> Optional[datetime]:  # pylint: disable=invalid-name
+            return iso_to_date_time(v)
+
+        @pydantic.validator("finished_at", pre=True)
+        @classmethod
+        def validate_finished_at(cls, v: str) -> Optional[datetime]:  # pylint: disable=invalid-name
+            return iso_to_date_time(v)
+
+
+class BatchResults(CamelBase):
+    results: List[Batch]
+    total: int
+    limit: int
+    from_: int
+    # None means last page
+    next_: Optional[int]

meilisearch/models/task.py

@@ -8,7 +8,7 @@
 from meilisearch._httprequests import HttpRequests
 from meilisearch.config import Config
 from meilisearch.errors import MeilisearchTimeoutError
-from meilisearch.models.task import Task, TaskInfo, TaskResults
+from meilisearch.models.task import Batch, BatchResults, Task, TaskInfo, TaskResults
 
 
 class TaskHandler:
@@ -27,6 +27,53 @@ def __init__(self, config: Config):
         self.config = config
         self.http = HttpRequests(config)
 
+    def get_batches(self, parameters: Optional[MutableMapping[str, Any]] = None) -> BatchResults:
+        """Get all task batches.
+
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get batches route: https://www.meilisearch.com/docs/reference/api/batches#get-batches.
+
+        Returns
+        -------
+        batch:
+            BatchResults instance contining limit, from, next and results containing a list of all batches.
+
+        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
+        """
+        if parameters is None:
+            parameters = {}
+        for param in parameters:
+            if isinstance(parameters[param], (list, tuple)):
+                parameters[param] = ",".join(parameters[param])
+        batches = self.http.get(f"{self.config.paths.batch}?{parse.urlencode(parameters)}")
+        return BatchResults(**batches)
+
+    def get_batch(self, uid: int) -> Batch:
+        """Get one tasks batch.
+
+        Parameters
+        ----------
+        uid:
+            Identifier of the batch.
+
+        Returns
+        -------
+        task:
+            Batch instance containing information about the progress of the asynchronous batch.
+
+        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
+        """
+        batch = self.http.get(f"{self.config.paths.batch}/{uid}")
+        return Batch(**batch)
+
     def get_tasks(self, parameters: Optional[MutableMapping[str, Any]] = None) -> TaskResults:
         """Get all tasks.
 

meilisearch/task.py

@@ -165,3 +165,27 @@ def test_get_tasks_in_reverse(client):
     reverse_tasks = client.get_tasks({"reverse": "true"})
 
     assert reverse_tasks.results[0] == tasks.results[-1]
+
+
+def test_get_batches_default(client):
+    """Tests getting the batches."""
+    batches = client.get_batches()
+    assert len(batches.results) >= 1
+
+
+@pytest.mark.usefixtures("create_tasks")
+def test_get_batches_with_parameters(client):
+    """Tests getting batches with a parameter (empty or otherwise)."""
+    rev_batches = client.get_batches({"reverse": "true"})
+    batches = client.get_batches({})
+
+    assert len(batches.results) > 1
+    assert rev_batches.results[0].uid == batches.results[-1].uid
+
+
+def test_get_batch(client):
+    """Tests getting the details of a batch."""
+    batches = client.get_batches({"limit": 1})
+    uid = batches.results[0].uid
+    batch = client.get_batch(uid)
+    assert batch.uid == uid

tests/client/test_client_task_meilisearch.py

@@ -266,6 +266,32 @@ def test_get_documents_filter_with_fields(index_with_documents):
     assert next(iter(genres)) == "action"
 
 
+@pytest.mark.usefixtures("enable_vector_search")
+def test_get_similar_documents(empty_index):
+    index = empty_index()
+    index.update_embedders({"manual": {"source": "userProvided", "dimensions": 3}})
+
+    hp3 = {
+        "id": 1,
+        "title": "Harry Potter and the Prisoner of Azkaban",
+        "_vectors": {"manual": [0.8, 0.8, 0.8]},
+    }
+    hp4 = {
+        "id": 2,
+        "title": "Harry Potter and the Goblet of Fire",
+        "_vectors": {"manual": [0.7, 0.7, 0.9]},
+    }
+    lotr = {"id": 3, "title": "The Lord of the Rings", "_vectors": {"manual": [0.6, 0.5, 0.2]}}
+
+    addition = index.add_documents([hp3, hp4, lotr])
+    index.wait_for_task(addition.task_uid)
+
+    similars = index.get_similar_documents({"id": hp4["id"], "embedder": "manual"})
+
+    assert similars["hits"][0]["id"] == hp3["id"]
+    assert similars["hits"][1]["id"] == lotr["id"]
+
+
 def test_update_documents(index_with_documents, small_movies):
     """Tests updating a single document and a set of documents."""
     index = index_with_documents()