meilisearch-python-sdk 3.0.1__py3-none-any.whl → 3.1.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from datetime import datetime, timezone
 from ssl import SSLContext
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import jwt
 from httpx import AsyncClient as HttpxAsyncClient
@@ -27,12 +27,13 @@ from meilisearch_python_sdk.models.settings import MeilisearchSettings
 from meilisearch_python_sdk.models.task import TaskInfo, TaskResult, TaskStatus
 from meilisearch_python_sdk.models.version import Version
 from meilisearch_python_sdk.plugins import AsyncIndexPlugins, IndexPlugins
+from meilisearch_python_sdk.types import JsonDict
 
 if TYPE_CHECKING:  # pragma: no cover
     import sys
     from types import TracebackType
 
-    from meilisearch_python_sdk.types import JsonDict, JsonMapping
+    from meilisearch_python_sdk.types import JsonMapping
 
     if sys.version_info >= (3, 11):
         from typing import Self
@@ -219,6 +220,7 @@ class AsyncClient(BaseClient):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
+        hits_type: Any = JsonDict,
     ) -> AsyncIndex:
         """Creates a new index.
 
@@ -238,6 +240,8 @@ class AsyncClient(BaseClient):
                 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.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -263,6 +267,7 @@ class AsyncClient(BaseClient):
             timeout_in_ms=timeout_in_ms,
             plugins=plugins,
             json_handler=self.json_handler,
+            hits_type=hits_type,
         )
 
     async def create_snapshot(self) -> TaskInfo:
@@ -436,7 +441,12 @@ class AsyncClient(BaseClient):
         return ClientStats(**response.json())
 
     async def get_or_create_index(
-        self, uid: str, primary_key: str | None = None, *, plugins: AsyncIndexPlugins | None = None
+        self,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        plugins: AsyncIndexPlugins | None = None,
+        hits_type: Any = JsonDict,
     ) -> AsyncIndex:
         """Get an index, or create it if it doesn't exist.
 
@@ -445,6 +455,8 @@ class AsyncClient(BaseClient):
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -467,7 +479,9 @@ class AsyncClient(BaseClient):
         except MeilisearchApiError as err:
             if "index_not_found" not in err.code:
                 raise
-            index_instance = await self.create_index(uid, primary_key, plugins=plugins)
+            index_instance = await self.create_index(
+                uid, primary_key, plugins=plugins, hits_type=hits_type
+            )
         return index_instance
 
     async def create_key(self, key: KeyCreate) -> Key:
@@ -618,12 +632,16 @@ class AsyncClient(BaseClient):
 
         return Key(**response.json())
 
-    async def multi_search(self, queries: list[SearchParams]) -> list[SearchResultsWithUID]:
+    async def multi_search(
+        self, queries: list[SearchParams], *, hits_type: Any = JsonDict
+    ) -> list[SearchResultsWithUID]:
         """Multi-index search.
 
         Args:
 
             queries: List of SearchParameters
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -651,7 +669,7 @@ class AsyncClient(BaseClient):
             body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
         )
 
-        return [SearchResultsWithUID(**x) for x in response.json()["results"]]
+        return [SearchResultsWithUID[hits_type](**x) for x in response.json()["results"]]
 
     async def get_raw_index(self, uid: str) -> IndexInfo | None:
         """Gets the index and returns all the index information rather than an AsyncIndex instance.
@@ -1083,6 +1101,7 @@ class Client(BaseClient):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
+        hits_type: Any = JsonDict,
     ) -> Index:
         """Creates a new index.
 
@@ -1102,6 +1121,8 @@ class Client(BaseClient):
                 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.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -1127,6 +1148,7 @@ class Client(BaseClient):
             timeout_in_ms=timeout_in_ms,
             plugins=plugins,
             json_handler=self.json_handler,
+            hits_type=hits_type,
         )
 
     def create_snapshot(self) -> TaskInfo:
@@ -1296,7 +1318,12 @@ class Client(BaseClient):
         return ClientStats(**response.json())
 
     def get_or_create_index(
-        self, uid: str, primary_key: str | None = None, *, plugins: IndexPlugins | None = None
+        self,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        plugins: IndexPlugins | None = None,
+        hits_type: Any = JsonDict,
     ) -> Index:
         """Get an index, or create it if it doesn't exist.
 
@@ -1305,6 +1332,8 @@ class Client(BaseClient):
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -1327,7 +1356,9 @@ class Client(BaseClient):
         except MeilisearchApiError as err:
             if "index_not_found" not in err.code:
                 raise
-            index_instance = self.create_index(uid, primary_key, plugins=plugins)
+            index_instance = self.create_index(
+                uid, primary_key, plugins=plugins, hits_type=hits_type
+            )
         return index_instance
 
     def create_key(self, key: KeyCreate) -> Key:
@@ -1478,12 +1509,16 @@ class Client(BaseClient):
 
         return Key(**response.json())
 
-    def multi_search(self, queries: list[SearchParams]) -> list[SearchResultsWithUID]:
+    def multi_search(
+        self, queries: list[SearchParams], *, hits_type: Any = JsonDict
+    ) -> list[SearchResultsWithUID]:
         """Multi-index search.
 
         Args:
 
             queries: List of SearchParameters
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -1511,7 +1546,7 @@ class Client(BaseClient):
             body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
         )
 
-        return [SearchResultsWithUID(**x) for x in response.json()["results"]]
+        return [SearchResultsWithUID[hits_type](**x) for x in response.json()["results"]]
 
     def get_raw_index(self, uid: str) -> IndexInfo | None:
         """Gets the index and returns all the index information rather than an Index instance.

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "3.0.1"
+VERSION = "3.1.0"

meilisearch_python_sdk/index.py

@@ -52,11 +52,12 @@ from meilisearch_python_sdk.plugins import (
     Plugin,
     PostSearchPlugin,
 )
+from meilisearch_python_sdk.types import JsonDict
 
 if TYPE_CHECKING:  # pragma: no cover
     import sys
 
-    from meilisearch_python_sdk.types import Filter, JsonDict, JsonMapping
+    from meilisearch_python_sdk.types import Filter, JsonMapping
 
     if sys.version_info >= (3, 11):
         from typing import Self
@@ -72,11 +73,13 @@ class _BaseIndex:
         created_at: str | datetime | None = None,
         updated_at: str | datetime | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        hits_type: Any = JsonDict,
     ):
         self.uid = uid
         self.primary_key = primary_key
         self.created_at: datetime | None = iso_to_date_time(created_at)
         self.updated_at: datetime | None = iso_to_date_time(updated_at)
+        self.hits_type = hits_type
         self._base_url = "indexes/"
         self._base_url_with_uid = f"{self._base_url}{self.uid}"
         self._documents_url = f"{self._base_url_with_uid}/documents"
@@ -113,6 +116,8 @@ class AsyncIndex(_BaseIndex):
         updated_at: str | datetime | None = None,
         plugins: AsyncIndexPlugins | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        *,
+        hits_type: Any = JsonDict,
     ):
         """Class initializer.
 
@@ -129,8 +134,17 @@ class AsyncIndex(_BaseIndex):
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
         """
-        super().__init__(uid, primary_key, created_at, updated_at, json_handler=json_handler)
+        super().__init__(
+            uid=uid,
+            primary_key=primary_key,
+            created_at=created_at,
+            updated_at=updated_at,
+            json_handler=json_handler,
+            hits_type=hits_type,
+        )
         self.http_client = http_client
         self._http_requests = AsyncHttpRequests(http_client, json_handler=self._json_handler)
         self.plugins = plugins
@@ -639,6 +653,7 @@ class AsyncIndex(_BaseIndex):
         timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        hits_type: Any = JsonDict,
     ) -> Self:
         """Creates a new index.
 
@@ -667,6 +682,8 @@ class AsyncIndex(_BaseIndex):
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -708,6 +725,7 @@ class AsyncIndex(_BaseIndex):
             updated_at=index_dict["updatedAt"],
             plugins=plugins,
             json_handler=json_handler,
+            hits_type=hits_type,
         )
 
         if settings:
@@ -934,7 +952,7 @@ class AsyncIndex(_BaseIndex):
                 concurrent_tasks.append(self._http_requests.post(search_url, body=body))
 
                 responses = await asyncio.gather(*concurrent_tasks)
-                result = SearchResults(**responses[-1].json())
+                result = SearchResults[self.hits_type](**responses[-1].json())  # type: ignore[name-defined]
                 if self._post_search_plugins:
                     post = await AsyncIndex._run_plugins(
                         self._post_search_plugins, AsyncEvent.POST, search_results=result
@@ -977,7 +995,7 @@ class AsyncIndex(_BaseIndex):
                 response_coroutine = tg.create_task(self._http_requests.post(search_url, body=body))
 
             response = await response_coroutine
-            result = SearchResults(**response.json())
+            result = SearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
             if self._post_search_plugins:
                 post = await AsyncIndex._run_plugins(
                     self._post_search_plugins, AsyncEvent.POST, search_results=result
@@ -988,7 +1006,7 @@ class AsyncIndex(_BaseIndex):
             return result
 
         response = await self._http_requests.post(search_url, body=body)
-        result = SearchResults(**response.json())
+        result = SearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
 
         if self._post_search_plugins:
             post = await AsyncIndex._run_plugins(
@@ -1324,7 +1342,7 @@ class AsyncIndex(_BaseIndex):
             f"{self._base_url_with_uid}/similar", body=payload
         )
 
-        return SimilarSearchResults(**response.json())
+        return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
 
     async def get_document(self, document_id: str) -> JsonDict:
         """Get one document with given document identifier.
@@ -4516,6 +4534,8 @@ class Index(_BaseIndex):
         updated_at: str | datetime | None = None,
         plugins: IndexPlugins | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        *,
+        hits_type: Any = JsonDict,
     ):
         """Class initializer.
 
@@ -4532,8 +4552,17 @@ class Index(_BaseIndex):
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
         """
-        super().__init__(uid, primary_key, created_at, updated_at, json_handler=json_handler)
+        super().__init__(
+            uid=uid,
+            primary_key=primary_key,
+            created_at=created_at,
+            updated_at=updated_at,
+            json_handler=json_handler,
+            hits_type=hits_type,
+        )
         self.http_client = http_client
         self._http_requests = HttpRequests(http_client, json_handler=self._json_handler)
         self.plugins = plugins
@@ -4916,6 +4945,7 @@ class Index(_BaseIndex):
         timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        hits_type: Any = JsonDict,
     ) -> Self:
         """Creates a new index.
 
@@ -4944,6 +4974,8 @@ class Index(_BaseIndex):
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
+                JsonDict
 
         Returns:
 
@@ -4980,6 +5012,7 @@ class Index(_BaseIndex):
             updated_at=index_dict["updatedAt"],
             plugins=plugins,
             json_handler=json_handler,
+            hits_type=hits_type,
         )
 
         if settings:
@@ -5169,7 +5202,7 @@ class Index(_BaseIndex):
             )
 
         response = self._http_requests.post(f"{self._base_url_with_uid}/search", body=body)
-        result = SearchResults(**response.json())
+        result = SearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
         if self._post_search_plugins:
             post = Index._run_plugins(self._post_search_plugins, Event.POST, search_results=result)
             if post.get("search_result"):
@@ -5408,7 +5441,7 @@ class Index(_BaseIndex):
 
         response = self._http_requests.post(f"{self._base_url_with_uid}/similar", body=payload)
 
-        return SimilarSearchResults(**response.json())
+        return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
 
     def get_document(self, document_id: str) -> JsonDict:
         """Get one document with given document identifier.

meilisearch_python_sdk/models/search.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 
-from typing import Literal
+from typing import Generic, Literal, TypeVar
 
-import pydantic
 from camel_converter.pydantic_base import CamelBase
+from pydantic import Field, field_validator
 
 from meilisearch_python_sdk.errors import MeilisearchError
 from meilisearch_python_sdk.types import Filter, JsonDict
 
+T = TypeVar("T")
+
 
 class FacetHits(CamelBase):
     value: str
@@ -27,7 +29,7 @@ class Hybrid(CamelBase):
 
 class SearchParams(CamelBase):
     index_uid: str
-    query: str | None = pydantic.Field(None, alias="q")
+    query: str | None = Field(None, alias="q")
     offset: int = 0
     limit: int = 20
     filter: Filter | None = None
@@ -51,7 +53,7 @@ class SearchParams(CamelBase):
     vector: list[float] | None = None
     hybrid: Hybrid | None = None
 
-    @pydantic.field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
+    @field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
     @classmethod
     def validate_ranking_score_threshold(cls, v: float | None) -> float | None:
         if v and not 0.0 <= v <= 1.0:
@@ -60,8 +62,8 @@ class SearchParams(CamelBase):
         return v
 
 
-class SearchResults(CamelBase):
-    hits: list[JsonDict]
+class SearchResults(CamelBase, Generic[T]):
+    hits: list[T]
     offset: int | None = None
     limit: int | None = None
     estimated_total_hits: int | None = None
@@ -75,12 +77,12 @@ class SearchResults(CamelBase):
     semantic_hit_count: int | None = None
 
 
-class SearchResultsWithUID(SearchResults):
+class SearchResultsWithUID(SearchResults, Generic[T]):
     index_uid: str
 
 
-class SimilarSearchResults(CamelBase):
-    hits: list[JsonDict]
+class SimilarSearchResults(CamelBase, Generic[T]):
+    hits: list[T]
     id: str
     processing_time_ms: int
     limit: int | None = None

{meilisearch_python_sdk-3.0.1.dist-info → meilisearch_python_sdk-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 3.0.1
+Version: 3.1.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

{meilisearch_python_sdk-3.0.1.dist-info → meilisearch_python_sdk-3.1.0.dist-info}/RECORD

@@ -1,26 +1,26 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=pNX_lz6zAtN1OXihvYOdyGxxJtYGO2GPzpftmZ86ikQ,66951
+meilisearch_python_sdk/_client.py,sha256=I4HVtgzuwlQ-BmyUlVXQTZ3dJR7YIhyfs0qQTXEYBfM,68170
 meilisearch_python_sdk/_http_requests.py,sha256=TwpqsOvfgaJ1lQXwam1q1_UC6NvRWy4m9W3c5KNe0RI,6741
 meilisearch_python_sdk/_task.py,sha256=dB0cpX1u7HDM1OW_TC8gSiGJe985bNCz7hPMZW_qogY,12352
 meilisearch_python_sdk/_utils.py,sha256=k6SYMJSiVjfF-vlhQRMaE1ziJsVf5FrL94mFwrMfdLY,957
-meilisearch_python_sdk/_version.py,sha256=yK7aOUt_pFy8YQaEzXO6v5ZbKRSr9eAB9NpoD7gEyk4,18
+meilisearch_python_sdk/_version.py,sha256=3vf_fJuJ1GKgsLolRXa0KsZlsevgoI4iyhPFl5-KJnM,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=NVkVMKyKkYnKcQQ-P5H9ekswNTGk7uIjY7SsQD9jjPs,313112
+meilisearch_python_sdk/index.py,sha256=uW9m5gnLwHdQKiDf4DV0k4ksr252HzmkJQT3KCicg8g,314470
 meilisearch_python_sdk/json_handler.py,sha256=q_87zSnJfDNuVEI9cEvuOQOGBC7AGWJMEqCh2kGAAqA,2107
 meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 meilisearch_python_sdk/models/client.py,sha256=wBZzO1n6DDQq7F9Acf1rCWYEYRY19g04uFiEf9JCMjc,2423
 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=GGwuhx5Wsn5iyj1ov3f4eWjfw6ttM8WzvyrnSsC4vRg,1132
-meilisearch_python_sdk/models/search.py,sha256=UyI312n2VEveZzNQXdafv6SaYtHiGhvkkaiEZkrsy-I,2518
+meilisearch_python_sdk/models/search.py,sha256=roaP0ElXMfa-NQF_bS3wuAEHHxTRJpT-qSnTsls5qjw,2586
 meilisearch_python_sdk/models/settings.py,sha256=FugCLAMESWQknHoViD84XfghlEWXcYIlnufb05Qq6IQ,3852
 meilisearch_python_sdk/models/task.py,sha256=P3NLaZhrY8H02Q9lDEkoq-3Z6_qGESglOxs4dNRyMWg,2100
 meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
 meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 meilisearch_python_sdk/types.py,sha256=VBzt-JF6w1f5V_aTAM3NetDQxs9fscnRy8t-Y1HWZXM,404
-meilisearch_python_sdk-3.0.1.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-3.0.1.dist-info/METADATA,sha256=99UjfyESTv31x7liqPyb6F9-QJap3RwfBZ-H9ttByR0,8491
-meilisearch_python_sdk-3.0.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-meilisearch_python_sdk-3.0.1.dist-info/RECORD,,
+meilisearch_python_sdk-3.1.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-3.1.0.dist-info/METADATA,sha256=Nf5ywGBA550PlIm1bvQy3_WE0BjXa6n0QDDlkSgWt6Y,8491
+meilisearch_python_sdk-3.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+meilisearch_python_sdk-3.1.0.dist-info/RECORD,,