Merge pull request #660 from sanders41/meilisearch-1.4.0

Update for Meilisearch v1.4.0

Author: sanders41

meilisearch_python_async/index.py

@@ -2332,6 +2332,10 @@ async def get_sortable_attributes(self) -> list[str]:
     async def update_sortable_attributes(self, sortable_attributes: list[str]) -> TaskInfo:
         """Get sortable attributes of the Index.
 
+        Args:
+
+            sortable_attributes: List of attributes for searching.
+
         Returns:
 
             The details of the task status.
@@ -2404,6 +2408,10 @@ async def get_typo_tolerance(self) -> TypoTolerance:
     async def update_typo_tolerance(self, typo_tolerance: TypoTolerance) -> TaskInfo:
         """Update typo tolerance.
 
+        Args:
+
+            typo_tolerance: Typo tolerance settings.
+
         Returns:
 
             Task to track the action.
@@ -2481,6 +2489,10 @@ async def get_faceting(self) -> Faceting:
     async def update_faceting(self, faceting: Faceting) -> TaskInfo:
         """Partially update the faceting settings for an index.
 
+        Args:
+
+            faceting: Faceting values.
+
         Returns:
 
             Task to track the action.
@@ -2557,6 +2569,10 @@ async def get_pagination(self) -> Pagination:
     async def update_pagination(self, settings: Pagination) -> TaskInfo:
         """Partially update the pagination settings for an index.
 
+        Args:
+
+            settings: settings for pagination.
+
         Returns:
 
             Task to track the action.
@@ -2607,6 +2623,234 @@ async def reset_pagination(self) -> TaskInfo:
 
         return TaskInfo(**response.json())
 
+    async def get_separator_tokens(self) -> list[str]:
+        """Get separator token settings for the index.
+
+        Returns:
+
+            Separator tokens for the index.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     separator_token_settings = await index.get_separator_tokens()
+        """
+        url = f"{self._settings_url}/separator-tokens"
+        response = await self._http_requests.get(url)
+
+        return response.json()
+
+    async def update_separator_tokens(self, separator_tokens: list[str]) -> TaskInfo:
+        """Update the separator tokens settings for an index.
+
+        Args:
+
+            separator_tokens: List of separator tokens.
+
+        Returns:
+
+            Task to track the action.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_python_async import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.update_separator_tokens(separator_tokenes=["|", "/")
+        """
+        url = f"{self._settings_url}/separator-tokens"
+        response = await self._http_requests.put(url, separator_tokens)
+
+        return TaskInfo(**response.json())
+
+    async def reset_separator_tokens(self) -> TaskInfo:
+        """Reset an index's separator tokens settings to the default value.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.reset_separator_tokens()
+        """
+        url = f"{self._settings_url}/separator-tokens"
+        response = await self._http_requests.delete(url)
+
+        return TaskInfo(**response.json())
+
+    async def get_non_separator_tokens(self) -> list[str]:
+        """Get non-separator token settings for the index.
+
+        Returns:
+
+            Non-separator tokens for the index.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     non_separator_token_settings = await index.get_non_separator_tokens()
+        """
+        url = f"{self._settings_url}/non-separator-tokens"
+        response = await self._http_requests.get(url)
+
+        return response.json()
+
+    async def update_non_separator_tokens(self, non_separator_tokens: list[str]) -> TaskInfo:
+        """Update the non-separator tokens settings for an index.
+
+        Args:
+
+            non_separator_tokens: List of non-separator tokens.
+
+        Returns:
+
+            Task to track the action.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_python_async import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.update_non_separator_tokens(non_separator_tokens=["@", "#")
+        """
+        url = f"{self._settings_url}/non-separator-tokens"
+        response = await self._http_requests.put(url, non_separator_tokens)
+
+        return TaskInfo(**response.json())
+
+    async def reset_non_separator_tokens(self) -> TaskInfo:
+        """Reset an index's non-separator tokens settings to the default value.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.reset_non_separator_tokens()
+        """
+        url = f"{self._settings_url}/non-separator-tokens"
+        response = await self._http_requests.delete(url)
+
+        return TaskInfo(**response.json())
+
+    async def get_word_dictionary(self) -> list[str]:
+        """Get word dictionary settings for the index.
+
+        Returns:
+
+            Word dictionary for the index.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     word_dictionary = await index.get_word_dictionary()
+        """
+        url = f"{self._settings_url}/dictionary"
+        response = await self._http_requests.get(url)
+
+        return response.json()
+
+    async def update_word_dictionary(self, dictionary: list[str]) -> TaskInfo:
+        """Update the word dictionary settings for an index.
+
+        Args:
+
+            dictionary: List of dictionary values.
+
+        Returns:
+
+            Task to track the action.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_python_async import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.update_word_dictionary(dictionary=["S.O.S", "S.O")
+        """
+        url = f"{self._settings_url}/dictionary"
+        response = await self._http_requests.put(url, dictionary)
+
+        return TaskInfo(**response.json())
+
+    async def reset_word_dictionary(self) -> TaskInfo:
+        """Reset an index's word dictionary settings to the default value.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_async_client import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.reset_word_dictionary()
+        """
+        url = f"{self._settings_url}/dictionary"
+        response = await self._http_requests.delete(url)
+
+        return TaskInfo(**response.json())
+
 
 def _batch(documents: list[dict], batch_size: int) -> Generator[list[dict], None, None]:
     total_len = len(documents)

meilisearch_python_async/models/settings.py

@@ -67,3 +67,6 @@ class MeilisearchSettings(CamelBase):
     typo_tolerance: Optional[TypoTolerance] = None
     faceting: Optional[Faceting] = None
     pagination: Optional[Pagination] = None
+    separator_tokens: Optional[List[str]] = None
+    non_separator_tokens: Optional[List[str]] = None
+    dictionary: Optional[List[str]] = None