meilisearch-python-sdk 3.2.0__py3-none-any.whl → 3.4.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -22,7 +22,12 @@ from meilisearch_python_sdk.models.client import (
 )
 from meilisearch_python_sdk.models.health import Health
 from meilisearch_python_sdk.models.index import IndexInfo
-from meilisearch_python_sdk.models.search import SearchParams, SearchResultsWithUID
+from meilisearch_python_sdk.models.search import (
+    Federation,
+    SearchParams,
+    SearchResultsFederated,
+    SearchResultsWithUID,
+)
 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
@@ -145,6 +150,7 @@ class AsyncClient(BaseClient):
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -163,11 +169,12 @@ class AsyncClient(BaseClient):
                 (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.
+            http2: Whether or not to use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxAsyncClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
         self._http_requests = AsyncHttpRequests(self.http_client, json_handler=self.json_handler)
 
@@ -633,13 +640,20 @@ class AsyncClient(BaseClient):
         return Key(**response.json())
 
     async def multi_search(
-        self, queries: list[SearchParams], *, hits_type: Any = JsonDict
-    ) -> list[SearchResultsWithUID]:
+        self,
+        queries: list[SearchParams],
+        *,
+        federation: Federation | None = None,
+        hits_type: Any = JsonDict,
+    ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
 
         Args:
 
             queries: List of SearchParameters
+            federation: If included a single search result with hits built from all queries will
+                be returned. This parameter can only be used with Meilisearch >= v1.10.0. Defaults
+                to None.
             hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                 JsonDict
 
@@ -664,11 +678,28 @@ class AsyncClient(BaseClient):
             >>>     search_results = await client.search(queries)
         """
         url = "multi-search"
+        if federation:
+            processed_queries = []
+            for query in queries:
+                q = query.model_dump(by_alias=True)
+                del q["limit"]
+                del q["offset"]
+                processed_queries.append(q)
+        else:
+            processed_queries = [x.model_dump(by_alias=True) for x in queries]
+
         response = await self._http_requests.post(
             url,
-            body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
+            body={
+                "federation": federation.model_dump(by_alias=True) if federation else None,
+                "queries": processed_queries,
+            },
         )
 
+        if federation:
+            results = response.json()
+            return SearchResultsFederated[hits_type](**results)
+
         return [SearchResultsWithUID[hits_type](**x) for x in response.json()["results"]]
 
     async def get_raw_index(self, uid: str) -> IndexInfo | None:
@@ -1044,6 +1075,7 @@ class Client(BaseClient):
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -1062,12 +1094,14 @@ class Client(BaseClient):
                 (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.
+            http2: If set to True, the client will use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
+
         self._http_requests = HttpRequests(self.http_client, json_handler=self.json_handler)
 
     def create_dump(self) -> TaskInfo:
@@ -1510,13 +1544,20 @@ class Client(BaseClient):
         return Key(**response.json())
 
     def multi_search(
-        self, queries: list[SearchParams], *, hits_type: Any = JsonDict
-    ) -> list[SearchResultsWithUID]:
+        self,
+        queries: list[SearchParams],
+        *,
+        federation: Federation | None = None,
+        hits_type: Any = JsonDict,
+    ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
 
         Args:
 
             queries: List of SearchParameters
+            federation: If included a single search result with hits built from all queries will
+                be returned. This parameter can only be used with Meilisearch >= v1.10.0. Defaults
+                to None.
             hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                 JsonDict
 
@@ -1541,11 +1582,28 @@ class Client(BaseClient):
             >>> search_results = client.search(queries)
         """
         url = "multi-search"
+        if federation:
+            processed_queries = []
+            for query in queries:
+                q = query.model_dump(by_alias=True)
+                del q["limit"]
+                del q["offset"]
+                processed_queries.append(q)
+        else:
+            processed_queries = [x.model_dump(by_alias=True) for x in queries]
+
         response = self._http_requests.post(
             url,
-            body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
+            body={
+                "federation": federation.model_dump(by_alias=True) if federation else None,
+                "queries": processed_queries,
+            },
         )
 
+        if federation:
+            results = response.json()
+            return SearchResultsFederated[hits_type](**results)
+
         return [SearchResultsWithUID[hits_type](**x) for x in response.json()["results"]]
 
     def get_raw_index(self, uid: str) -> IndexInfo | None:

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "3.2.0"
+VERSION = "3.4.0"

meilisearch_python_sdk/decorators.py

@@ -26,6 +26,7 @@ def async_add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and asyncronously adds them to Meilisearch.
 
@@ -42,6 +43,7 @@ def async_add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -89,7 +91,9 @@ def async_add_documents(
                 )
                 return result
 
-            async with AsyncClient(connection_info.url, connection_info.api_key) as client:
+            async with AsyncClient(
+                connection_info.url, connection_info.api_key, verify=verify
+            ) as client:
                 await _async_add_documents(
                     client, index_name, result, batch_size, primary_key, wait_for_task
                 )
@@ -108,6 +112,7 @@ def add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and adds them to Meilisearch.
 
@@ -124,6 +129,7 @@ def add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -171,7 +177,9 @@ def add_documents(
                 )
                 return result
 
-            decorator_client = Client(url=connection_info.url, api_key=connection_info.api_key)
+            decorator_client = Client(
+                url=connection_info.url, api_key=connection_info.api_key, verify=verify
+            )
             _add_documents(
                 decorator_client,
                 index_name,

meilisearch_python_sdk/index.py

@@ -30,6 +30,7 @@ from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
     HuggingFaceEmbedder,
+    LocalizedAttributes,
     MeilisearchSettings,
     OllamaEmbedder,
     OpenAiEmbedder,
@@ -787,6 +788,7 @@ class AsyncIndex(_BaseIndex):
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
         hybrid: Hybrid | None = None,
+        locales: list[str] | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -846,6 +848,8 @@ class AsyncIndex(_BaseIndex):
                 { "vectorStore": 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.
+            locales: Specifies the languages for the search. This parameter can only be used with
+                Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
 
         Returns:
 
@@ -891,6 +895,7 @@ class AsyncIndex(_BaseIndex):
             vector=vector,
             hybrid=hybrid,
             ranking_score_threshold=ranking_score_threshold,
+            locales=locales,
         )
         search_url = f"{self._base_url_with_uid}/search"
 
@@ -1052,6 +1057,7 @@ class AsyncIndex(_BaseIndex):
         show_ranking_score_details: bool = False,
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
+        locales: list[str] | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -1103,6 +1109,8 @@ class AsyncIndex(_BaseIndex):
                 { "vectorStore": 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.
+            locales: Specifies the languages for the search. This parameter can only be used with
+                Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
 
         Returns:
 
@@ -1152,6 +1160,7 @@ class AsyncIndex(_BaseIndex):
             show_ranking_score_details=show_ranking_score_details,
             ranking_score_threshold=ranking_score_threshold,
             vector=vector,
+            locales=locales,
         )
         search_url = f"{self._base_url_with_uid}/facet-search"
 
@@ -2028,6 +2037,51 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    async def edit_documents(
+        self, function: str, *, context: JsonDict | None = None, filter: str | None = None
+    ) -> TaskInfo:
+        """Edit documents with a function.
+
+        Edit documents is only available in Meilisearch >= v1.10.0, and is experimental in
+        Meilisearch v1.10.0. In order to use this feature you first need to enable it by
+        sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.
+
+        Args:
+
+            function: Rhai function to use to update the documents.
+            context: Parameters to use in the function. Defaults to None.
+            filter: Filter the documents before applying the function. Defaults to None.
+
+        Returns:
+
+            The details of the task.
+
+        Raises:
+
+            MeilisearchError: If the file path is not valid
+            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.edit_documents("doc.title = `${doc.title.to_upper()}`")
+        """
+        url = f"{self._documents_url}/edit"
+        payload: JsonDict = {"function": function}
+
+        if context:
+            payload["context"] = context
+
+        if filter:
+            payload["filter"] = filter
+
+        response = await self._http_requests.post(url, payload)
+
+        return TaskInfo(**response.json())
+
     async def update_documents(
         self,
         documents: Sequence[JsonMapping],
@@ -4434,8 +4488,7 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
-    async def reset_embedders(self) -> TaskInfo:  # pragma: no cover
+    async def reset_embedders(self) -> TaskInfo:
         """Reset an index's embedders settings to the default value.
 
         Returns:
@@ -4458,6 +4511,94 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    async def get_localized_attributes(self) -> list[LocalizedAttributes] | None:
+        """Get localized attributes settings for the index.
+
+        Returns:
+
+            Localized attributes for the index.
+
+        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")
+            >>>     localized_attributes = await index.get_localized_attributes()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/localized-attributes")
+
+        if not response.json():
+            return None
+
+        return [LocalizedAttributes(**x) for x in response.json()]
+
+    async def update_localized_attributes(
+        self, localized_attributes: list[LocalizedAttributes], *, compress: bool = False
+    ) -> TaskInfo:
+        """Update the localized attributes settings for an index.
+
+        Args:
+
+            localized_attributes: The localized attributes value.
+            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 AsyncClient
+            >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
+            >>>
+            >>>
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.update_localized_attributes([
+            >>>         LocalizedAttributes(locales=["eng", "spa"], attribute_patterns=["*"]),
+            >>>         LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
+            >>>     ])
+        """
+        payload = [x.model_dump(by_alias=True) for x in localized_attributes]
+        response = await self._http_requests.put(
+            f"{self._settings_url}/localized-attributes", payload, compress=compress
+        )
+
+        return TaskInfo(**response.json())
+
+    async def reset_localized_attributes(self) -> TaskInfo:
+        """Reset an index's localized attributes settings 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_localized_attributes()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/localized-attributes")
+
+        return TaskInfo(**response.json())
+
     @staticmethod
     async def _run_plugins(
         plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin | AsyncPostSearchPlugin],
@@ -5080,6 +5221,7 @@ class Index(_BaseIndex):
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
         hybrid: Hybrid | None = None,
+        locales: list[str] | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -5139,6 +5281,8 @@ class Index(_BaseIndex):
                 { "vectorStore": 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.
+            locales: Specifies the languages for the search. This parameter can only be used with
+                Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
 
         Returns:
 
@@ -5184,6 +5328,7 @@ class Index(_BaseIndex):
             vector=vector,
             hybrid=hybrid,
             ranking_score_threshold=ranking_score_threshold,
+            locales=locales,
         )
 
         if self._pre_search_plugins:
@@ -5251,6 +5396,7 @@ class Index(_BaseIndex):
         show_ranking_score_details: bool = False,
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
+        locales: list[str] | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -5302,6 +5448,8 @@ class Index(_BaseIndex):
                 { "vectorStore": 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.
+            locales: Specifies the languages for the search. This parameter can only be used with
+                Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
 
         Returns:
 
@@ -5351,6 +5499,7 @@ class Index(_BaseIndex):
             show_ranking_score_details=show_ranking_score_details,
             ranking_score_threshold=ranking_score_threshold,
             vector=vector,
+            locales=locales,
         )
 
         if self._pre_facet_search_plugins:
@@ -5990,6 +6139,51 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    def edit_documents(
+        self, function: str, *, context: JsonDict | None = None, filter: str | None = None
+    ) -> TaskInfo:
+        """Edit documents with a function.
+
+        Edit documents is only available in Meilisearch >= v1.10.0, and is experimental in
+        Meilisearch v1.10.0. In order to use this feature you first need to enable it by
+        sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.
+
+        Args:
+
+            function: Rhai function to use to update the documents.
+            context: Parameters to use in the function. Defaults to None.
+            filter: Filter the documents before applying the function. Defaults to None.
+
+        Returns:
+
+            The details of the task.
+
+        Raises:
+
+            MeilisearchError: If the file path is not valid
+            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.edit_documents("doc.title = `${doc.title.to_upper()}`")
+        """
+        url = f"{self._documents_url}/edit"
+        payload: JsonDict = {"function": function}
+
+        if context:
+            payload["context"] = context
+
+        if filter:
+            payload["filter"] = filter
+
+        response = self._http_requests.post(url, payload)
+
+        return TaskInfo(**response.json())
+
     def update_documents(
         self,
         documents: Sequence[JsonMapping],
@@ -8070,6 +8264,94 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    def get_localized_attributes(self) -> list[LocalizedAttributes] | None:
+        """Get localized attributes settings for the index.
+
+        Returns:
+
+            Localized attributes for the index.
+
+        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
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> localized_attributes = await index.get_localized_attributes()
+        """
+        response = self._http_requests.get(f"{self._settings_url}/localized-attributes")
+
+        if not response.json():
+            return None
+
+        return [LocalizedAttributes(**x) for x in response.json()]
+
+    def update_localized_attributes(
+        self, localized_attributes: list[LocalizedAttributes], *, compress: bool = False
+    ) -> TaskInfo:
+        """Update the localized attributes settings for an index.
+
+        Args:
+
+            localized_attributes: The localized attributes value.
+            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 AsyncClient
+            >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
+            >>>
+            >>>
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.update_localized_attributes([
+            >>>     LocalizedAttributes(locales=["eng", "spa"], attribute_patterns=["*"]),
+            >>>     LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
+            >>> ])
+        """
+        payload = [x.model_dump(by_alias=True) for x in localized_attributes]
+        response = self._http_requests.put(
+            f"{self._settings_url}/localized-attributes", payload, compress=compress
+        )
+
+        return TaskInfo(**response.json())
+
+    def reset_localized_attributes(self) -> TaskInfo:
+        """Reset an index's localized attributes settings 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
+            >>> Client("http://localhost.com", "masterKey") as client:
+            >>> index = client.index("movies")
+            >>> index.reset_localized_attributes()
+        """
+        response = self._http_requests.delete(f"{self._settings_url}/localized-attributes")
+
+        return TaskInfo(**response.json())
+
     @staticmethod
     def _run_plugins(
         plugins: Sequence[Plugin | DocumentPlugin | PostSearchPlugin],
@@ -8257,6 +8539,7 @@ def _process_search_parameters(
     ranking_score_threshold: float | None = None,
     vector: list[float] | None = None,
     hybrid: Hybrid | None = None,
+    locales: list[str] | None = None,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -8302,6 +8585,9 @@ def _process_search_parameters(
     if hybrid:
         body["hybrid"] = hybrid.model_dump(by_alias=True)
 
+    if locales:
+        body["locales"] = locales
+
     return body
 
 

meilisearch_python_sdk/models/search.py

@@ -27,6 +27,11 @@ class Hybrid(CamelBase):
     embedder: str | None = None
 
 
+class Federation(CamelBase):
+    limit: int = 20
+    offset: int = 0
+
+
 class SearchParams(CamelBase):
     index_uid: str
     query: str | None = Field(None, alias="q")
@@ -52,6 +57,7 @@ class SearchParams(CamelBase):
     ranking_score_threshold: float | None = None
     vector: list[float] | None = None
     hybrid: Hybrid | None = None
+    locales: list[str] | None = None
 
     @field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
     @classmethod
@@ -81,6 +87,20 @@ class SearchResultsWithUID(SearchResults, Generic[T]):
     index_uid: str
 
 
+class SearchResultsFederated(CamelBase, Generic[T]):
+    hits: list[T]
+    offset: int | None = None
+    limit: int | None = None
+    estimated_total_hits: int | None = None
+    processing_time_ms: int
+    facet_distribution: JsonDict | None = None
+    total_pages: int | None = None
+    total_hits: int | None = None
+    page: int | None = None
+    hits_per_page: int | None = None
+    semantic_hit_count: int | None = None
+
+
 class SimilarSearchResults(CamelBase, Generic[T]):
     hits: list[T]
     id: str

meilisearch_python_sdk/models/settings.py

@@ -48,6 +48,7 @@ class Distribution(CamelBase):
 
 class OpenAiEmbedder(CamelBase):
     source: str = "openAi"
+    url: str | None = None
     model: str | None = None  # Defaults to text-embedding-ada-002
     dimensions: int | None = None  # Uses the model default
     api_key: str | None = None  # Can be provided through a CLI option or environment variable
@@ -68,6 +69,7 @@ class OllamaEmbedder(CamelBase):
     url: str | None = None
     api_key: str | None = None
     model: str
+    dimensions: int | None = None
     document_template: str | None = None
     distribution: Distribution | None = None
 
@@ -78,12 +80,10 @@ class RestEmbedder(CamelBase):
     api_key: str | None = None
     dimensions: int
     document_template: str | None = None
-    input_field: list[str] | None = None
-    input_type: str = "text"
-    query: JsonDict = {}
-    path_to_embeddings: list[str] | None = None
-    embedding_object: list[str] | None = None
     distribution: Distribution | None = None
+    headers: JsonDict | None = None
+    request: JsonDict
+    response: JsonDict
 
 
 class UserProvidedEmbedder(CamelBase):
@@ -104,6 +104,11 @@ class ProximityPrecision(str, Enum):
     BY_ATTRIBUTE = "byAttribute"
 
 
+class LocalizedAttributes(CamelBase):
+    locales: list[str]
+    attribute_patterns: list[str]
+
+
 class MeilisearchSettings(CamelBase):
     synonyms: JsonDict | None = None
     stop_words: list[str] | None = None
@@ -132,3 +137,4 @@ class MeilisearchSettings(CamelBase):
         ]
         | None
     ) = None  # Optional[Embedders] = None
+    localized_attributes: list[LocalizedAttributes] | None = None

{meilisearch_python_sdk-3.2.0.dist-info → meilisearch_python_sdk-3.4.0.dist-info}/METADATA

@@ -1,36 +1,57 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: meilisearch-python-sdk
-Version: 3.2.0
+Version: 3.4.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
-Keywords: meilisearch,async,python,client,sdk
-Author: Paul Sanders
-Author-email: psanders1@gmail.com
-Requires-Python: >=3.9,<4.0
+Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
+Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
+Project-URL: documentation, https://meilisearch-python-sdk.paulsanders.dev
+Author-email: Paul Sanders <paul@paulsanders.dev>
+License: MIT License
+        
+        Copyright (c) 2021 Paul Sanders
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: async,client,meilisearch,python,sdk
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: aiofiles>=0.7
+Requires-Dist: camel-converter>=1.0.0
+Requires-Dist: eval-type-backport>=0.2.0; python_version < '3.10'
+Requires-Dist: httpx[http2]>=0.17
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyjwt>=2.3.0
 Provides-Extra: all
+Requires-Dist: orjson; extra == 'all'
+Requires-Dist: ujson; extra == 'all'
 Provides-Extra: orjson
+Requires-Dist: orjson>=3.10.6; extra == 'orjson'
 Provides-Extra: ujson
-Requires-Dist: PyJWT (>=2.3.0)
-Requires-Dist: aiofiles (>=0.7)
-Requires-Dist: camel-converter (>=1.0.0)
-Requires-Dist: eval-type-backport (>=0.2.0) ; python_version < "3.10"
-Requires-Dist: httpx (>=0.17)
-Requires-Dist: orjson (>=3.10.6) ; extra == "orjson" or extra == "all"
-Requires-Dist: pydantic (>=2.0.0)
-Requires-Dist: ujson (>=5.10.0) ; extra == "ujson" or extra == "all"
-Project-URL: Documentation, https://meilisearch-python-sdk.paulsanders.dev
-Project-URL: Repository, https://github.com/sanders41/meilisearch-python-sdk
+Requires-Dist: ujson>=5.10.0; extra == 'ujson'
 Description-Content-Type: text/markdown
 
 # Meilisearch Python SDK
@@ -256,4 +277,3 @@ See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full docu
 
 Contributions to this project are welcome. If you are interested in contributing please see our
 [contributing guide](CONTRIBUTING.md)
-

{meilisearch_python_sdk-3.2.0.dist-info → meilisearch_python_sdk-3.4.0.dist-info}/RECORD

@@ -1,26 +1,26 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=I4HVtgzuwlQ-BmyUlVXQTZ3dJR7YIhyfs0qQTXEYBfM,68170
+meilisearch_python_sdk/_client.py,sha256=8QSMTzpyIZQ9dOIsvhPNtvdbBfIk8e1LCBtE5V9Qdak,70166
 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=mSmBHX16HKPBdzS8NyxhHeyB1rvV3HpaiWcXae7jexg,18
-meilisearch_python_sdk/decorators.py,sha256=KpS5gAgks28BtPMZJumRaXfgXK4A3QNVPR8Z4BpZC0g,8346
+meilisearch_python_sdk/_version.py,sha256=khmbxbSXtOr6w4Q7KaaU-Qmove9qu95Y6VPgNPeIc6w,18
+meilisearch_python_sdk/decorators.py,sha256=hNrMvuLJKPNQDULkL1yMZYG7A9OVYbT7nass4URtEZM,8684
 meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=Rj_NudSqTIZAdB7WXntlY1zKQpVD-nPCNzmKEzU4U2c,315305
+meilisearch_python_sdk/index.py,sha256=2y2_gDuxtflmnduPtm7LdTZzrn-sOvFU0rAZDFmcP6c,326043
 meilisearch_python_sdk/json_handler.py,sha256=q_87zSnJfDNuVEI9cEvuOQOGBC7AGWJMEqCh2kGAAqA,2107
+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/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=roaP0ElXMfa-NQF_bS3wuAEHHxTRJpT-qSnTsls5qjw,2586
-meilisearch_python_sdk/models/settings.py,sha256=FugCLAMESWQknHoViD84XfghlEWXcYIlnufb05Qq6IQ,3852
+meilisearch_python_sdk/models/search.py,sha256=LH64_TunWxfCJOhxMCnFA-bMZOf7fVx6s3G9qhnfDTc,3121
+meilisearch_python_sdk/models/settings.py,sha256=A8SocaQldrdo1chvxhS522zZR4foJcvZy7Cg2GiBi_M,3968
 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.2.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-3.2.0.dist-info/METADATA,sha256=t6stZcURVCa41rT656-_-m-mM71bWDTk0f7YsyFiKtQ,8491
-meilisearch_python_sdk-3.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-meilisearch_python_sdk-3.2.0.dist-info/RECORD,,
+meilisearch_python_sdk-3.4.0.dist-info/METADATA,sha256=LmLRvyswlZ_4wEMu_5kZw2o-imPfQKHoGUARlNcC248,9710
+meilisearch_python_sdk-3.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+meilisearch_python_sdk-3.4.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-3.4.0.dist-info/RECORD,,

{meilisearch_python_sdk-3.2.0.dist-info → meilisearch_python_sdk-3.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any