Merge remote-tracking branch 'origin/main' into network

Author: sanders41

.github/workflows/testing.yml

@@ -50,7 +50,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v5.4.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -90,7 +90,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v5.4.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -118,7 +118,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v5.4.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -158,7 +158,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v5.4.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "4.4.0"
+VERSION = "4.5.0"

meilisearch_python_sdk/index.py

@@ -29,6 +29,8 @@
 from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
+    FilterableAttributeFeatures,
+    FilterableAttributes,
     HuggingFaceEmbedder,
     LocalizedAttributes,
     MeilisearchSettings,
@@ -990,6 +992,7 @@ async def facet_search(
         vector: list[float] | None = None,
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
+        exhaustive_facet_count: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -1043,6 +1046,9 @@ async def facet_search(
             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.
             retrieve_vectors: Return document vector data with search result.
+            exhaustive_facet_count: forcing the facet search to compute the facet counts the same
+                way as the paginated search. This parameter can only be used with Milisearch >=
+                v1.14.0. Defaults to None.
 
         Returns:
             Results of the search
@@ -1091,6 +1097,7 @@ async def facet_search(
             vector=vector,
             locales=locales,
             retrieve_vectors=retrieve_vectors,
+            exhaustive_facet_count=exhaustive_facet_count,
         )
         search_url = f"{self._base_url_with_uid}/facet-search"
 
@@ -1120,6 +1127,7 @@ async def facet_search(
                 show_ranking_score_details=show_ranking_score_details,
                 ranking_score_threshold=ranking_score_threshold,
                 vector=vector,
+                exhaustive_facet_count=exhaustive_facet_count,
             )
 
         if self._concurrent_facet_search_plugins:
@@ -1152,6 +1160,7 @@ async def facet_search(
                                 show_ranking_score_details=show_ranking_score_details,
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
+                                exhaustive_facet_count=exhaustive_facet_count,
                             )
                         )
 
@@ -1195,6 +1204,7 @@ async def facet_search(
                                 show_ranking_score_details=show_ranking_score_details,
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
+                                exhaustive_facet_count=exhaustive_facet_count,
                             )
                         )
 
@@ -3568,11 +3578,11 @@ async def reset_synonyms(self) -> TaskInfo:
 
         return TaskInfo(**response.json())
 
-    async def get_filterable_attributes(self) -> list[str] | None:
+    async def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
-            List containing the filterable attributes of the index.
+            Filterable attributes of the index.
 
         Raises:
             MeilisearchCommunicationError: If there was an error communicating with the server.
@@ -3589,10 +3599,24 @@ async def get_filterable_attributes(self) -> list[str] | None:
         if not response.json():
             return None
 
-        return response.json()
+        response_json = response.json()
+
+        if isinstance(response_json[0], str):
+            return response_json
+
+        filterable_attributes = []
+        for r in response_json:
+            filterable_attributes.append(
+                FilterableAttributes(
+                    attribute_patterns=r["attributePatterns"],
+                    features=FilterableAttributeFeatures(**r["features"]),
+                )
+            )
+
+        return filterable_attributes
 
     async def update_filterable_attributes(
-        self, body: list[str], *, compress: bool = False
+        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
     ) -> TaskInfo:
         """Update filterable attributes of the index.
 
@@ -3613,8 +3637,16 @@ async def update_filterable_attributes(
             >>>     index = client.index("movies")
             >>>     await index.update_filterable_attributes(["genre", "director"])
         """
+        payload: list[str | JsonDict] = []
+
+        for b in body:
+            if isinstance(b, FilterableAttributes):
+                payload.append(b.model_dump(by_alias=True))
+            else:
+                payload.append(b)
+
         response = await self._http_requests.put(
-            f"{self._settings_url}/filterable-attributes", body, compress=compress
+            f"{self._settings_url}/filterable-attributes", payload, compress=compress
         )
 
         return TaskInfo(**response.json())
@@ -5292,6 +5324,7 @@ def facet_search(
         vector: list[float] | None = None,
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
+        exhaustive_facet_count: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -5345,6 +5378,9 @@ def facet_search(
             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.
             retrieve_vectors: Return document vector data with search result.
+            exhaustive_facet_count: forcing the facet search to compute the facet counts the same
+                way as the paginated search. This parameter can only be used with Milisearch >=
+                v1.14.0. Defaults to None.
 
         Returns:
             Results of the search
@@ -5393,6 +5429,7 @@ def facet_search(
             vector=vector,
             locales=locales,
             retrieve_vectors=retrieve_vectors,
+            exhaustive_facet_count=exhaustive_facet_count,
         )
 
         if self._pre_facet_search_plugins:
@@ -5421,6 +5458,7 @@ def facet_search(
                 show_ranking_score_details=show_ranking_score_details,
                 ranking_score_threshold=ranking_score_threshold,
                 vector=vector,
+                exhaustive_facet_count=exhaustive_facet_count,
             )
 
         response = self._http_requests.post(f"{self._base_url_with_uid}/facet-search", body=body)
@@ -7156,7 +7194,7 @@ def reset_synonyms(self) -> TaskInfo:
 
         return TaskInfo(**response.json())
 
-    def get_filterable_attributes(self) -> list[str] | None:
+    def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
@@ -7177,9 +7215,25 @@ def get_filterable_attributes(self) -> list[str] | None:
         if not response.json():
             return None
 
-        return response.json()
+        response_json = response.json()
+
+        if isinstance(response_json[0], str):
+            return response_json
+
+        filterable_attributes = []
+        for r in response_json:
+            filterable_attributes.append(
+                FilterableAttributes(
+                    attribute_patterns=r["attributePatterns"],
+                    features=FilterableAttributeFeatures(**r["features"]),
+                )
+            )
 
-    def update_filterable_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
+        return filterable_attributes
+
+    def update_filterable_attributes(
+        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
+    ) -> TaskInfo:
         """Update filterable attributes of the index.
 
         Args:
@@ -7199,8 +7253,16 @@ def update_filterable_attributes(self, body: list[str], *, compress: bool = Fals
             >>> index = client.index("movies")
             >>> index.update_filterable_attributes(["genre", "director"])
         """
+        payload: list[str | JsonDict] = []
+
+        for b in body:
+            if isinstance(b, FilterableAttributes):
+                payload.append(b.model_dump(by_alias=True))
+            else:
+                payload.append(b)
+
         response = self._http_requests.put(
-            f"{self._settings_url}/filterable-attributes", body, compress=compress
+            f"{self._settings_url}/filterable-attributes", payload, compress=compress
         )
 
         return TaskInfo(**response.json())
@@ -8326,6 +8388,7 @@ def _process_search_parameters(
     hybrid: Hybrid | None = None,
     locales: list[str] | None = None,
     retrieve_vectors: bool | None = None,
+    exhaustive_facet_count: bool | None = None,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -8377,6 +8440,9 @@ def _process_search_parameters(
     if retrieve_vectors is not None:
         body["retrieveVectors"] = retrieve_vectors
 
+    if exhaustive_facet_count is not None:
+        body["exhaustivefacetCount"] = exhaustive_facet_count
+
     return body
 
 

meilisearch_python_sdk/models/batch.py

@@ -26,6 +26,9 @@ class Stats(CamelBase):
     status: Status
     batch_types: JsonDict | None = Field(None, alias="types")
     index_uids: JsonDict | None = None
+    progress_trace: JsonDict | None = None
+    write_channel_congestion: JsonDict | None = None
+    internal_database_sizes: JsonDict | None = None
 
 
 class BatchResult(BatchId):

meilisearch_python_sdk/models/settings.py

@@ -68,6 +68,7 @@ class HuggingFaceEmbedder(CamelBase):
     distribution: Distribution | None = None
     dimensions: int | None = None
     binary_quantized: bool | None = None
+    pooling: Literal["useModel", "forceMean", "forceCls"] | None = None
 
 
 class OllamaEmbedder(CamelBase):
@@ -122,11 +123,26 @@ class LocalizedAttributes(CamelBase):
     attribute_patterns: list[str]
 
 
+class Filter(CamelBase):
+    equality: bool
+    comparison: bool
+
+
+class FilterableAttributeFeatures(CamelBase):
+    facet_search: bool
+    filter: Filter
+
+
+class FilterableAttributes(CamelBase):
+    attribute_patterns: list[str]
+    features: FilterableAttributeFeatures
+
+
 class MeilisearchSettings(CamelBase):
     synonyms: JsonDict | None = None
     stop_words: list[str] | None = None
     ranking_rules: list[str] | None = None
-    filterable_attributes: list[str] | None = None
+    filterable_attributes: list[str] | list[FilterableAttributes] | None = None
     distinct_attribute: str | None = None
     searchable_attributes: list[str] | None = None
     displayed_attributes: list[str] | None = None

tests/test_async_index.py

@@ -7,6 +7,9 @@
 from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
+    Filter,
+    FilterableAttributeFeatures,
+    FilterableAttributes,
     LocalizedAttributes,
     MinWordSizeForTypos,
     OpenAiEmbedder,
@@ -63,11 +66,6 @@ def new_synonyms():
     return {"hp": ["harry potter"]}
 
 
-@pytest.fixture
-def filterable_attributes():
-    return ["release_date", "title"]
-
-
 @pytest.fixture
 def default_pagination():
     return Pagination(max_total_hits=1000)
@@ -577,6 +575,20 @@ async def test_get_filterable_attributes(async_empty_index):
 
 
 @pytest.mark.parametrize("compress", (True, False))
+@pytest.mark.parametrize(
+    "filterable_attributes",
+    (
+        ["release_date", "title"],
+        [
+            FilterableAttributes(
+                attribute_patterns=["release_date", "title"],
+                features=FilterableAttributeFeatures(
+                    facet_search=True, filter=Filter(equality=True, comparison=False)
+                ),
+            ),
+        ],
+    ),
+)
 async def test_update_filterable_attributes(compress, async_empty_index, filterable_attributes):
     index = await async_empty_index()
     response = await index.update_filterable_attributes(filterable_attributes, compress=compress)
@@ -585,6 +597,20 @@ async def test_update_filterable_attributes(compress, async_empty_index, filtera
     assert sorted(response) == filterable_attributes
 
 
+@pytest.mark.parametrize(
+    "filterable_attributes",
+    (
+        ["release_date", "title"],
+        [
+            FilterableAttributes(
+                attribute_patterns=["release_date", "title"],
+                features=FilterableAttributeFeatures(
+                    facet_search=True, filter=Filter(equality=True, comparison=False)
+                ),
+            ),
+        ],
+    ),
+)
 async def test_reset_filterable_attributes(async_empty_index, filterable_attributes):
     index = await async_empty_index()
     response = await index.update_filterable_attributes(filterable_attributes)

tests/test_async_search.py

@@ -576,6 +576,20 @@ async def test_facet_search_locales(async_index_with_documents):
     assert response.facet_hits[0].count == 1
 
 
+async def test_facet_search_exhaustive_facet_count(async_index_with_documents):
+    index = await async_index_with_documents()
+    update = await index.update_filterable_attributes(["genre"])
+    await async_wait_for_task(index.http_client, update.task_uid)
+    response = await index.facet_search(
+        "How to Train Your Dragon",
+        facet_name="genre",
+        facet_query="cartoon",
+        exhaustive_facet_count=True,
+    )
+
+    assert response.facet_hits[0].value == "cartoon"
+
+
 @pytest.mark.parametrize("ranking_score_threshold", (-0.1, 1.1))
 async def test_search_invalid_ranking_score_threshold(
     ranking_score_threshold, async_index_with_documents