Merge pull request #1094 from sanders41/meilisearch-1.11.0

Update for Meilisearch v1.11.0

Author: sanders41

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",
+      ]

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/_client.py

@@ -24,6 +24,7 @@
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.search import (
     Federation,
+    FederationMerged,
     SearchParams,
     SearchResultsFederated,
     SearchResultsWithUID,
@@ -587,7 +588,7 @@ async def multi_search(
         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 @@ async def multi_search(
         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 @@ def multi_search(
         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 @@ def multi_search(
         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/index.py

@@ -3079,7 +3079,11 @@ async def update_settings(
             >>>     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 @@ async def update_embedders(self, embedders: Embedders, *, compress: bool = False
         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 @@ def update_settings(self, body: MeilisearchSettings, *, compress: bool = False)
             >>> 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 @@ def update_embedders(self, embedders: Embedders, *, compress: bool = False) -> T
         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/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

tests/test_async_search.py

@@ -9,7 +9,13 @@
 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()

tests/test_search.py

@@ -9,7 +9,13 @@
 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()