meilisearch-python-sdk 3.5.1__py3-none-any.whl → 3.6.1__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -24,6 +24,7 @@ from meilisearch_python_sdk.models.health import Health
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.search import (
     Federation,
+    FederationMerged,
     SearchParams,
     SearchResultsFederated,
     SearchResultsWithUID,
@@ -587,7 +588,7 @@ class AsyncClient(BaseClient):
         self,
         queries: list[SearchParams],
         *,
-        federation: Federation | None = None,
+        federation: Federation | FederationMerged | None = None,
         hits_type: Any = JsonDict,
     ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
@@ -628,10 +629,18 @@ class AsyncClient(BaseClient):
         else:
             processed_queries = [x.model_dump(by_alias=True) for x in queries]
 
+        if federation:
+            federation_payload = federation.model_dump(by_alias=True)
+            if federation.facets_by_index is None:
+                del federation_payload["facetsByIndex"]
+
+        else:
+            federation_payload = None
+
         response = await self._http_requests.post(
             url,
             body={
-                "federation": federation.model_dump(by_alias=True) if federation else None,
+                "federation": federation_payload,
                 "queries": processed_queries,
             },
         )
@@ -1396,7 +1405,7 @@ class Client(BaseClient):
         self,
         queries: list[SearchParams],
         *,
-        federation: Federation | None = None,
+        federation: Federation | FederationMerged | None = None,
         hits_type: Any = JsonDict,
     ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
@@ -1437,10 +1446,18 @@ class Client(BaseClient):
         else:
             processed_queries = [x.model_dump(by_alias=True) for x in queries]
 
+        if federation:
+            federation_payload = federation.model_dump(by_alias=True)
+            if federation.facets_by_index is None:
+                del federation_payload["facetsByIndex"]
+
+        else:
+            federation_payload = None
+
         response = self._http_requests.post(
             url,
             body={
-                "federation": federation.model_dump(by_alias=True) if federation else None,
+                "federation": federation_payload,
                 "queries": processed_queries,
             },
         )

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "3.5.1"
+VERSION = "3.6.1"

meilisearch_python_sdk/index.py

@@ -3079,7 +3079,11 @@ class AsyncIndex(_BaseIndex):
             >>>     index = client.index("movies")
             >>>     await index.update_settings(new_settings)
         """
-        body_dict = {k: v for k, v in body.model_dump(by_alias=True).items() if v is not None}
+        body_dict = {
+            k: v
+            for k, v in body.model_dump(by_alias=True, exclude_none=True).items()
+            if v is not None
+        }
         response = await self._http_requests.patch(self._settings_url, body_dict, compress=compress)
 
         return TaskInfo(**response.json())
@@ -4270,7 +4274,9 @@ class AsyncIndex(_BaseIndex):
         payload = {}
         for key, embedder in embedders.embedders.items():
             payload[key] = {
-                k: v for k, v in embedder.model_dump(by_alias=True).items() if v is not None
+                k: v
+                for k, v in embedder.model_dump(by_alias=True, exclude_none=True).items()
+                if v is not None
             }
 
         response = await self._http_requests.patch(
@@ -6498,7 +6504,11 @@ class Index(_BaseIndex):
             >>> index = client.index("movies")
             >>> index.update_settings(new_settings)
         """
-        body_dict = {k: v for k, v in body.model_dump(by_alias=True).items() if v is not None}
+        body_dict = {
+            k: v
+            for k, v in body.model_dump(by_alias=True, exclude_none=True).items()
+            if v is not None
+        }
         response = self._http_requests.patch(self._settings_url, body_dict, compress=compress)
 
         return TaskInfo(**response.json())
@@ -7672,7 +7682,9 @@ class Index(_BaseIndex):
         payload = {}
         for key, embedder in embedders.embedders.items():
             payload[key] = {
-                k: v for k, v in embedder.model_dump(by_alias=True).items() if v is not None
+                k: v
+                for k, v in embedder.model_dump(by_alias=True, exclude_none=True).items()
+                if v is not None
             }
 
         response = self._http_requests.patch(

meilisearch_python_sdk/models/client.py

@@ -23,7 +23,7 @@ class ClientStats(CamelBase):
 class _KeyBase(CamelBase):
     uid: str
     name: str | None = None
-    description: str
+    description: str | None = None
     actions: list[str]
     indexes: list[str]
     expires_at: datetime | None = None
@@ -59,7 +59,7 @@ class Key(_KeyBase):
 
 class KeyCreate(CamelBase):
     name: str | None = None
-    description: str
+    description: str | None = None
     actions: list[str]
     indexes: list[str]
     expires_at: datetime | None = None

meilisearch_python_sdk/models/search.py

@@ -24,12 +24,24 @@ class FacetSearchResults(CamelBase):
 
 class Hybrid(CamelBase):
     semantic_ratio: float
-    embedder: str | None = None
+    embedder: str
+
+
+class MergeFacets(CamelBase):
+    max_values_per_facet: int
 
 
 class Federation(CamelBase):
     limit: int = 20
     offset: int = 0
+    facets_by_index: dict[str, list[str]] | None = None
+
+
+class FederationMerged(CamelBase):
+    limit: int = 20
+    offset: int = 0
+    facets_by_index: dict[str, list[str]] | None = None
+    merge_facets: MergeFacets | None
 
 
 class SearchParams(CamelBase):
@@ -99,6 +111,7 @@ class SearchResultsFederated(CamelBase, Generic[T]):
     page: int | None = None
     hits_per_page: int | None = None
     semantic_hit_count: int | None = None
+    facets_by_index: JsonDict | None = None
 
 
 class SimilarSearchResults(CamelBase, Generic[T]):

meilisearch_python_sdk/models/settings.py

@@ -49,18 +49,20 @@ 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
+    model: str | None = None
+    dimensions: int | None = None
+    api_key: str | None = None
     document_template: str | None = None
+    document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
 
 
 class HuggingFaceEmbedder(CamelBase):
     source: str = "huggingFace"
-    model: str | None = None  # Defaults to BAAI/bge-base-en-v1.5
+    model: str | None = None
     revision: str | None = None
     document_template: str | None = None
+    document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
 
 
@@ -71,6 +73,7 @@ class OllamaEmbedder(CamelBase):
     model: str
     dimensions: int | None = None
     document_template: str | None = None
+    document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
 
 
@@ -80,6 +83,7 @@ class RestEmbedder(CamelBase):
     api_key: str | None = None
     dimensions: int
     document_template: str | None = None
+    document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
     headers: JsonDict | None = None
     request: JsonDict

{meilisearch_python_sdk-3.5.1.dist-info → meilisearch_python_sdk-3.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meilisearch-python-sdk
-Version: 3.5.1
+Version: 3.6.1
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
@@ -41,7 +41,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Requires-Dist: aiofiles>=0.7
-Requires-Dist: camel-converter>=1.0.0
+Requires-Dist: camel-converter[pydantic]>=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

{meilisearch_python_sdk-3.5.1.dist-info → meilisearch_python_sdk-3.6.1.dist-info}/RECORD

@@ -1,26 +1,26 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=ncMe6U5FPQArYg-HkSGSaYeul4UG9Vn4l0VW04Tm4Ek,69846
+meilisearch_python_sdk/_client.py,sha256=HvZ74xfKtOfxwujsj0INdlBycW2vMakQfWw5IbTrpX8,70330
 meilisearch_python_sdk/_http_requests.py,sha256=TwpqsOvfgaJ1lQXwam1q1_UC6NvRWy4m9W3c5KNe0RI,6741
 meilisearch_python_sdk/_task.py,sha256=WpUwj-CuFtMbbljNOrFUGzp41k5LuZ_riw08IWLwp4M,12347
 meilisearch_python_sdk/_utils.py,sha256=k6SYMJSiVjfF-vlhQRMaE1ziJsVf5FrL94mFwrMfdLY,957
-meilisearch_python_sdk/_version.py,sha256=fNESzY1Zz6j5JD0Dc9CJa1tGZhNAuBB_A173PRAyW-4,18
+meilisearch_python_sdk/_version.py,sha256=37OYpJUHRvLjldqeNdOMaDCSbtPoVQINs3afAvFR3LQ,18
 meilisearch_python_sdk/decorators.py,sha256=njMn40P-qOzKGGQLCDpsBKWyj2ai10s4XG4IUBSHoD4,8674
 meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=W5I4VA5DhF_MFzvC2aS1a9yOXdJzmnYjOzBc5YtN21A,330764
+meilisearch_python_sdk/index.py,sha256=RWbJAKajw_wI96Zifjc4crmn0HDvwxfUiPYobIXx7p8,330996
 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/client.py,sha256=ntecx3ya_5EwgnxZfqYsBg9UlyQe_i3jgaTlRWFUVTE,2451
 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=LH64_TunWxfCJOhxMCnFA-bMZOf7fVx6s3G9qhnfDTc,3121
-meilisearch_python_sdk/models/settings.py,sha256=A8SocaQldrdo1chvxhS522zZR4foJcvZy7Cg2GiBi_M,3968
+meilisearch_python_sdk/models/search.py,sha256=Wmv8LmhwMVGoZnndkhw16RuoxxC203jlcOO2Q_VZIU4,3439
+meilisearch_python_sdk/models/settings.py,sha256=wg9nmmZd9cP2WrgtHqIgLXdJH4BlCmAuS793QRK6cjc,4007
 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-3.5.1.dist-info/METADATA,sha256=l64dxMChQh-Rzl5-iCIrqHeSvwsb6VkwKwhOGtedfRE,9761
-meilisearch_python_sdk-3.5.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-meilisearch_python_sdk-3.5.1.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-3.5.1.dist-info/RECORD,,
+meilisearch_python_sdk-3.6.1.dist-info/METADATA,sha256=dmk4SC-yytuCAlzJx5lAeMTOq_gx34CsgZdB6_tvLPo,9771
+meilisearch_python_sdk-3.6.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+meilisearch_python_sdk-3.6.1.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-3.6.1.dist-info/RECORD,,