Merge branch 'main' into remote_fedarated_search

Author: brunoocasali

.code-samples.meilisearch.yaml

@@ -360,6 +360,10 @@ typo_tolerance_guide_4: |-
       'twoTypos': 10
     }
   })
+typo_tolerance_guide_5: |-
+  client.index('movies').update_typo_tolerance({
+    'disableOnNumbers': True
+  })
 search_parameter_guide_show_ranking_score_1: |-
   client.index('movies').search('dragon', {
     'showRankingScore': True
@@ -626,6 +630,12 @@ update_pagination_settings_1: |-
   client.index('books').update_pagination_settings({'maxTotalHits': 100})
 reset_pagination_settings_1: |-
   client.index('books').reset_pagination_settings()
+get_facet_search_settings_1: |-
+  client.index('books').get_facet_search_settings()
+update_facet_search_settings_1: |-
+  client.index('books').update_facet_search_settings(False)
+reset_facet_search_settings_1: |-
+  client.index('books').reset_facet_search_settings()
 get_faceting_settings_1: |-
   client.index('books').get_faceting_settings()
 update_faceting_settings_1: |-
@@ -716,6 +726,12 @@ update_search_cutoff_1: |-
   client.index('movies').update_search_cutoff_ms(150)
 reset_search_cutoff_1: |-
   client.index('movies').reset_search_cutoff_ms()
+get_prefix_search_settings_1: |-
+  client.index('books').get_prefix_search()
+update_prefix_search_settings_1: |-
+  client.index('books').update_prefix_search(PrefixSearch.DISABLED)
+reset_prefix_search_settings_1: |-
+  client.index('books').reset_prefix_search()
 get_proximity_precision_settings_1: |-
   client.index('books').get_proximity_precision()
 update_proximity_precision_settings_1: |-

.github/workflows/tests.yml

@@ -8,6 +8,7 @@ on:
       - trying
       - staging
       - main
+  merge_group:
 
 jobs:
   integration_tests:

Pipfile.lock

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   package:
     build: .

docker-compose.yml

@@ -12,7 +12,7 @@
     MeilisearchCommunicationError,
     MeilisearchTimeoutError,
 )
-from meilisearch.models.index import ProximityPrecision
+from meilisearch.models.index import PrefixSearch, ProximityPrecision
 from meilisearch.version import qualified_version
 
 
@@ -36,6 +36,7 @@ def send_request(
                 Mapping[str, Any],
                 Sequence[Mapping[str, Any]],
                 List[str],
+                bool,
                 bytes,
                 str,
                 int,
@@ -67,7 +68,7 @@ def send_request(
                 serialize_body = isinstance(body, dict) or body
                 data = (
                     json.dumps(body, cls=serializer)
-                    if serialize_body
+                    if isinstance(body, bool) or serialize_body
                     else "" if body == "" else "null"
                 )
 
@@ -80,6 +81,16 @@ def send_request(
             raise MeilisearchTimeoutError(str(err)) from err
         except requests.exceptions.ConnectionError as err:
             raise MeilisearchCommunicationError(str(err)) from err
+        except requests.exceptions.InvalidSchema as err:
+            if "://" not in self.config.url:
+                raise MeilisearchCommunicationError(
+                    f"""
+                    Invalid URL {self.config.url}, no scheme/protocol supplied.
+                    Did you mean https://{self.config.url}?
+                    """
+                ) from err
+
+            raise MeilisearchCommunicationError(str(err)) from err
 
     def get(self, path: str) -> Any:
         return self.send_request(requests.get, path)
@@ -114,9 +125,11 @@ def put(
                 Mapping[str, Any],
                 Sequence[Mapping[str, Any]],
                 List[str],
+                bool,
                 bytes,
                 str,
                 int,
+                PrefixSearch,
                 ProximityPrecision,
             ]
         ] = None,

meilisearch/_httprequests.py

@@ -42,6 +42,7 @@ class Paths:
         swap = "swap-indexes"
         embedders = "embedders"
         search_cutoff_ms = "search-cutoff-ms"
+        prefix_search = "prefix-search"
         proximity_precision = "proximity-precision"
         localized_attributes = "localized-attributes"
         edit = "edit"

meilisearch/config.py

@@ -25,6 +25,7 @@
 from meilisearch.errors import version_error_hint_message
 from meilisearch.models.document import Document, DocumentsResults
 from meilisearch.models.embedders import (
+    CompositeEmbedder,
     Embedders,
     EmbedderType,
     HuggingFaceEmbedder,
@@ -38,6 +39,7 @@
     IndexStats,
     LocalizedAttributes,
     Pagination,
+    PrefixSearch,
     ProximityPrecision,
     TypoTolerance,
 )
@@ -977,6 +979,8 @@ def get_settings(self) -> Dict[str, Any]:
                     embedders[k] = HuggingFaceEmbedder(**v)
                 elif v.get("source") == "rest":
                     embedders[k] = RestEmbedder(**v)
+                elif v.get("source") == "composite":
+                    embedders[k] = CompositeEmbedder(**v)
                 else:
                     embedders[k] = UserProvidedEmbedder(**v)
 
@@ -1662,6 +1666,57 @@ def reset_pagination_settings(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    def get_facet_search_settings(self) -> bool:
+        """Get the facet search settings of an index.
+
+        Returns
+        -------
+        bool:
+            True if facet search is enabled, False if disabled.
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+
+        return self.http.get(self.__settings_url_for(self.config.paths.facet_search))
+
+    def update_facet_search_settings(self, body: Union[bool, None]) -> TaskInfo:
+        """Update the facet search settings of the index.
+
+        Parameters
+        ----------
+        body: bool
+            True to enable facet search, False to disable it.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        task = self.http.put(self.__settings_url_for(self.config.paths.facet_search), body=body)
+
+        return TaskInfo(**task)
+
+    def reset_facet_search_settings(self) -> TaskInfo:
+        """Reset facet search settings of the index to default values.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks
+        """
+        task = self.http.delete(self.__settings_url_for(self.config.paths.facet_search))
+
+        return TaskInfo(**task)
+
     def get_faceting_settings(self) -> Faceting:
         """Get the faceting settings of an index.
 
@@ -1675,7 +1730,6 @@ def get_faceting_settings(self) -> Faceting:
         MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
         """
-
         faceting = self.http.get(self.__settings_url_for(self.config.paths.faceting))
 
         return Faceting(**faceting)
@@ -1934,6 +1988,8 @@ def get_embedders(self) -> Embedders | None:
                 embedders[k] = OllamaEmbedder(**v)
             elif source == "rest":
                 embedders[k] = RestEmbedder(**v)
+            elif source == "composite":
+                embedders[k] = CompositeEmbedder(**v)
             elif source == "userProvided":
                 embedders[k] = UserProvidedEmbedder(**v)
             else:
@@ -1977,6 +2033,8 @@ def update_embedders(self, body: Union[MutableMapping[str, Any], None]) -> TaskI
                     embedders[k] = OllamaEmbedder(**v)
                 elif source == "rest":
                     embedders[k] = RestEmbedder(**v)
+                elif source == "composite":
+                    embedders[k] = CompositeEmbedder(**v)
                 elif source == "userProvided":
                     embedders[k] = UserProvidedEmbedder(**v)
                 else:
@@ -2071,6 +2129,58 @@ def reset_search_cutoff_ms(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    # PREFIX SEARCH
+
+    def get_prefix_search(self) -> PrefixSearch:
+        """Get the prefix search settings of an index.
+
+        Returns
+        -------
+        settings:
+            The prefix search settings of the index.
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        prefix_search = self.http.get(self.__settings_url_for(self.config.paths.prefix_search))
+
+        return PrefixSearch[to_snake(prefix_search).upper()]
+
+    def update_prefix_search(self, body: Union[PrefixSearch, None]) -> TaskInfo:
+        """Update the prefix search settings of the index.
+
+        Parameters
+        ----------
+        body:
+            Prefix search settings
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks
+        """
+        task = self.http.put(self.__settings_url_for(self.config.paths.prefix_search), body)
+
+        return TaskInfo(**task)
+
+    def reset_prefix_search(self) -> TaskInfo:
+        """Reset the prefix search settings of the index
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks
+        """
+        task = self.http.delete(
+            self.__settings_url_for(self.config.paths.prefix_search),
+        )
+
+        return TaskInfo(**task)
+
     # PROXIMITY PRECISION SETTINGS
 
     def get_proximity_precision(self) -> ProximityPrecision:

meilisearch/index.py

@@ -2,16 +2,12 @@
 
 
 class Document:
-    __doc: Dict
-
     def __init__(self, doc: Dict[str, Any]) -> None:
-        self.__doc = doc
-        for key in doc:
-            setattr(self, key, doc[key])
+        self.__dict__.update(**doc)
 
-    def __getattr__(self, attr: str) -> str:
-        if attr in self.__doc.keys():
-            return attr
+    def __getattr__(self, attr: str) -> Any:
+        if attr in self.__dict__:
+            return self.__dict__[attr]
         raise AttributeError(f"{self.__class__.__name__} object has no attribute {attr}")
 
     def __iter__(self) -> Iterator: