meilisearch-python-sdk 5.0.1__py3-none-any.whl → 5.1.0__py3-none-any.whl

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "5.0.1"
+VERSION = "5.1.0"

meilisearch_python_sdk/index.py

@@ -470,6 +470,25 @@ class AsyncIndex(_BaseIndex):
 
         return plugins
 
+    async def compact(self) -> TaskInfo:
+        """Appends a new task to the queue to compact the database.
+
+        This defragments the LMDB database potentially speeds up indexing and searching.
+        NOTE: This is only available in Meilisearch v1.23.0+
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     index.compact()
+        """
+        response = await self._http_requests.post(f"{self._base_url_with_uid}/compact")
+        return TaskInfo(**response.json())
+
     async def delete(self) -> TaskInfo:
         """Deletes the index.
 
@@ -4921,6 +4940,25 @@ class Index(_BaseIndex):
 
         return plugins
 
+    def compact(self) -> TaskInfo:
+        """Appends a new task to the queue to compact the database.
+
+        This defragments the LMDB database potentially speeds up indexing and searching.
+        NOTE: This is only available in Meilisearch v1.23.0+
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_python_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.compact()
+        """
+        response = self._http_requests.post(f"{self._base_url_with_uid}/compact")
+        return TaskInfo(**response.json())
+
     def delete(self) -> TaskInfo:
         """Deletes the index.
 

meilisearch_python_sdk/models/search.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Annotated, Generic, Literal, TypeVar
+from typing import Generic, Literal, TypeVar
 
 from camel_converter.pydantic_base import CamelBase
 from pydantic import Field, field_validator
@@ -83,12 +83,12 @@ class SearchParams(CamelBase):
 
 
 class SearchResults(CamelBase, Generic[T]):
-    hits: Annotated[list[T], Field()]
+    hits: list[T]
     offset: int | None = None
     limit: int | None = None
     estimated_total_hits: int | None = None
     processing_time_ms: int
-    query: Annotated[str, Field()]
+    query: str
     facet_distribution: JsonDict | None = None
     total_pages: int | None = None
     total_hits: int | None = None
@@ -103,7 +103,7 @@ class SearchResultsWithUID(SearchResults, Generic[T]):
 
 
 class SearchResultsFederated(CamelBase, Generic[T]):
-    hits: Annotated[list[T], Field()]
+    hits: list[T]
     offset: int | None = None
     limit: int | None = None
     estimated_total_hits: int | None = None
@@ -118,7 +118,7 @@ class SearchResultsFederated(CamelBase, Generic[T]):
 
 
 class SimilarSearchResults(CamelBase, Generic[T]):
-    hits: Annotated[list[T], Field()]
+    hits: list[T]
     id: str
     processing_time_ms: int
     limit: int | None = None

{meilisearch_python_sdk-5.0.1.dist-info → meilisearch_python_sdk-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 5.0.1
+Version: 5.1.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk

{meilisearch_python_sdk-5.0.1.dist-info → meilisearch_python_sdk-5.1.0.dist-info}/RECORD

@@ -4,10 +4,10 @@ meilisearch_python_sdk/_client.py,sha256=HA0FdvsVGAHhUt6mVB-sK03bIzVivN7ProcimeQ
 meilisearch_python_sdk/_http_requests.py,sha256=9NMTKrJDFpdWZKPLNGlRQ54EtqhPXlhov3EoeR3VrwU,6773
 meilisearch_python_sdk/_task.py,sha256=QgVcqMlZdURRS_oYpB_bTBa5dvT3Sp_-O0-s6TqAxHk,12485
 meilisearch_python_sdk/_utils.py,sha256=NoCDxJPhjABeuSxFTNCih585UDWdXEUBD_FvdgtScQw,1539
-meilisearch_python_sdk/_version.py,sha256=354Qfq6Bc3t68nIwfByr6MOfHpz32Ic1eBJh_ZZpdXs,18
+meilisearch_python_sdk/_version.py,sha256=n65_AMV9xWnAAWXLUYz_Z2Q1OdGU8iqZ-dRAydz390w,18
 meilisearch_python_sdk/decorators.py,sha256=xtG-ptJkVbPlbC1hJQ6dPgPYqU27VluGwL_CTJuIq3I,8701
 meilisearch_python_sdk/errors.py,sha256=RNNHXtXLBiCVZaLM2MeKKs9RbRuE-SLRttiPeVAEXgA,2133
-meilisearch_python_sdk/index.py,sha256=XxUgfOBUo6ClayI94I0AljGW4obam5hBIHeAz7d8f4Q,349474
+meilisearch_python_sdk/index.py,sha256=CI4K_G997MmMnGR3U-oe3OzvROpzMbibfVHFZjHwKkA,351125
 meilisearch_python_sdk/json_handler.py,sha256=c1rGKzYlE0dGfLygQjPqVUNfQkN1JvafBGmIx31JW8g,2044
 meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -18,12 +18,12 @@ meilisearch_python_sdk/models/client.py,sha256=nefi6ViSaSd_mtopRAhM9tzzepwChFJUk
 meilisearch_python_sdk/models/documents.py,sha256=eT3FHrPND-g2IzNRyOHQApTTJ1WbFcGlqgxZ6aKrRgI,247
 meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
 meilisearch_python_sdk/models/index.py,sha256=WLQOi3_HChko134FkRU1H3_cJjhHJCFclcx4oDBlqHU,1228
-meilisearch_python_sdk/models/search.py,sha256=vFiHaAlsmJWrlLqg5e1meVAKf6v78l9yFn2GFlc9fDk,3672
+meilisearch_python_sdk/models/search.py,sha256=U3ph1GW9Xkbw33pIlGDa7rlTGsdvqahjRJjPxUou8n8,3581
 meilisearch_python_sdk/models/settings.py,sha256=eh0xnro4D_sj8ck2nifa3tBdf2_7RcZlAY_zQhfsY0s,5730
 meilisearch_python_sdk/models/task.py,sha256=JVYF46ylD-XwqVVNq2offhLOkljaGxPyRVuF6PwLOBU,2174
 meilisearch_python_sdk/models/version.py,sha256=ISU-ZHgpXLBFDuMpWWfKdVo9Dq1HcD7s6HFnCiGTF8Y,184
 meilisearch_python_sdk/models/webhook.py,sha256=zSkEJJdEflinW3_seJTLQ_ZWs4w-pjTD3SS1ZawC32k,455
-meilisearch_python_sdk-5.0.1.dist-info/METADATA,sha256=WhyCpYGjM32iaCe7sPWpReM6P8rj3When78KRnr4rZg,9699
-meilisearch_python_sdk-5.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-5.0.1.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-5.0.1.dist-info/RECORD,,
+meilisearch_python_sdk-5.1.0.dist-info/METADATA,sha256=WJgG0U-GzXz7ubBm6oY62PtSdbFlHBrwdgBjFfdTolg,9699
+meilisearch_python_sdk-5.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-5.1.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-5.1.0.dist-info/RECORD,,