meilisearch-python-sdk 3.5.1__tar.gz → 3.6.0__tar.gz

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/.github/workflows/nightly_testing.yml

@@ -5,7 +5,6 @@ on:
     # Set with UTC time
     - cron: "0 5 * * *"
 env:
-  UV_CACHE_DIR: /tmp/.uv-cache
   PYTHON_VERSION: "3.12"
 jobs:
   random-test-order:
@@ -15,26 +14,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: |
           just install
           uv pip install pytest-randomly
       - name: Test with pytest in random order
         run: just test-ci
-      - name: Minimize uv cache
-        run: uv cache prune --ci

meilisearch_python_sdk-3.5.1/.github/workflows/pypi_publish.yaml → meilisearch_python_sdk-3.6.0/.github/workflows/pypi_publish.yml

@@ -8,22 +8,24 @@ env:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    permissions:
+      # For PyPI's trusted publishing.
+      id-token: write
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies
         run: uv sync --frozen --all-extras
-      - name: Build and publish package
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: "${{ secrets.PYPI_API_KEY }}"
-        run: |
-          uvx --from build pyproject-build --installer uv
-          uvx twine upload dist/*
+      - name: Build package
+        run: uv build
+      - name: Publish package
+        run: uv publish
       - name: Deploy Docs
         run: uv run mkdocs gh-deploy --force

meilisearch_python_sdk-3.5.1/.github/workflows/testing.yaml → meilisearch_python_sdk-3.6.0/.github/workflows/testing.yml

@@ -6,7 +6,6 @@ on:
       - main
   pull_request:
 env:
-  UV_CACHE_DIR: /tmp/.uv-cache
   PYTHON_VERSION: "3.9"
 jobs:
   linting:
@@ -16,25 +15,17 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: mypy check
         run: just mypy
-      - name: Minimize uv cache
-        run: uv cache prune --ci
 
   parallel-testing:
     strategy:
@@ -47,19 +38,13 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
@@ -69,8 +54,6 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-      - name: Minimize uv cache
-        run: uv cache prune --ci
 
   parallel-testing-http2:
     strategy:
@@ -83,19 +66,13 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: Install truststore
@@ -117,8 +94,6 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-      - name: Minimize uv cache
-        run: uv cache prune --ci
 
   no-parallel-testing:
     strategy:
@@ -131,19 +106,13 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: Test with pytest
@@ -153,8 +122,6 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-      - name: Minimize uv cache
-        run: uv cache prune --ci
 
   no-parallel-testing-http2:
     strategy:
@@ -167,19 +134,13 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: Install truststore
@@ -201,8 +162,6 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-      - name: Minimize uv cache
-        run: uv cache prune --ci
   example-testing:
     strategy:
       fail-fast: false
@@ -228,22 +187,14 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
-      - name: Restore uv cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.UV_CACHE_DIR }}
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
       - name: Install Dependencies
         run: just install
       - name: Test Docs Build
         run: just build-docs
-      - name: Minimize uv cache
-        run: uv cache prune --ci

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
+    rev: v1.13.0
     hooks:
       - id: mypy
-        additional_dependencies: [pydantic, types-aiofiles, types-ujson]
+        additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.9
+    rev: v0.7.0
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meilisearch-python-sdk
-Version: 3.5.1
+Version: 3.6.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
@@ -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 → meilisearch_python_sdk-3.6.0}/docker-compose.https.yml

@@ -1,6 +1,7 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:latest
+    # image: getmeili/meilisearch:latest
+    image: getmeili/meilisearch:v1
     ports:
       - "7700:7700"
     environment:
@@ -9,4 +10,11 @@ services:
     volumes:
       - ./meilisearch.key:/meilisearch.key
       - ./meilisearch.crt:/meilisearch.crt
-    command: ["meilisearch", "--ssl-cert-path", "/meilisearch.crt", "--ssl-key-path", "/meilisearch.key"]
+    command:
+      [
+        "meilisearch",
+        "--ssl-cert-path",
+        "/meilisearch.crt",
+        "--ssl-key-path",
+        "/meilisearch.key",
+      ]

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/docker-compose.yml

@@ -1,6 +1,7 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:latest
+    # image: getmeili/meilisearch:latest
+    image: getmeili/meilisearch:v1
     ports:
       - "7700:7700"
     environment:

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/examples/requirements.txt

@@ -1,4 +1,4 @@
 ../.[all]
-fastapi==0.115.0
+fastapi==0.115.4
 pytest==8.3.3
 pytest-asyncio==0.24.0

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/justfile

@@ -18,23 +18,23 @@
 @ruff-format:
   uv run ruff format meilisearch_python_sdk tests examples
 
-@test:
-  -uv run pytest -x
+@test *args="":
+  -uv run pytest {{args}}
 
-@test-http2:
-  -uv run pytest -x --http2
+@test-http2 *args="":
+  -uv run pytest --http2 {{args}}
 
-@test-parallel:
-  -uv run pytest -n auto -x -m "not no_parallel"
+@test-parallel *args="":
+  -uv run pytest -n auto -m "not no_parallel" {{args}}
 
-@test-no-parallel:
-  -uv run pytest -x -m "no_parallel"
+@test-no-parallel *args="":
+  -uv run pytest -m "no_parallel" {{args}}
 
-@test-parallel-http2:
-  -uv run pytest -n auto -x -m "not no_parallel" --http2
+@test-parallel-http2 *args="":
+  -uv run pytest -n auto -m "not no_parallel" --http2 {{args}}
 
-@test-no-parallel-http2:
-  -uv run pytest -x -m "no_parallel" --http2
+@test-no-parallel-http2 *args="":
+  -uv run pytest -m "no_parallel" --http2 {{args}}
 
 @test-ci: start-meilisearch-detached && stop-meilisearch
   uv run pytest --cov=meilisearch_python_sdk --cov-report=xml

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/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-3.6.0/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "3.6.0"

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/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-3.5.1 → meilisearch_python_sdk-3.6.0}/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-3.5.1 → meilisearch_python_sdk-3.6.0}/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 → meilisearch_python_sdk-3.6.0}/pyproject.toml

@@ -25,7 +25,7 @@ classifiers=[
 dynamic = ["version"]
 dependencies = [
   "aiofiles>=0.7",
-  "camel-converter>=1.0.0",
+  "camel-converter[pydantic]>=1.0.0",
   # allows pydantic to use pipe instead of Union
   "eval-type-backport>=0.2.0; python_version < '3.10'",
   "httpx[http2]>=0.17",
@@ -38,12 +38,12 @@ orjson = ["orjson>=3.10.6"]
 ujson = ["ujson>=5.10.0"]
 all = ["orjson", "ujson"]
 
-[tool.uv]
-dev-dependencies = [
+[dependency-groups]
+dev = [
   "mkdocs==1.6.0",
   "mkdocs-material==9.5.32",
   "mkdocstrings[python]==0.25.2",
-  "mypy==1.11.1",
+  "mypy[faster-cache]==1.13.0",
   "pre-commit==4.0.0",
   "pytest==8.3.2",
   "pytest-cov==5.0.0",

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/tests/test_async_search.py

@@ -9,7 +9,13 @@ from camel_converter.pydantic_base import CamelBase
 from meilisearch_python_sdk import AsyncClient
 from meilisearch_python_sdk._task import async_wait_for_task
 from meilisearch_python_sdk.errors import MeilisearchApiError, MeilisearchError
-from meilisearch_python_sdk.models.search import Federation, Hybrid, SearchParams
+from meilisearch_python_sdk.models.search import (
+    Federation,
+    FederationMerged,
+    Hybrid,
+    MergeFacets,
+    SearchParams,
+)
 
 
 async def test_basic_search(async_index_with_documents):
@@ -395,6 +401,55 @@ async def test_multi_search_federated(async_client, async_index_with_documents,
     assert "_federation" in response.hits[0]
 
 
+async def test_multi_search_federated_facets_by_index(
+    async_client, async_index_with_documents, async_empty_index
+):
+    index1 = await async_index_with_documents()
+    task = await index1.update_filterable_attributes(["title"])
+    await async_client.wait_for_task(task.task_uid)
+    index2 = await async_empty_index()
+    federation = Federation()
+    federation.facets_by_index = {index1.uid: ["title"]}
+    response = await async_client.multi_search(
+        [
+            SearchParams(index_uid=index1.uid, query="How to Train Your Dragon"),
+            SearchParams(index_uid=index2.uid, query=""),
+        ],
+        federation=federation,
+    )
+
+    assert response.hits[0]["id"] == "166428"
+    assert "_formatted" not in response.hits[0]
+    assert "_federation" in response.hits[0]
+    assert response.facets_by_index is not None
+
+
+async def test_multi_search_federated_merge_facets(
+    async_client,
+    async_index_with_documents,
+    async_empty_index,
+):
+    index1 = await async_index_with_documents()
+    task = await index1.update_filterable_attributes(["title"])
+    await async_client.wait_for_task(task.task_uid)
+    index2 = await async_empty_index()
+    federation = FederationMerged(merge_facets=MergeFacets(max_values_per_facet=10))
+    federation.facets_by_index = {index1.uid: ["title"]}
+    response = await async_client.multi_search(
+        [
+            SearchParams(index_uid=index1.uid, query="How to Train Your Dragon"),
+            SearchParams(index_uid=index2.uid, query=""),
+        ],
+        federation=federation,
+    )
+
+    assert response.hits[0]["id"] == "166428"
+    assert "_formatted" not in response.hits[0]
+    assert "_federation" in response.hits[0]
+    assert response.facets_by_index is None
+    assert response.facet_distribution is not None
+
+
 async def test_multi_search_locales(async_client, async_index_with_documents, async_empty_index):
     index1 = await async_index_with_documents()
     index2 = await async_empty_index()

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/tests/test_search.py

@@ -9,7 +9,13 @@ from camel_converter.pydantic_base import CamelBase
 from meilisearch_python_sdk import Client
 from meilisearch_python_sdk._task import wait_for_task
 from meilisearch_python_sdk.errors import MeilisearchApiError, MeilisearchError
-from meilisearch_python_sdk.models.search import Federation, Hybrid, SearchParams
+from meilisearch_python_sdk.models.search import (
+    Federation,
+    FederationMerged,
+    Hybrid,
+    MergeFacets,
+    SearchParams,
+)
 
 
 def test_basic_search(index_with_documents):
@@ -395,6 +401,32 @@ def test_multi_search_federated(client, index_with_documents, empty_index):
     assert "_federation" in response.hits[0]
 
 
+def test_multi_search_federated_merge_facets(
+    client,
+    index_with_documents,
+    empty_index,
+):
+    index1 = index_with_documents()
+    task = index1.update_filterable_attributes(["title"])
+    client.wait_for_task(task.task_uid)
+    index2 = empty_index()
+    federation = FederationMerged(merge_facets=MergeFacets(max_values_per_facet=10))
+    federation.facets_by_index = {index1.uid: ["title"]}
+    response = client.multi_search(
+        [
+            SearchParams(index_uid=index1.uid, query="How to Train Your Dragon"),
+            SearchParams(index_uid=index2.uid, query=""),
+        ],
+        federation=federation,
+    )
+
+    assert response.hits[0]["id"] == "166428"
+    assert "_formatted" not in response.hits[0]
+    assert "_federation" in response.hits[0]
+    assert response.facets_by_index is None
+    assert response.facet_distribution is not None
+
+
 def test_multi_search_locales(client, index_with_documents, empty_index):
     index1 = index_with_documents()
     index2 = empty_index()

{meilisearch_python_sdk-3.5.1 → meilisearch_python_sdk-3.6.0}/uv.lock

@@ -533,11 +533,11 @@ wheels = [
 
 [[package]]
 name = "meilisearch-python-sdk"
-version = "3.5.0"
+version = "3.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "aiofiles" },
-    { name = "camel-converter" },
+    { name = "camel-converter", extra = ["pydantic"] },
     { name = "eval-type-backport", marker = "python_full_version < '3.10'" },
     { name = "httpx", extra = ["http2"] },
     { name = "pydantic" },
@@ -556,13 +556,13 @@ ujson = [
     { name = "ujson" },
 ]
 
-[package.dev-dependencies]
+[package.dependency-groups]
 dev = [
     { name = "meilisearch" },
     { name = "mkdocs" },
     { name = "mkdocs-material" },
     { name = "mkdocstrings", extra = ["python"] },
-    { name = "mypy" },
+    { name = "mypy", extra = ["faster-cache"] },
     { name = "pre-commit" },
     { name = "pytest" },
     { name = "pytest-asyncio" },
@@ -578,7 +578,7 @@ dev = [
 [package.metadata]
 requires-dist = [
     { name = "aiofiles", specifier = ">=0.7" },
-    { name = "camel-converter", specifier = ">=1.0.0" },
+    { name = "camel-converter", extras = ["pydantic"], specifier = ">=1.0.0" },
     { name = "eval-type-backport", marker = "python_full_version < '3.10'", specifier = ">=0.2.0" },
     { name = "httpx", extras = ["http2"], specifier = ">=0.17" },
     { name = "orjson", marker = "extra == 'all'" },
@@ -589,13 +589,13 @@ requires-dist = [
     { name = "ujson", marker = "extra == 'ujson'", specifier = ">=5.10.0" },
 ]
 
-[package.metadata.requires-dev]
+[package.metadata.dependency-groups]
 dev = [
     { name = "meilisearch", specifier = "==0.31.5" },
     { name = "mkdocs", specifier = "==1.6.0" },
     { name = "mkdocs-material", specifier = "==9.5.32" },
     { name = "mkdocstrings", extras = ["python"], specifier = "==0.25.2" },
-    { name = "mypy", specifier = "==1.11.1" },
+    { name = "mypy", extras = ["faster-cache"], specifier = "==1.13.0" },
     { name = "pre-commit", specifier = "==4.0.0" },
     { name = "pytest", specifier = "==8.3.2" },
     { name = "pytest-asyncio", specifier = "==0.24.0" },
@@ -744,36 +744,46 @@ wheels = [
 
 [[package]]
 name = "mypy"
-version = "1.11.1"
+version = "1.13.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "mypy-extensions" },
     { name = "tomli", marker = "python_full_version < '3.11'" },
     { name = "typing-extensions" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/b6/9c/a4b3bda53823439cf395db8ecdda6229a83f9bf201714a68a15190bb2919/mypy-1.11.1.tar.gz", hash = "sha256:f404a0b069709f18bbdb702eb3dcfe51910602995de00bd39cea3050b5772d08", size = 3078369 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/33/ba/858cc9631c24a349c1c63814edc16448da7d6b8716b2c83a10aa20f5ee89/mypy-1.11.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a32fc80b63de4b5b3e65f4be82b4cfa362a46702672aa6a0f443b4689af7008c", size = 10937885 },
-    { url = "https://files.pythonhosted.org/packages/2d/88/2ae81f7489da8313d0f2043dd657ba847650b00a0fb8e07f40e716ed8c58/mypy-1.11.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c1952f5ea8a5a959b05ed5f16452fddadbaae48b5d39235ab4c3fc444d5fd411", size = 10111978 },
-    { url = "https://files.pythonhosted.org/packages/df/4b/d211d6036366f9ea5ee9fb949e80d133b4b8496cdde78c7119f518c49734/mypy-1.11.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e1e30dc3bfa4e157e53c1d17a0dad20f89dc433393e7702b813c10e200843b03", size = 12498441 },
-    { url = "https://files.pythonhosted.org/packages/94/d2/973278d03ad11e006d71d4c858bfe45cf571ae061f3997911925c70a59f0/mypy-1.11.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:2c63350af88f43a66d3dfeeeb8d77af34a4f07d760b9eb3a8697f0386c7590b4", size = 13020595 },
-    { url = "https://files.pythonhosted.org/packages/0b/c2/7f4285eda528883c5c34cb4b8d88080792967f7f7f24256ad8090d303702/mypy-1.11.1-cp310-cp310-win_amd64.whl", hash = "sha256:a831671bad47186603872a3abc19634f3011d7f83b083762c942442d51c58d58", size = 9568307 },
-    { url = "https://files.pythonhosted.org/packages/0b/b1/62d8ce619493a5364dda4f410912aa12c27126926e8fb8393edca0664640/mypy-1.11.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7b6343d338390bb946d449677726edf60102a1c96079b4f002dedff375953fc5", size = 10858723 },
-    { url = "https://files.pythonhosted.org/packages/fe/aa/2ad15a318bc6a17b7f23e1641a624603949904f6131e09681f40340fb875/mypy-1.11.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e4fe9f4e5e521b458d8feb52547f4bade7ef8c93238dfb5bbc790d9ff2d770ca", size = 10038078 },
-    { url = "https://files.pythonhosted.org/packages/4d/7f/77feb389d91603f55b3c4e3e16ccf8752bce007ed73ca921e42c9a5dff12/mypy-1.11.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:886c9dbecc87b9516eff294541bf7f3655722bf22bb898ee06985cd7269898de", size = 12420213 },
-    { url = "https://files.pythonhosted.org/packages/bc/5b/907b4681f68e7ee2e2e88eed65c514cf6406b8f2f83b243ea79bd4eddb97/mypy-1.11.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fca4a60e1dd9fd0193ae0067eaeeb962f2d79e0d9f0f66223a0682f26ffcc809", size = 12898278 },
-    { url = "https://files.pythonhosted.org/packages/5b/b3/2a83be637825d7432b8e6a51e45d02de4f463b6c7ec7164a45009a7cf477/mypy-1.11.1-cp311-cp311-win_amd64.whl", hash = "sha256:0bd53faf56de9643336aeea1c925012837432b5faf1701ccca7fde70166ccf72", size = 9564438 },
-    { url = "https://files.pythonhosted.org/packages/3a/34/69638cee2e87303f19a0c35e80d42757e14d9aba328f272fdcdc0bf3c9b8/mypy-1.11.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f39918a50f74dc5969807dcfaecafa804fa7f90c9d60506835036cc1bc891dc8", size = 10995789 },
-    { url = "https://files.pythonhosted.org/packages/c4/3c/3e0611348fc53a4a7c80485959478b4f6eae706baf3b7c03cafa22639216/mypy-1.11.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0bc71d1fb27a428139dd78621953effe0d208aed9857cb08d002280b0422003a", size = 10002696 },
-    { url = "https://files.pythonhosted.org/packages/1c/21/a6b46c91b4c9d1918ee59c305f46850cde7cbea748635a352e7c3c8ed204/mypy-1.11.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b868d3bcff720dd7217c383474008ddabaf048fad8d78ed948bb4b624870a417", size = 12505772 },
-    { url = "https://files.pythonhosted.org/packages/c4/55/07904d4c8f408e70308015edcbff067eaa77514475938a9dd81b063de2a8/mypy-1.11.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a707ec1527ffcdd1c784d0924bf5cb15cd7f22683b919668a04d2b9c34549d2e", size = 12954190 },
-    { url = "https://files.pythonhosted.org/packages/1e/b7/3a50f318979c8c541428c2f1ee973cda813bcc89614de982dafdd0df2b3e/mypy-1.11.1-cp312-cp312-win_amd64.whl", hash = "sha256:64f4a90e3ea07f590c5bcf9029035cf0efeae5ba8be511a8caada1a4893f5525", size = 9663138 },
-    { url = "https://files.pythonhosted.org/packages/d9/3d/cca659545bd83c67ab784ac2221f8264b3b74e98b2a5aee4f454276ecaf2/mypy-1.11.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2684d3f693073ab89d76da8e3921883019ea8a3ec20fa5d8ecca6a2db4c54bbe", size = 10936143 },
-    { url = "https://files.pythonhosted.org/packages/83/ff/ec6f1015813adb183925b6f9696062b7fb60b1d60761cc06cea85dd7bcb0/mypy-1.11.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:79c07eb282cb457473add5052b63925e5cc97dfab9812ee65a7c7ab5e3cb551c", size = 10105432 },
-    { url = "https://files.pythonhosted.org/packages/08/a3/ffc2ee9b8689920a524a8013bf05482f51d191d73a8a3939f3d47d9a485a/mypy-1.11.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:11965c2f571ded6239977b14deebd3f4c3abd9a92398712d6da3a772974fad69", size = 12493869 },
-    { url = "https://files.pythonhosted.org/packages/7b/6b/830fbf3066dcf79831f360c5b1ae3923cfc248aa6a32ea217f179a210126/mypy-1.11.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a2b43895a0f8154df6519706d9bca8280cda52d3d9d1514b2d9c3e26792a0b74", size = 13016443 },
-    { url = "https://files.pythonhosted.org/packages/0a/ae/8ebca638f6bd9e914501a567a56e3ae64fa4d9c8dfff298618e9409d1156/mypy-1.11.1-cp39-cp39-win_amd64.whl", hash = "sha256:1a81cf05975fd61aec5ae16501a091cfb9f605dc3e3c878c0da32f250b74760b", size = 9567604 },
-    { url = "https://files.pythonhosted.org/packages/f8/d4/4960d0df55f30a7625d9c3c9414dfd42f779caabae137ef73ffaed0c97b9/mypy-1.11.1-py3-none-any.whl", hash = "sha256:0624bdb940255d2dd24e829d99a13cfeb72e4e9031f9492148f410ed30bcab54", size = 2619257 },
+sdist = { url = "https://files.pythonhosted.org/packages/e8/21/7e9e523537991d145ab8a0a2fd98548d67646dc2aaaf6091c31ad883e7c1/mypy-1.13.0.tar.gz", hash = "sha256:0291a61b6fbf3e6673e3405cfcc0e7650bebc7939659fdca2702958038bd835e", size = 3152532 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/5e/8c/206de95a27722b5b5a8c85ba3100467bd86299d92a4f71c6b9aa448bfa2f/mypy-1.13.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6607e0f1dd1fb7f0aca14d936d13fd19eba5e17e1cd2a14f808fa5f8f6d8f60a", size = 11020731 },
+    { url = "https://files.pythonhosted.org/packages/ab/bb/b31695a29eea76b1569fd28b4ab141a1adc9842edde080d1e8e1776862c7/mypy-1.13.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8a21be69bd26fa81b1f80a61ee7ab05b076c674d9b18fb56239d72e21d9f4c80", size = 10184276 },
+    { url = "https://files.pythonhosted.org/packages/a5/2d/4a23849729bb27934a0e079c9c1aad912167d875c7b070382a408d459651/mypy-1.13.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7b2353a44d2179846a096e25691d54d59904559f4232519d420d64da6828a3a7", size = 12587706 },
+    { url = "https://files.pythonhosted.org/packages/5c/c3/d318e38ada50255e22e23353a469c791379825240e71b0ad03e76ca07ae6/mypy-1.13.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:0730d1c6a2739d4511dc4253f8274cdd140c55c32dfb0a4cf8b7a43f40abfa6f", size = 13105586 },
+    { url = "https://files.pythonhosted.org/packages/4a/25/3918bc64952370c3dbdbd8c82c363804678127815febd2925b7273d9482c/mypy-1.13.0-cp310-cp310-win_amd64.whl", hash = "sha256:c5fc54dbb712ff5e5a0fca797e6e0aa25726c7e72c6a5850cfd2adbc1eb0a372", size = 9632318 },
+    { url = "https://files.pythonhosted.org/packages/d0/19/de0822609e5b93d02579075248c7aa6ceaddcea92f00bf4ea8e4c22e3598/mypy-1.13.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:581665e6f3a8a9078f28d5502f4c334c0c8d802ef55ea0e7276a6e409bc0d82d", size = 10939027 },
+    { url = "https://files.pythonhosted.org/packages/c8/71/6950fcc6ca84179137e4cbf7cf41e6b68b4a339a1f5d3e954f8c34e02d66/mypy-1.13.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3ddb5b9bf82e05cc9a627e84707b528e5c7caaa1c55c69e175abb15a761cec2d", size = 10108699 },
+    { url = "https://files.pythonhosted.org/packages/26/50/29d3e7dd166e74dc13d46050b23f7d6d7533acf48f5217663a3719db024e/mypy-1.13.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:20c7ee0bc0d5a9595c46f38beb04201f2620065a93755704e141fcac9f59db2b", size = 12506263 },
+    { url = "https://files.pythonhosted.org/packages/3f/1d/676e76f07f7d5ddcd4227af3938a9c9640f293b7d8a44dd4ff41d4db25c1/mypy-1.13.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3790ded76f0b34bc9c8ba4def8f919dd6a46db0f5a6610fb994fe8efdd447f73", size = 12984688 },
+    { url = "https://files.pythonhosted.org/packages/9c/03/5a85a30ae5407b1d28fab51bd3e2103e52ad0918d1e68f02a7778669a307/mypy-1.13.0-cp311-cp311-win_amd64.whl", hash = "sha256:51f869f4b6b538229c1d1bcc1dd7d119817206e2bc54e8e374b3dfa202defcca", size = 9626811 },
+    { url = "https://files.pythonhosted.org/packages/fb/31/c526a7bd2e5c710ae47717c7a5f53f616db6d9097caf48ad650581e81748/mypy-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:5c7051a3461ae84dfb5dd15eff5094640c61c5f22257c8b766794e6dd85e72d5", size = 11077900 },
+    { url = "https://files.pythonhosted.org/packages/83/67/b7419c6b503679d10bd26fc67529bc6a1f7a5f220bbb9f292dc10d33352f/mypy-1.13.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:39bb21c69a5d6342f4ce526e4584bc5c197fd20a60d14a8624d8743fffb9472e", size = 10074818 },
+    { url = "https://files.pythonhosted.org/packages/ba/07/37d67048786ae84e6612575e173d713c9a05d0ae495dde1e68d972207d98/mypy-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:164f28cb9d6367439031f4c81e84d3ccaa1e19232d9d05d37cb0bd880d3f93c2", size = 12589275 },
+    { url = "https://files.pythonhosted.org/packages/1f/17/b1018c6bb3e9f1ce3956722b3bf91bff86c1cefccca71cec05eae49d6d41/mypy-1.13.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a4c1bfcdbce96ff5d96fc9b08e3831acb30dc44ab02671eca5953eadad07d6d0", size = 13037783 },
+    { url = "https://files.pythonhosted.org/packages/cb/32/cd540755579e54a88099aee0287086d996f5a24281a673f78a0e14dba150/mypy-1.13.0-cp312-cp312-win_amd64.whl", hash = "sha256:a0affb3a79a256b4183ba09811e3577c5163ed06685e4d4b46429a271ba174d2", size = 9726197 },
+    { url = "https://files.pythonhosted.org/packages/11/bb/ab4cfdc562cad80418f077d8be9b4491ee4fb257440da951b85cbb0a639e/mypy-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:a7b44178c9760ce1a43f544e595d35ed61ac2c3de306599fa59b38a6048e1aa7", size = 11069721 },
+    { url = "https://files.pythonhosted.org/packages/59/3b/a393b1607cb749ea2c621def5ba8c58308ff05e30d9dbdc7c15028bca111/mypy-1.13.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5d5092efb8516d08440e36626f0153b5006d4088c1d663d88bf79625af3d1d62", size = 10063996 },
+    { url = "https://files.pythonhosted.org/packages/d1/1f/6b76be289a5a521bb1caedc1f08e76ff17ab59061007f201a8a18cc514d1/mypy-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:de2904956dac40ced10931ac967ae63c5089bd498542194b436eb097a9f77bc8", size = 12584043 },
+    { url = "https://files.pythonhosted.org/packages/a6/83/5a85c9a5976c6f96e3a5a7591aa28b4a6ca3a07e9e5ba0cec090c8b596d6/mypy-1.13.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:7bfd8836970d33c2105562650656b6846149374dc8ed77d98424b40b09340ba7", size = 13036996 },
+    { url = "https://files.pythonhosted.org/packages/b4/59/c39a6f752f1f893fccbcf1bdd2aca67c79c842402b5283563d006a67cf76/mypy-1.13.0-cp313-cp313-win_amd64.whl", hash = "sha256:9f73dba9ec77acb86457a8fc04b5239822df0c14a082564737833d2963677dbc", size = 9737709 },
+    { url = "https://files.pythonhosted.org/packages/5f/d4/b33ddd40dad230efb317898a2d1c267c04edba73bc5086bf77edeb410fb2/mypy-1.13.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:0246bcb1b5de7f08f2826451abd947bf656945209b140d16ed317f65a17dc7dc", size = 11013906 },
+    { url = "https://files.pythonhosted.org/packages/f4/e6/f414bca465b44d01cd5f4a82761e15044bedd1bf8025c5af3cc64518fac5/mypy-1.13.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7f5b7deae912cf8b77e990b9280f170381fdfbddf61b4ef80927edd813163732", size = 10180657 },
+    { url = "https://files.pythonhosted.org/packages/38/e9/fc3865e417722f98d58409770be01afb961e2c1f99930659ff4ae7ca8b7e/mypy-1.13.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7029881ec6ffb8bc233a4fa364736789582c738217b133f1b55967115288a2bc", size = 12586394 },
+    { url = "https://files.pythonhosted.org/packages/2e/35/f4d8b6d2cb0b3dad63e96caf159419dda023f45a358c6c9ac582ccaee354/mypy-1.13.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:3e38b980e5681f28f033f3be86b099a247b13c491f14bb8b1e1e134d23bb599d", size = 13103591 },
+    { url = "https://files.pythonhosted.org/packages/22/1d/80594aef135f921dd52e142fa0acd19df197690bd0cde42cea7b88cf5aa2/mypy-1.13.0-cp39-cp39-win_amd64.whl", hash = "sha256:a6789be98a2017c912ae6ccb77ea553bbaf13d27605d2ca20a76dfbced631b24", size = 9634690 },
+    { url = "https://files.pythonhosted.org/packages/3b/86/72ce7f57431d87a7ff17d442f521146a6585019eb8f4f31b7c02801f78ad/mypy-1.13.0-py3-none-any.whl", hash = "sha256:9c250883f9fd81d212e0952c92dbfcc96fc237f4b7c92f56ac81fd48460b3e5a", size = 2647043 },
+]
+
+[package.optional-dependencies]
+faster-cache = [
+    { name = "orjson" },
 ]
 
 [[package]]

meilisearch_python_sdk-3.5.1/meilisearch_python_sdk/_version.py

@@ -1 +0,0 @@
-VERSION = "3.5.1"