meilisearch-python-sdk 2.7.0__py3-none-any.whl → 2.9.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -194,6 +194,7 @@ class AsyncClient(BaseClient):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
     ) -> AsyncIndex:
         """Creates a new index.
@@ -210,6 +211,9 @@ class AsyncClient(BaseClient):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -228,7 +232,13 @@ class AsyncClient(BaseClient):
             >>>     index = await client.create_index("movies")
         """
         return await AsyncIndex.create(
-            self.http_client, uid, primary_key, settings=settings, wait=wait, plugins=plugins
+            self.http_client,
+            uid,
+            primary_key,
+            settings=settings,
+            wait=wait,
+            timeout_in_ms=timeout_in_ms,
+            plugins=plugins,
         )
 
     async def create_snapshot(self) -> TaskInfo:
@@ -470,6 +480,7 @@ class AsyncClient(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
@@ -625,6 +636,7 @@ class AsyncClient(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.post(
                 url,
@@ -870,14 +882,14 @@ class AsyncClient(BaseClient):
 
         Args:
 
-            uids: A list of task UIDs to cancel.
-            index_uids: A list of index UIDs for which to cancel tasks.
-            statuses: A list of statuses to cancel.
-            types: A list of types to cancel.
-            before_enqueued_at: Cancel tasks that were enqueued before the specified date time.
-            after_enqueued_at: Cancel tasks that were enqueued after the specified date time.
-            before_started_at: Cancel tasks that were started before the specified date time.
-            after_finished_at: Cancel tasks that were finished after the specified date time.
+            uids: A list of task UIDs to delete.
+            index_uids: A list of index UIDs for which to delete tasks.
+            statuses: A list of statuses to delete.
+            types: A list of types to delete.
+            before_enqueued_at: Delete tasks that were enqueued before the specified date time.
+            after_enqueued_at: Delete tasks that were enqueued after the specified date time.
+            before_started_at: Delete tasks that were started before the specified date time.
+            after_finished_at: Delete tasks that were finished after the specified date time.
 
         Returns:
 
@@ -1053,6 +1065,7 @@ class Client(BaseClient):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
     ) -> Index:
         """Creates a new index.
@@ -1069,6 +1082,9 @@ class Client(BaseClient):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -1087,7 +1103,13 @@ class Client(BaseClient):
             >>> index = client.create_index("movies")
         """
         return Index.create(
-            self.http_client, uid, primary_key, settings=settings, wait=wait, plugins=plugins
+            self.http_client,
+            uid,
+            primary_key,
+            settings=settings,
+            wait=wait,
+            timeout_in_ms=timeout_in_ms,
+            plugins=plugins,
         )
 
     def create_snapshot(self) -> TaskInfo:
@@ -1327,6 +1349,7 @@ class Client(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
@@ -1482,6 +1505,7 @@ class Client(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.post(
                 url,
@@ -1701,14 +1725,14 @@ class Client(BaseClient):
 
         Args:
 
-            uids: A list of task UIDs to cancel.
-            index_uids: A list of index UIDs for which to cancel tasks.
-            statuses: A list of statuses to cancel.
-            types: A list of types to cancel.
-            before_enqueued_at: Cancel tasks that were enqueued before the specified date time.
-            after_enqueued_at: Cancel tasks that were enqueued after the specified date time.
-            before_started_at: Cancel tasks that were started before the specified date time.
-            after_finished_at: Cancel tasks that were finished after the specified date time.
+            uids: A list of task UIDs to delete.
+            index_uids: A list of index UIDs for which to delete tasks.
+            statuses: A list of statuses to delete.
+            types: A list of types to delete.
+            before_enqueued_at: Delete tasks that were enqueued before the specified date time.
+            after_enqueued_at: Delete tasks that were enqueued after the specified date time.
+            before_started_at: Delete tasks that were started before the specified date time.
+            after_finished_at: Delete tasks that were finished after the specified date time.
 
         Returns:
 
@@ -1875,6 +1899,7 @@ def _build_update_key_payload(key: KeyUpdate) -> JsonDict:
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
         return {  # type: ignore[attr-defined]
             k: v

meilisearch_python_sdk/_http_requests.py

@@ -60,7 +60,7 @@ class AsyncHttpRequests:
                 raise MeilisearchApiError(str(err), response) from err
             else:
                 # Fail safe just in case error happens before response is created
-                raise MeilisearchError(str(err))  # pragma: no cover
+                raise MeilisearchError(str(err)) from err  # pragma: no cover
 
     async def get(self, path: str) -> Response:
         return await self._send_request(self.http_client.get, path)
@@ -132,7 +132,7 @@ class HttpRequests:
                 raise MeilisearchApiError(str(err), response) from err
             else:
                 # Fail safe just in case error happens before response is created
-                raise MeilisearchError(str(err))  # pragma: no cover
+                raise MeilisearchError(str(err)) from err  # pragma: no cover
 
     def get(self, path: str) -> Response:
         return self._send_request(self.http_client.get, path)

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "2.7.0"
+VERSION = "2.9.0"

meilisearch_python_sdk/decorators.py

@@ -68,7 +68,7 @@ def async_add_documents(
         >>> # with `ConnectionInfo`
         >>> @async_add_documents(
                 index_name="movies",
-                connection_info=ConnectionInfo(url="http://localhost:7700", api_key="masterKey",
+                connection_info=ConnectionInfo(url="http://localhost:7700", api_key="masterKey"),
             )
         >>> async def my_function() -> list[dict[str, Any]]:
         >>>     return [{"id": 1, "title": "Test 1"}, {"id": 2, "title": "Test 2"}]

meilisearch_python_sdk/index.py

@@ -6,7 +6,7 @@ from csv import DictReader
 from datetime import datetime
 from functools import cached_property, partial
 from pathlib import Path
-from typing import Any, Generator, MutableMapping, Sequence
+from typing import TYPE_CHECKING, Any, Generator, MutableMapping, Sequence
 from urllib.parse import urlencode
 from warnings import warn
 
@@ -26,9 +26,11 @@ from meilisearch_python_sdk.models.settings import (
     Faceting,
     HuggingFaceEmbedder,
     MeilisearchSettings,
+    OllamaEmbedder,
     OpenAiEmbedder,
     Pagination,
     ProximityPrecision,
+    RestEmbedder,
     TypoTolerance,
     UserProvidedEmbedder,
 )
@@ -45,7 +47,9 @@ from meilisearch_python_sdk.plugins import (
     Plugin,
     PostSearchPlugin,
 )
-from meilisearch_python_sdk.types import Filter, JsonDict, JsonMapping
+
+if TYPE_CHECKING:  # pragma: no cover
+    from meilisearch_python_sdk.types import Filter, JsonDict, JsonMapping
 
 
 class _BaseIndex:
@@ -613,6 +617,7 @@ class AsyncIndex(_BaseIndex):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
     ) -> AsyncIndex:
         """Creates a new index.
@@ -634,6 +639,9 @@ class AsyncIndex(_BaseIndex):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -659,7 +667,9 @@ class AsyncIndex(_BaseIndex):
         url = "indexes"
         http_request = AsyncHttpRequests(http_client)
         response = await http_request.post(url, payload)
-        await async_wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=None)
+        await async_wait_for_task(
+            http_client, response.json()["taskUid"], timeout_in_ms=timeout_in_ms
+        )
 
         index_response = await http_request.get(f"{url}/{uid}")
         index_dict = index_response.json()
@@ -675,7 +685,9 @@ class AsyncIndex(_BaseIndex):
         if settings:
             settings_task = await index.update_settings(settings)
             if wait:
-                await async_wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=None)
+                await async_wait_for_task(
+                    http_client, settings_task.task_uid, timeout_in_ms=timeout_in_ms
+                )
 
         return index
 
@@ -710,7 +722,7 @@ class AsyncIndex(_BaseIndex):
         limit: int = 20,
         filter: Filter | None = None,
         facets: list[str] | None = None,
-        attributes_to_retrieve: list[str] = ["*"],
+        attributes_to_retrieve: list[str] | None = None,
         attributes_to_crop: list[str] | None = None,
         crop_length: int = 200,
         attributes_to_highlight: list[str] | None = None,
@@ -763,7 +775,8 @@ class AsyncIndex(_BaseIndex):
                 to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                 sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                 Because this feature is experimental it may be removed or updated causing breaking
-                changes in this library without a major version bump so use with caution.
+                changes in this library without a major version bump so use with caution. This
+                feature became stable in Meiliseach v1.7.0.
             vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                 only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                 In order to use this feature in Meilisearch v1.3.0 you first need to enable the
@@ -795,7 +808,6 @@ class AsyncIndex(_BaseIndex):
             >>>     index = client.index("movies")
             >>>     search_results = await index.search("Tron")
         """
-
         body = _process_search_parameters(
             q=query,
             offset=offset,
@@ -960,7 +972,7 @@ class AsyncIndex(_BaseIndex):
         limit: int = 20,
         filter: Filter | None = None,
         facets: list[str] | None = None,
-        attributes_to_retrieve: list[str] = ["*"],
+        attributes_to_retrieve: list[str] | None = None,
         attributes_to_crop: list[str] | None = None,
         crop_length: int = 200,
         attributes_to_highlight: list[str] | None = None,
@@ -1014,7 +1026,8 @@ class AsyncIndex(_BaseIndex):
                 to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                 sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                 Because this feature is experimental it may be removed or updated causing breaking
-                changes in this library without a major version bump so use with caution.
+                changes in this library without a major version bump so use with caution. This
+                feature became stable in Meiliseach v1.7.0.
             vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                 only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                 In order to use this feature in Meilisearch v1.3.0 you first need to enable the
@@ -2807,7 +2820,10 @@ class AsyncIndex(_BaseIndex):
         settings = MeilisearchSettings(**response_json)
 
         if response_json.get("embedders"):
-            settings.embedders = _embedder_json_to_settings_model(response_json["embedders"])
+            # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+            settings.embedders = _embedder_json_to_settings_model(  # pragma: no cover
+                response_json["embedders"]
+            )
 
         return settings
 
@@ -2863,6 +2879,7 @@ class AsyncIndex(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             body_dict = {k: v for k, v in body.dict(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
 
@@ -3004,7 +3021,7 @@ class AsyncIndex(_BaseIndex):
         response = await self._http_requests.get(f"{self._settings_url}/distinct-attribute")
 
         if not response.json():
-            None
+            return None
 
         return response.json()
 
@@ -3600,6 +3617,7 @@ class AsyncIndex(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/typo-tolerance",
@@ -3689,6 +3707,7 @@ class AsyncIndex(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/faceting", faceting.dict(by_alias=True), compress=compress
@@ -3777,6 +3796,7 @@ class AsyncIndex(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/pagination", settings.dict(by_alias=True), compress=compress
@@ -3963,6 +3983,84 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    async def get_search_cutoff_ms(self) -> int | None:
+        """Get search cutoff time in ms.
+
+        Returns:
+
+            Integer representing the search cutoff time in ms, or None.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     search_cutoff_ms_settings = await index.get_search_cutoff_ms()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/search-cutoff-ms")
+
+        return response.json()
+
+    async def update_search_cutoff_ms(
+        self, search_cutoff_ms: int, *, compress: bool = False
+    ) -> TaskInfo:
+        """Update the search cutoff for an index.
+
+        Args:
+
+            search_cutoff_ms: Integer value of the search cutoff time in ms.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        Returns:
+
+            The details of the task status.
+
+        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")
+            >>>     await index.update_search_cutoff_ms(100)
+        """
+        response = await self._http_requests.put(
+            f"{self._settings_url}/search-cutoff-ms", search_cutoff_ms, compress=compress
+        )
+
+        return TaskInfo(**response.json())
+
+    async def reset_search_cutoff_ms(self) -> TaskInfo:
+        """Reset the search cutoff time to the default value.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.reset_search_cutoff_ms()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/search-cutoff-ms")
+
+        return TaskInfo(**response.json())
+
     async def get_word_dictionary(self) -> list[str]:
         """Get word dictionary settings for the index.
 
@@ -4184,6 +4282,7 @@ class AsyncIndex(_BaseIndex):
                 warn(
                     "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                     DeprecationWarning,
+                    stacklevel=2,
                 )
                 payload[key] = {
                     k: v for k, v in embedder.dict(by_alias=True).items() if v is not None
@@ -4195,7 +4294,8 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    async def reset_embedders(self) -> TaskInfo:
+    # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+    async def reset_embedders(self) -> TaskInfo:  # pragma: no cover
         """Reset an index's embedders settings to the default value.
 
         Returns:
@@ -4694,6 +4794,7 @@ class Index(_BaseIndex):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
     ) -> Index:
         """Creates a new index.
@@ -4715,6 +4816,9 @@ class Index(_BaseIndex):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -4740,7 +4844,7 @@ class Index(_BaseIndex):
         url = "indexes"
         http_request = HttpRequests(http_client)
         response = http_request.post(url, payload)
-        wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=None)
+        wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=timeout_in_ms)
         index_response = http_request.get(f"{url}/{uid}")
         index_dict = index_response.json()
         index = cls(
@@ -4755,7 +4859,7 @@ class Index(_BaseIndex):
         if settings:
             settings_task = index.update_settings(settings)
             if wait:
-                wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=None)
+                wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=timeout_in_ms)
 
         return index
 
@@ -4790,7 +4894,7 @@ class Index(_BaseIndex):
         limit: int = 20,
         filter: Filter | None = None,
         facets: list[str] | None = None,
-        attributes_to_retrieve: list[str] = ["*"],
+        attributes_to_retrieve: list[str] | None = None,
         attributes_to_crop: list[str] | None = None,
         crop_length: int = 200,
         attributes_to_highlight: list[str] | None = None,
@@ -4843,7 +4947,8 @@ class Index(_BaseIndex):
                 to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                 sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                 Because this feature is experimental it may be removed or updated causing breaking
-                changes in this library without a major version bump so use with caution.
+                changes in this library without a major version bump so use with caution. This
+                feature became stable in Meiliseach v1.7.0.
             vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                 only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                 In order to use this feature in Meilisearch v1.3.0 you first need to enable the
@@ -4947,7 +5052,7 @@ class Index(_BaseIndex):
         limit: int = 20,
         filter: Filter | None = None,
         facets: list[str] | None = None,
-        attributes_to_retrieve: list[str] = ["*"],
+        attributes_to_retrieve: list[str] | None = None,
         attributes_to_crop: list[str] | None = None,
         crop_length: int = 200,
         attributes_to_highlight: list[str] | None = None,
@@ -5001,7 +5106,8 @@ class Index(_BaseIndex):
                 to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                 sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                 Because this feature is experimental it may be removed or updated causing breaking
-                changes in this library without a major version bump so use with caution.
+                changes in this library without a major version bump so use with caution. This
+                feature became stable in Meiliseach v1.7.0.
             vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                 only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                 In order to use this feature in Meilisearch v1.3.0 you first need to enable the
@@ -6235,7 +6341,10 @@ class Index(_BaseIndex):
         settings = MeilisearchSettings(**response_json)
 
         if response_json.get("embedders"):
-            settings.embedders = _embedder_json_to_settings_model(response_json["embedders"])
+            # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+            settings.embedders = _embedder_json_to_settings_model(  # pragma: no cover
+                response_json["embedders"]
+            )
 
         return settings
 
@@ -6289,6 +6398,7 @@ class Index(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             body_dict = {k: v for k, v in body.dict(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
 
@@ -6428,7 +6538,7 @@ class Index(_BaseIndex):
         response = self._http_requests.get(f"{self._settings_url}/distinct-attribute")
 
         if not response.json():
-            None
+            return None
 
         return response.json()
 
@@ -7015,6 +7125,7 @@ class Index(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.patch(
                 f"{self._settings_url}/typo-tolerance",
@@ -7104,6 +7215,7 @@ class Index(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.patch(
                 f"{self._settings_url}/faceting", faceting.dict(by_alias=True), compress=compress
@@ -7192,6 +7304,7 @@ class Index(_BaseIndex):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.patch(
                 f"{self._settings_url}/pagination", settings.dict(by_alias=True), compress=compress
@@ -7378,6 +7491,82 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    def get_search_cutoff_ms(self) -> int | None:
+        """Get search cutoff time in ms.
+
+        Returns:
+
+            Integer representing the search cutoff time in ms, or None.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> search_cutoff_ms_settings = index.get_search_cutoff_ms()
+        """
+        response = self._http_requests.get(f"{self._settings_url}/search-cutoff-ms")
+
+        return response.json()
+
+    def update_search_cutoff_ms(self, search_cutoff_ms: int, *, compress: bool = False) -> TaskInfo:
+        """Update the search cutoff for an index.
+
+        Args:
+
+            search_cutoff_ms: Integer value of the search cutoff time in ms.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        Returns:
+
+            Task to track the action.
+
+        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.update_search_cutoff_ms(100)
+        """
+        response = self._http_requests.put(
+            f"{self._settings_url}/search-cutoff-ms", search_cutoff_ms, compress=compress
+        )
+
+        return TaskInfo(**response.json())
+
+    def reset_search_cutoff_ms(self) -> TaskInfo:
+        """Reset the search cutoff time to the default value.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.reset_search_cutoff_ms()
+        """
+        response = self._http_requests.delete(f"{self._settings_url}/search-cutoff-ms")
+
+        return TaskInfo(**response.json())
+
     def get_word_dictionary(self) -> list[str]:
         """Get word dictionary settings for the index.
 
@@ -7595,6 +7784,7 @@ class Index(_BaseIndex):
                 warn(
                     "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                     DeprecationWarning,
+                    stacklevel=2,
                 )
                 payload[key] = {
                     k: v for k, v in embedder.dict(by_alias=True).items() if v is not None
@@ -7606,7 +7796,8 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    def reset_embedders(self) -> TaskInfo:
+    # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+    def reset_embedders(self) -> TaskInfo:  # pragma: no cover
         """Reset an index's embedders settings to the default value.
 
         Returns:
@@ -7793,7 +7984,7 @@ def _process_search_parameters(
     limit: int = 20,
     filter: Filter | None = None,
     facets: list[str] | None = None,
-    attributes_to_retrieve: list[str] = ["*"],
+    attributes_to_retrieve: list[str] | None = None,
     attributes_to_crop: list[str] | None = None,
     crop_length: int = 200,
     attributes_to_highlight: list[str] | None = None,
@@ -7811,6 +8002,9 @@ def _process_search_parameters(
     vector: list[float] | None = None,
     hybrid: Hybrid | None = None,
 ) -> JsonDict:
+    if attributes_to_retrieve is None:
+        attributes_to_retrieve = ["*"]
+
     body: JsonDict = {
         "q": q,
         "offset": offset,
@@ -7852,6 +8046,7 @@ def _process_search_parameters(
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             body["hybrid"] = hybrid.dict(by_alias=True)  # type: ignore[attr-defined]
 
@@ -7862,34 +8057,58 @@ def _build_encoded_url(base_url: str, params: JsonMapping) -> str:
     return f"{base_url}?{urlencode(params)}"
 
 
-def _embedder_json_to_embedders_model(embedder_json: JsonDict | None) -> Embedders | None:
+# TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+def _embedder_json_to_embedders_model(  # pragma: no cover
+    embedder_json: JsonDict | None,
+) -> Embedders | None:
     if not embedder_json:  # pragma: no cover
         return None
 
-    embedders: dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder] = {}
+    embedders: dict[
+        str,
+        OpenAiEmbedder | HuggingFaceEmbedder | OllamaEmbedder | RestEmbedder | UserProvidedEmbedder,
+    ] = {}
     for k, v in embedder_json.items():
         if v.get("source") == "openAi":
             embedders[k] = OpenAiEmbedder(**v)
         elif v.get("source") == "huggingFace":
             embedders[k] = HuggingFaceEmbedder(**v)
+        elif v.get("source") == "ollama":
+            embedders[k] = OllamaEmbedder(**v)
+        elif v.get("source") == "rest":
+            embedders[k] = RestEmbedder(**v)
         else:
             embedders[k] = UserProvidedEmbedder(**v)
 
     return Embedders(embedders=embedders)
 
 
-def _embedder_json_to_settings_model(
+# TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
+def _embedder_json_to_settings_model(  # pragma: no cover
     embedder_json: JsonDict | None,
-) -> dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder] | None:
+) -> (
+    dict[
+        str,
+        OpenAiEmbedder | HuggingFaceEmbedder | OllamaEmbedder | RestEmbedder | UserProvidedEmbedder,
+    ]
+    | None
+):
     if not embedder_json:  # pragma: no cover
         return None
 
-    embedders: dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder] = {}
+    embedders: dict[
+        str,
+        OpenAiEmbedder | HuggingFaceEmbedder | OllamaEmbedder | RestEmbedder | UserProvidedEmbedder,
+    ] = {}
     for k, v in embedder_json.items():
         if v.get("source") == "openAi":
             embedders[k] = OpenAiEmbedder(**v)
         elif v.get("source") == "huggingFace":
             embedders[k] = HuggingFaceEmbedder(**v)
+        elif v.get("source") == "ollama":
+            embedders[k] = OllamaEmbedder(**v)
+        elif v.get("source") == "rest":
+            embedders[k] = RestEmbedder(**v)
         else:
             embedders[k] = UserProvidedEmbedder(**v)
 

meilisearch_python_sdk/models/client.py

@@ -25,6 +25,7 @@ class ClientStats(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("last_update", pre=True)
@@ -53,6 +54,7 @@ class _KeyBase(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("expires_at", pre=True)
@@ -98,6 +100,7 @@ class Key(_KeyBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("created_at", pre=True)
@@ -130,6 +133,7 @@ class KeyCreate(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         class Config:
@@ -159,6 +163,7 @@ class KeyUpdate(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         class Config:

meilisearch_python_sdk/models/index.py

@@ -43,6 +43,7 @@ class IndexInfo(IndexBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("created_at", pre=True)

meilisearch_python_sdk/models/search.py

@@ -60,7 +60,7 @@ class SearchResults(CamelBase):
     total_hits: Optional[int] = None
     page: Optional[int] = None
     hits_per_page: Optional[int] = None
-    vector: Optional[List[float]] = None
+    semantic_hit_count: Optional[int] = None
 
 
 class SearchResultsWithUID(SearchResults):

meilisearch_python_sdk/models/settings.py

@@ -43,6 +43,7 @@ class Faceting(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("sort_facet_values_by")  # type: ignore[attr-defined]
@@ -62,11 +63,18 @@ class Pagination(CamelBase):
     max_total_hits: int
 
 
+class Distribution(CamelBase):
+    mean: float
+    sigma: float
+
+
 class OpenAiEmbedder(CamelBase):
     source: str = "openAi"
     model: Optional[str] = None  # Defaults to text-embedding-ada-002
+    dimensions: Optional[int] = None  # Uses the model default
     api_key: Optional[str] = None  # Can be provided through a CLI option or environment variable
     document_template: Optional[str] = None
+    distribution: Optional[Distribution] = None
 
 
 class HuggingFaceEmbedder(CamelBase):
@@ -74,15 +82,45 @@ class HuggingFaceEmbedder(CamelBase):
     model: Optional[str] = None  # Defaults to BAAI/bge-base-en-v1.5
     revision: Optional[str] = None
     document_template: Optional[str] = None
+    distribution: Optional[Distribution] = None
+
+
+class OllamaEmbedder(CamelBase):
+    source: str = "ollama"
+    url: Optional[str] = None
+    api_key: Optional[str] = None
+    model: str
+    document_template: Optional[str] = None
+    distribution: Optional[Distribution] = None
+
+
+class RestEmbedder(CamelBase):
+    source: str = "rest"
+    url: str
+    api_key: Optional[str] = None
+    dimensions: int
+    document_template: Optional[str] = None
+    input_field: Optional[List[str]] = None
+    input_type: str = "text"
+    query: JsonDict = {}
+    path_to_embeddings: Optional[List[str]] = None
+    embedding_object: Optional[List[str]] = None
+    distribution: Optional[Distribution] = None
 
 
 class UserProvidedEmbedder(CamelBase):
     source: str = "userProvided"
     dimensions: int
+    distribution: Optional[Distribution] = None
 
 
 class Embedders(CamelBase):
-    embedders: Dict[str, Union[OpenAiEmbedder, HuggingFaceEmbedder, UserProvidedEmbedder]]
+    embedders: Dict[
+        str,
+        Union[
+            OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder
+        ],
+    ]
 
 
 class ProximityPrecision(str, Enum):
@@ -105,7 +143,17 @@ class MeilisearchSettings(CamelBase):
     proximity_precision: Optional[ProximityPrecision] = None
     separator_tokens: Optional[List[str]] = None
     non_separator_tokens: Optional[List[str]] = None
+    search_cutoff_ms: Optional[int] = None
     dictionary: Optional[List[str]] = None
     embedders: Optional[
-        Dict[str, Union[OpenAiEmbedder, HuggingFaceEmbedder, UserProvidedEmbedder]]
+        Dict[
+            str,
+            Union[
+                OpenAiEmbedder,
+                HuggingFaceEmbedder,
+                OllamaEmbedder,
+                RestEmbedder,
+                UserProvidedEmbedder,
+            ],
+        ]
     ] = None  # Optional[Embedders] = None

meilisearch_python_sdk/models/task.py

@@ -52,6 +52,7 @@ class TaskResult(TaskId):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("enqueued_at", pre=True)
@@ -106,6 +107,7 @@ class TaskInfo(CamelBase):
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
 
         @pydantic.validator("enqueued_at", pre=True)

meilisearch_python_sdk/plugins.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import Any, NamedTuple, Protocol, Sequence
+from typing import TYPE_CHECKING, Any, NamedTuple, Protocol, Sequence
 
-from meilisearch_python_sdk.models.search import FacetSearchResults, SearchResults
-from meilisearch_python_sdk.models.task import TaskInfo
-from meilisearch_python_sdk.types import JsonDict, JsonMapping
+if TYPE_CHECKING:  # pragma: no cover
+    from meilisearch_python_sdk.models.search import FacetSearchResults, SearchResults
+    from meilisearch_python_sdk.models.task import TaskInfo
+    from meilisearch_python_sdk.types import JsonDict, JsonMapping
 
 
 class AsyncEvent(Enum):

{meilisearch_python_sdk-2.7.0.dist-info → meilisearch_python_sdk-2.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.7.0
+Version: 2.9.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Home-page: https://github.com/sanders41/meilisearch-python-sdk
 License: MIT
@@ -36,9 +36,6 @@ Description-Content-Type: text/markdown
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
 
-NOTE: This project was previously named `meilisearch-python-async`. Development on
-that project continues here under the new name.
-
 Meilisearch Python SDK provides both an async and sync client for the
 [Meilisearch](https://github.com/meilisearch/meilisearch) API.
 

meilisearch_python_sdk-2.9.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
+meilisearch_python_sdk/_client.py,sha256=uUwIsqr47_a4XaElsP2ew0H-M4VGNHOUNNwNpW9CtYw,66791
+meilisearch_python_sdk/_http_requests.py,sha256=dbL_LoOhMerUVRa8sBXIg4qAWuAd9aLuBlayzRsuacs,6039
+meilisearch_python_sdk/_task.py,sha256=HiyrLsQn5O2PlnUsKPc0RLSPZnJMIsiwA3WSmFsU2Qk,11874
+meilisearch_python_sdk/_utils.py,sha256=SMoBWDlLtAEtpD8n94CCcHvtBA-HLWyolxPY-n4K_UE,1610
+meilisearch_python_sdk/_version.py,sha256=mLnGZi3iHz6zIKcHRv-G9PlV8Q2M6bDpiMGIcqBxKxQ,18
+meilisearch_python_sdk/decorators.py,sha256=KpS5gAgks28BtPMZJumRaXfgXK4A3QNVPR8Z4BpZC0g,8346
+meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
+meilisearch_python_sdk/index.py,sha256=hRCwPo1nECM6vJW9jaCc2nzAtCccMfJLVRKh3q6U62Q,305399
+meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+meilisearch_python_sdk/models/client.py,sha256=Ka-BgBXmWGqwRm95r2y-vJYFm95fgDamXlPXdfBVvzo,5700
+meilisearch_python_sdk/models/documents.py,sha256=1X6y-gPRD1sB8V-2b-c-gOmQEs-yR8e7ZiY5TWwFNBs,236
+meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
+meilisearch_python_sdk/models/index.py,sha256=ImL8VM5z9bBHkKKWToWZ1RCidQAiu5EbikYjMQYuZt0,2070
+meilisearch_python_sdk/models/search.py,sha256=9c1meU2jREd5zHm3kRpJRZrtbt9b4LcgWtI3SGDjXYI,1858
+meilisearch_python_sdk/models/settings.py,sha256=J3K4_zd2YDrAwSbMJKJ6b3PbsbVFpndhW5w5ES_rROs,4879
+meilisearch_python_sdk/models/task.py,sha256=6wVY6M9HlIjMaMUMq63RbcsnqOBWrDVUBDwGYdhmre8,3749
+meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
+meilisearch_python_sdk/plugins.py,sha256=qfc5smEvOqYV_okdcmnJgDszCzOpmUPG1oA2UYCw5dE,3580
+meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+meilisearch_python_sdk/types.py,sha256=BoZcEdkazGKp3Hh6h5yMDtDBLYjOQjQW3SH0cO8k8kw,173
+meilisearch_python_sdk-2.9.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-2.9.0.dist-info/METADATA,sha256=pJNsuaCacN_XQET4p8uVuzf2qgRUF4W_NGlLMCPABT4,8264
+meilisearch_python_sdk-2.9.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+meilisearch_python_sdk-2.9.0.dist-info/RECORD,,

meilisearch_python_sdk-2.7.0.dist-info/RECORD

@@ -1,25 +0,0 @@
-meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=FApG3bpJ0A8FVUupE708lkG-xJV05ukDr_PmH2KUwDs,65791
-meilisearch_python_sdk/_http_requests.py,sha256=u56JQNDv2jfsAwbm9YlVn8yy_vv6E0ET79nQDxjpU9M,6021
-meilisearch_python_sdk/_task.py,sha256=HiyrLsQn5O2PlnUsKPc0RLSPZnJMIsiwA3WSmFsU2Qk,11874
-meilisearch_python_sdk/_utils.py,sha256=SMoBWDlLtAEtpD8n94CCcHvtBA-HLWyolxPY-n4K_UE,1610
-meilisearch_python_sdk/_version.py,sha256=zS300t5kBvgJNFAMoEda5x5AApc6DZb0kCrfdwrXjG8,18
-meilisearch_python_sdk/decorators.py,sha256=4NcMz73vJPiYII1ns5UJpFBqf_thPakypPNSTUD6ypE,8345
-meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=EogSmKPzSsw6wrS3kB-kddT8rCV6htczKNNaeD7bHD8,297180
-meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/models/client.py,sha256=rJ02cSWnuBpdltFTdgXXwj4IVaoOtwMXnaSnSO8KFrY,5570
-meilisearch_python_sdk/models/documents.py,sha256=1X6y-gPRD1sB8V-2b-c-gOmQEs-yR8e7ZiY5TWwFNBs,236
-meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
-meilisearch_python_sdk/models/index.py,sha256=aJ8yrXIPlw-bY7zQd2s6F4JJAa7elYS-JJqoanJa5Ck,2044
-meilisearch_python_sdk/models/search.py,sha256=hMONu9UIWy19I7l5Qw35yTNk92I-F4QfFUQuZ8rYHBg,1854
-meilisearch_python_sdk/models/settings.py,sha256=6sP372IsktBDfGInnx9nsAHIU7BPXtKB53tjuyj-fII,3654
-meilisearch_python_sdk/models/task.py,sha256=5dHFx0G-yajBuX79gjDkDnK7MZrjCI2iKQyLf4J18aw,3697
-meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
-meilisearch_python_sdk/plugins.py,sha256=AiPGVj1bT6ZIrDXNxKbN6uoEGRX5xX8qiySMPVKsmDU,3515
-meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/types.py,sha256=BoZcEdkazGKp3Hh6h5yMDtDBLYjOQjQW3SH0cO8k8kw,173
-meilisearch_python_sdk-2.7.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-2.7.0.dist-info/METADATA,sha256=huYThmLka2oZu_bMBVlpm142hD3QeJL0YZmsJjkFAjM,8396
-meilisearch_python_sdk-2.7.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-meilisearch_python_sdk-2.7.0.dist-info/RECORD,,