Index

Index Usage

The Index uses blocking methods, and and should be used when using the Client. When you create a new index with the Client it will create an Index instance.

Index API

Bases: _BaseIndex

Index class gives access to all indexes routes and child routes.

https://docs.meilisearch.com/reference/api/indexes.html

Source code in meilisearch_python_sdk/index.py

class Index(_BaseIndex):
    """Index class gives access to all indexes routes and child routes.

    https://docs.meilisearch.com/reference/api/indexes.html
    """

    def __init__(
        self,
        http_client: Client,
        uid: str,
        primary_key: str | None = None,
        created_at: str | datetime | None = None,
        updated_at: str | datetime | None = None,
        plugins: IndexPlugins | None = None,
        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
        *,
        hits_type: Any = JsonDict,
    ):
        """Class initializer.

        Args:
            http_client: An instance of the Client. This automatically gets passed by the
                Client when creating and Index instance.
            uid: The index's unique identifier.
            primary_key: The primary key of the documents. Defaults to None.
            created_at: The date and time the index was created. Defaults to None.
            updated_at: The date and time the index was last updated. Defaults to None.
            plugins: Optional plugins can be provided to extend functionality.
            json_handler: The module to use for json operations. The options are BuiltinHandler
                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                extra needs to be included. Default: BuiltinHandler.
            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                JsonDict
        """
        super().__init__(
            uid=uid,
            primary_key=primary_key,
            created_at=created_at,
            updated_at=updated_at,
            json_handler=json_handler,
            hits_type=hits_type,
        )
        self.http_client = http_client
        self._http_requests = HttpRequests(http_client, json_handler=self._json_handler)
        self.plugins = plugins

    @cached_property
    def _post_add_documents_plugins(self) -> list[Plugin | DocumentPlugin] | None:
        if not self.plugins or not self.plugins.add_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_add_documents_plugins(self) -> list[Plugin | DocumentPlugin] | None:
        if not self.plugins or not self.plugins.add_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_delete_all_documents_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_all_documents_plugins:
            return None

        plugins = [
            plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.POST_EVENT
        ]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_delete_all_documents_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_all_documents_plugins:
            return None

        plugins = [
            plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.PRE_EVENT
        ]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_delete_document_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_document_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_delete_document_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_document_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_delete_documents_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_delete_documents_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_delete_documents_by_filter_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
            return None

        plugins = [
            plugin
            for plugin in self.plugins.delete_documents_by_filter_plugins
            if plugin.POST_EVENT
        ]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_delete_documents_by_filter_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
            return None

        plugins = [
            plugin for plugin in self.plugins.delete_documents_by_filter_plugins if plugin.PRE_EVENT
        ]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_facet_search_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.facet_search_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_facet_search_plugins(self) -> list[Plugin] | None:
        if not self.plugins or not self.plugins.facet_search_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_search_plugins(self) -> list[Plugin | PostSearchPlugin] | None:
        if not self.plugins or not self.plugins.search_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.search_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_search_plugins(self) -> list[Plugin | PostSearchPlugin] | None:
        if not self.plugins or not self.plugins.search_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.search_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _post_update_documents_plugins(self) -> list[Plugin | DocumentPlugin] | None:
        if not self.plugins or not self.plugins.update_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.POST_EVENT]

        if not plugins:
            return None

        return plugins

    @cached_property
    def _pre_update_documents_plugins(self) -> list[Plugin | DocumentPlugin] | None:
        if not self.plugins or not self.plugins.update_documents_plugins:
            return None

        plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.PRE_EVENT]

        if not plugins:
            return None

        return plugins

    def delete(self) -> TaskInfo:
        """Deletes the index.

        Returns:
            The details of the task.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete()
        """
        response = self._http_requests.delete(self._base_url_with_uid)
        return TaskInfo(**response.json())

    def delete_if_exists(self) -> bool:
        """Delete the index if it already exists.

        Returns:
            True if the index was deleted or False if not.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_if_exists()
        """
        response = self.delete()
        status = wait_for_task(self.http_client, response.task_uid, timeout_in_ms=100000)
        if status.status == "succeeded":
            return True

        return False

    def update(self, primary_key: str) -> Self:
        """Update the index primary key.

        Args:
            primary_key: The primary key of the documents.

        Returns:
            An instance of the AsyncIndex with the updated information.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> updated_index = index.update()
        """
        payload = {"primaryKey": primary_key}
        response = self._http_requests.patch(self._base_url_with_uid, payload)
        wait_for_task(self.http_client, response.json()["taskUid"], timeout_in_ms=100000)
        index_response = self._http_requests.get(self._base_url_with_uid)
        self.primary_key = index_response.json()["primaryKey"]
        return self

    def fetch_info(self) -> Self:
        """Gets the infromation about the index.

        Returns:
            An instance of the AsyncIndex containing the retrieved information.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index_info = index.fetch_info()
        """
        response = self._http_requests.get(self._base_url_with_uid)
        index_dict = response.json()
        self._set_fetch_info(
            index_dict["primaryKey"], index_dict["createdAt"], index_dict["updatedAt"]
        )
        return self

    def get_primary_key(self) -> str | None:
        """Get the primary key.

        Returns:
            The primary key for the documents in the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> primary_key = index.get_primary_key()
        """
        info = self.fetch_info()
        return info.primary_key

    @classmethod
    def create(
        cls,
        http_client: Client,
        uid: str,
        primary_key: str | None = None,
        *,
        settings: MeilisearchSettings | None = None,
        wait: bool = True,
        timeout_in_ms: int | None = None,
        plugins: IndexPlugins | None = None,
        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
        hits_type: Any = JsonDict,
    ) -> Self:
        """Creates a new index.

        In general this method should not be used directly and instead the index should be created
        through the `Client`.

        Args:
            http_client: An instance of the Client. This automatically gets passed by the Client
                when creating an Index instance.
            uid: The index's unique identifier.
            primary_key: The primary key of the documents. Defaults to None.
            settings: Settings for the index. The settings can also be updated independently of
                creating the index. The advantage to updating them here is updating the settings after
                adding documents will cause the documents to be re-indexed. Because of this it will be
                faster to update them before adding documents. Defaults to None (i.e. default
                Meilisearch index settings).
            wait: If set to True and settings are being updated, the index will be returned after
                the settings update has completed. If False it will not wait for settings to complete.
                Default: True
            timeout_in_ms: Amount of time in milliseconds to wait before raising a
                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
                if the `None` option is used the wait time could be very long. Defaults to None.
            plugins: Optional plugins can be provided to extend functionality.
            json_handler: The module to use for json operations. The options are BuiltinHandler
                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                extra needs to be included. Default: BuiltinHandler.
            hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                JsonDict

        Returns:
            An instance of Index containing the information of the newly created index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = index.create(client, "movies")
        """
        if not primary_key:
            payload = {"uid": uid}
        else:
            payload = {"primaryKey": primary_key, "uid": uid}

        url = "indexes"
        handler = json_handler if json_handler else BuiltinHandler()
        http_request = HttpRequests(http_client, handler)
        response = http_request.post(url, payload)
        wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=timeout_in_ms)
        index_response = http_request.get(f"{url}/{uid}")
        index_dict = index_response.json()
        index = cls(
            http_client=http_client,
            uid=index_dict["uid"],
            primary_key=index_dict["primaryKey"],
            created_at=index_dict["createdAt"],
            updated_at=index_dict["updatedAt"],
            plugins=plugins,
            json_handler=json_handler,
            hits_type=hits_type,
        )

        if settings:
            settings_task = index.update_settings(settings)
            if wait:
                wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=timeout_in_ms)

        return index

    def get_stats(self) -> IndexStats:
        """Get stats of the index.

        Returns:
            Stats of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> stats = index.get_stats()
        """
        response = self._http_requests.get(self._stats_url)

        return IndexStats(**response.json())

    def search(
        self,
        query: str | None = None,
        *,
        offset: int = 0,
        limit: int = 20,
        filter: Filter | None = None,
        facets: list[str] | None = None,
        attributes_to_retrieve: list[str] | None = None,
        attributes_to_crop: list[str] | None = None,
        crop_length: int = 200,
        attributes_to_highlight: list[str] | None = None,
        sort: list[str] | None = None,
        show_matches_position: bool = False,
        highlight_pre_tag: str = "<em>",
        highlight_post_tag: str = "</em>",
        crop_marker: str = "...",
        matching_strategy: Literal["all", "last", "frequency"] = "last",
        hits_per_page: int | None = None,
        page: int | None = None,
        attributes_to_search_on: list[str] | None = None,
        distinct: str | None = None,
        show_ranking_score: bool = False,
        show_ranking_score_details: bool = False,
        ranking_score_threshold: float | None = None,
        vector: list[float] | None = None,
        hybrid: Hybrid | None = None,
        locales: list[str] | None = None,
    ) -> SearchResults:
        """Search the index.

        Args:
            query: String containing the word(s) to search
            offset: Number of documents to skip. Defaults to 0.
            limit: Maximum number of documents returned. Defaults to 20.
            filter: Filter queries by an attribute value. Defaults to None.
            facets: Facets for which to retrieve the matching count. Defaults to None.
            attributes_to_retrieve: Attributes to display in the returned documents.
                Defaults to ["*"].
            attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
            crop_length: The maximun number of words to display. Defaults to 200.
            attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                Defaults to None.
            sort: Attributes by which to sort the results. Defaults to None.
            show_matches_position: Defines whether an object that contains information about the
                matches should be returned or not. Defaults to False.
            highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
            highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
            crop_marker: Marker to display when the number of words excedes the `crop_length`.
                Defaults to ...
            matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                `last`.
            hits_per_page: Sets the number of results returned per page.
            page: Sets the specific results page to fetch.
            attributes_to_search_on: List of field names. Allow search over a subset of searchable
                attributes without modifying the index settings. Defaults to None.
            distinct: If set the distinct value will return at most one result for the
                filterable attribute. Note that a filterable attributes must be set for this work.
                Defaults to None.
            show_ranking_score: If set to True the ranking score will be returned with each document
                in the search. Defaults to False.
            show_ranking_score_details: If set to True the ranking details will be returned with
                each document in the search. Defaults to False. Note: This parameter can only be
                used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order
                to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                Because this feature is experimental it may be removed or updated causing breaking
                changes in this library without a major version bump so use with caution. This
                feature became stable in Meiliseach v1.7.0.
            ranking_score_threshold: If set, no document whose _rankingScore is under the
                rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
                to None.
            vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                In order to use this feature in Meilisearch v1.3.0 you first need to enable the
                feature by sending a PATCH request to /experimental-features with
                { "vectorStore": true }. Because this feature is experimental it may be removed or
                updated causing breaking changes in this library without a major version bump so use
                with caution.
            hybrid: Hybrid search information. Defaults to None. Note: This parameter can
                only be used with Meilisearch >= v1.6.0, and is experimental in Meilisearch v1.6.0.
                In order to use this feature in Meilisearch v1.6.0 you first need to enable the
                feature by sending a PATCH request to /experimental-features with
                { "vectorStore": true }. Because this feature is experimental it may be removed or
                updated causing breaking changes in this library without a major version bump so use
                with caution.
            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.

        Returns:
            Results of the search

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> search_results = index.search("Tron")
        """
        if ranking_score_threshold:
            _validate_ranking_score_threshold(ranking_score_threshold)

        body = _process_search_parameters(
            q=query,
            offset=offset,
            limit=limit,
            filter=filter,
            facets=facets,
            attributes_to_retrieve=attributes_to_retrieve,
            attributes_to_crop=attributes_to_crop,
            crop_length=crop_length,
            attributes_to_highlight=attributes_to_highlight,
            sort=sort,
            show_matches_position=show_matches_position,
            highlight_pre_tag=highlight_pre_tag,
            highlight_post_tag=highlight_post_tag,
            crop_marker=crop_marker,
            matching_strategy=matching_strategy,
            hits_per_page=hits_per_page,
            page=page,
            attributes_to_search_on=attributes_to_search_on,
            distinct=distinct,
            show_ranking_score=show_ranking_score,
            show_ranking_score_details=show_ranking_score_details,
            vector=vector,
            hybrid=hybrid,
            ranking_score_threshold=ranking_score_threshold,
            locales=locales,
        )

        if self._pre_search_plugins:
            Index._run_plugins(
                self._pre_search_plugins,
                Event.PRE,
                query=query,
                offset=offset,
                limit=limit,
                filter=filter,
                facets=facets,
                attributes_to_retrieve=attributes_to_retrieve,
                attributes_to_crop=attributes_to_crop,
                crop_length=crop_length,
                attributes_to_highlight=attributes_to_highlight,
                sort=sort,
                show_matches_position=show_matches_position,
                highlight_pre_tag=highlight_pre_tag,
                highlight_post_tag=highlight_post_tag,
                crop_marker=crop_marker,
                matching_strategy=matching_strategy,
                hits_per_page=hits_per_page,
                page=page,
                attributes_to_search_on=attributes_to_search_on,
                distinct=distinct,
                show_ranking_score=show_ranking_score,
                show_ranking_score_details=show_ranking_score_details,
                vector=vector,
                hybrid=hybrid,
            )

        response = self._http_requests.post(f"{self._base_url_with_uid}/search", body=body)
        result = SearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
        if self._post_search_plugins:
            post = Index._run_plugins(self._post_search_plugins, Event.POST, search_results=result)
            if post.get("search_result"):
                result = post["search_result"]

        return result

    def facet_search(
        self,
        query: str | None = None,
        *,
        facet_name: str,
        facet_query: str,
        offset: int = 0,
        limit: int = 20,
        filter: Filter | None = None,
        facets: list[str] | None = None,
        attributes_to_retrieve: list[str] | None = None,
        attributes_to_crop: list[str] | None = None,
        crop_length: int = 200,
        attributes_to_highlight: list[str] | None = None,
        sort: list[str] | None = None,
        show_matches_position: bool = False,
        highlight_pre_tag: str = "<em>",
        highlight_post_tag: str = "</em>",
        crop_marker: str = "...",
        matching_strategy: Literal["all", "last", "frequency"] = "last",
        hits_per_page: int | None = None,
        page: int | None = None,
        attributes_to_search_on: list[str] | None = None,
        show_ranking_score: bool = False,
        show_ranking_score_details: bool = False,
        ranking_score_threshold: float | None = None,
        vector: list[float] | None = None,
        locales: list[str] | None = None,
    ) -> FacetSearchResults:
        """Search the index.

        Args:
            query: String containing the word(s) to search
            facet_name: The name of the facet to search
            facet_query: The facet search value
            offset: Number of documents to skip. Defaults to 0.
            limit: Maximum number of documents returned. Defaults to 20.
            filter: Filter queries by an attribute value. Defaults to None.
            facets: Facets for which to retrieve the matching count. Defaults to None.
            attributes_to_retrieve: Attributes to display in the returned documents.
                Defaults to ["*"].
            attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
            crop_length: The maximun number of words to display. Defaults to 200.
            attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                Defaults to None.
            sort: Attributes by which to sort the results. Defaults to None.
            show_matches_position: Defines whether an object that contains information about the
                matches should be returned or not. Defaults to False.
            highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
            highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
            crop_marker: Marker to display when the number of words excedes the `crop_length`.
                Defaults to ...
            matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                `last`.
            hits_per_page: Sets the number of results returned per page.
            page: Sets the specific results page to fetch.
            attributes_to_search_on: List of field names. Allow search over a subset of searchable
                attributes without modifying the index settings. Defaults to None.
            show_ranking_score: If set to True the ranking score will be returned with each document
                in the search. Defaults to False.
            show_ranking_score_details: If set to True the ranking details will be returned with
                each document in the search. Defaults to False. Note: This parameter can only be
                used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order
                to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
                sending a PATCH request to /experimental-features with { "scoreDetails": true }.
                Because this feature is experimental it may be removed or updated causing breaking
                changes in this library without a major version bump so use with caution. This
                feature became stable in Meiliseach v1.7.0.
            ranking_score_threshold: If set, no document whose _rankingScore is under the
                rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
                to None.
            vector: List of vectors for vector search. Defaults to None. Note: This parameter can
                only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
                In order to use this feature in Meilisearch v1.3.0 you first need to enable the
                feature by sending a PATCH request to /experimental-features with
                { "vectorStore": true }. Because this feature is experimental it may be removed or
                updated causing breaking changes in this library without a major version bump so use
                with caution.
            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.

        Returns:
            Results of the search

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> search_results = index.search(
            >>>     "Tron",
            >>>     facet_name="genre",
            >>>     facet_query="Sci-fi"
            >>> )
        """
        if ranking_score_threshold:
            _validate_ranking_score_threshold(ranking_score_threshold)

        body = _process_search_parameters(
            q=query,
            facet_name=facet_name,
            facet_query=facet_query,
            offset=offset,
            limit=limit,
            filter=filter,
            facets=facets,
            attributes_to_retrieve=attributes_to_retrieve,
            attributes_to_crop=attributes_to_crop,
            crop_length=crop_length,
            attributes_to_highlight=attributes_to_highlight,
            sort=sort,
            show_matches_position=show_matches_position,
            highlight_pre_tag=highlight_pre_tag,
            highlight_post_tag=highlight_post_tag,
            crop_marker=crop_marker,
            matching_strategy=matching_strategy,
            hits_per_page=hits_per_page,
            page=page,
            attributes_to_search_on=attributes_to_search_on,
            show_ranking_score=show_ranking_score,
            show_ranking_score_details=show_ranking_score_details,
            ranking_score_threshold=ranking_score_threshold,
            vector=vector,
            locales=locales,
        )

        if self._pre_facet_search_plugins:
            Index._run_plugins(
                self._pre_facet_search_plugins,
                Event.PRE,
                query=query,
                offset=offset,
                limit=limit,
                filter=filter,
                facets=facets,
                attributes_to_retrieve=attributes_to_retrieve,
                attributes_to_crop=attributes_to_crop,
                crop_length=crop_length,
                attributes_to_highlight=attributes_to_highlight,
                sort=sort,
                show_matches_position=show_matches_position,
                highlight_pre_tag=highlight_pre_tag,
                highlight_post_tag=highlight_post_tag,
                crop_marker=crop_marker,
                matching_strategy=matching_strategy,
                hits_per_page=hits_per_page,
                page=page,
                attributes_to_search_on=attributes_to_search_on,
                show_ranking_score=show_ranking_score,
                show_ranking_score_details=show_ranking_score_details,
                ranking_score_threshold=ranking_score_threshold,
                vector=vector,
            )

        response = self._http_requests.post(f"{self._base_url_with_uid}/facet-search", body=body)
        result = FacetSearchResults(**response.json())
        if self._post_facet_search_plugins:
            post = Index._run_plugins(self._post_facet_search_plugins, Event.POST, result=result)
            if isinstance(post["generic_result"], FacetSearchResults):
                result = post["generic_result"]

        return result

    def search_similar_documents(
        self,
        id: str,
        *,
        offset: int | None = None,
        limit: int | None = None,
        filter: str | None = None,
        embedder: str = "default",
        attributes_to_retrieve: list[str] | None = None,
        show_ranking_score: bool = False,
        show_ranking_score_details: bool = False,
        ranking_score_threshold: float | None = None,
    ) -> SimilarSearchResults:
        """Search the index.

        Args:
            id: The id for the target document that is being used to find similar documents.
            offset: Number of documents to skip. Defaults to 0.
            limit: Maximum number of documents returned. Defaults to 20.
            filter: Filter queries by an attribute value. Defaults to None.
            embedder: The vector DB to use for the search.
            attributes_to_retrieve: Attributes to display in the returned documents.
                Defaults to ["*"].
            show_ranking_score: If set to True the ranking score will be returned with each document
                in the search. Defaults to False.
            show_ranking_score_details: If set to True the ranking details will be returned with
                each document in the search. Defaults to False.
            ranking_score_threshold: If set, no document whose _rankingScore is under the
                rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
                to None.

        Returns:
            Results of the search

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> search_results = index.search_similar_documents("123")
        """
        payload = {
            "id": id,
            "filter": filter,
            "embedder": embedder,
            "attributesToRetrieve": attributes_to_retrieve,
            "showRankingScore": show_ranking_score,
            "showRankingScoreDetails": show_ranking_score_details,
            "rankingScoreThreshold": ranking_score_threshold,
        }

        if offset:
            payload["offset"] = offset

        if limit:
            payload["limit"] = limit

        response = self._http_requests.post(f"{self._base_url_with_uid}/similar", body=payload)

        return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]

    def get_document(self, document_id: str) -> JsonDict:
        """Get one document with given document identifier.

        Args:
            document_id: Unique identifier of the document.

        Returns:
            The document information

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> document = index.get_document("1234")
        """
        response = self._http_requests.get(f"{self._documents_url}/{document_id}")

        return response.json()

    def get_documents(
        self,
        *,
        offset: int = 0,
        limit: int = 20,
        fields: list[str] | None = None,
        filter: Filter | None = None,
    ) -> DocumentsInfo:
        """Get a batch documents from the index.

        Args:
            offset: Number of documents to skip. Defaults to 0.
            limit: Maximum number of documents returnedd. Defaults to 20.
            fields: Document attributes to show. If this value is None then all
                attributes are retrieved. Defaults to None.
            filter: Filter value information. Defaults to None. Note: This parameter can only be
                used with Meilisearch >= v1.2.0

        Returns:
            Documents info.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.


        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> documents = index.get_documents()
        """
        parameters: JsonDict = {
            "offset": offset,
            "limit": limit,
        }

        if not filter:
            if fields:
                parameters["fields"] = ",".join(fields)

            url = _build_encoded_url(self._documents_url, parameters)
            response = self._http_requests.get(url)

            return DocumentsInfo(**response.json())

        if fields:
            parameters["fields"] = fields

        parameters["filter"] = filter
        response = self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)

        return DocumentsInfo(**response.json())

    def add_documents(
        self,
        documents: Sequence[JsonMapping],
        primary_key: str | None = None,
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Add documents to the index.

        Args:
            documents: List of documents.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> documents = [
            >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
            >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
            >>> ]
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents(documents)
        """
        if primary_key:
            url = _build_encoded_url(self._documents_url, {"primaryKey": primary_key})
        else:
            url = self._documents_url

        if self._pre_add_documents_plugins:
            pre = Index._run_plugins(
                self._pre_add_documents_plugins,
                Event.PRE,
                documents=documents,
                primary_key=primary_key,
            )
            if pre.get("document_result"):
                documents = pre["document_result"]

        response = self._http_requests.post(url, documents, compress=compress)
        result = TaskInfo(**response.json())
        if self._post_add_documents_plugins:
            post = Index._run_plugins(self._post_add_documents_plugins, Event.POST, result=result)
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def add_documents_in_batches(
        self,
        documents: Sequence[JsonMapping],
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Adds documents in batches to reduce RAM usage with indexing.

        Args:
            documents: List of documents.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids 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_sdk import Client
            >>> >>> documents = [
            >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
            >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
            >>> ]
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_in_batches(documents)
        """
        return [
            self.add_documents(x, primary_key, compress=compress)
            for x in _batch(documents, batch_size)
        ]

    def add_documents_from_directory(
        self,
        directory_path: Path | str,
        *,
        primary_key: str | None = None,
        document_type: str = "json",
        csv_delimiter: str | None = None,
        combine_documents: bool = True,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Load all json files from a directory and add the documents to the index.

        Args:
            directory_path: Path to the directory that contains the json files.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            document_type: The type of document being added. Accepted types are json, csv, and
                ndjson. For csv files the first row of the document should be a header row contining
                the field names, and ever for should have a title.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            combine_documents: If set to True this will combine the documents from all the files
                before indexing them. Defaults to True.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task status.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> directory_path = Path("/path/to/directory/containing/files")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_from_directory(directory_path)
        """
        directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

        if combine_documents:
            all_documents = []
            for path in directory.iterdir():
                if path.suffix == f".{document_type}":
                    documents = _load_documents_from_file(
                        path, csv_delimiter, json_handler=self._json_handler
                    )
                    all_documents.append(documents)

            _raise_on_no_documents(all_documents, document_type, directory_path)

            combined = _combine_documents(all_documents)

            response = self.add_documents(combined, primary_key, compress=compress)

            return [response]

        responses = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                responses.append(self.add_documents(documents, primary_key, compress=compress))

        _raise_on_no_documents(responses, document_type, directory_path)

        return responses

    def add_documents_from_directory_in_batches(
        self,
        directory_path: Path | str,
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        document_type: str = "json",
        csv_delimiter: str | None = None,
        combine_documents: bool = True,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Load all json files from a directory and add the documents to the index in batches.

        Args:
            directory_path: Path to the directory that contains the json files.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            document_type: The type of document being added. Accepted types are json, csv, and
                ndjson. For csv files the first row of the document should be a header row contining
                the field names, and ever for should have a title.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            combine_documents: If set to True this will combine the documents from all the files
                before indexing them. Defaults to True.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids to track the action.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> directory_path = Path("/path/to/directory/containing/files")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_from_directory_in_batches(directory_path)
        """
        directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

        if combine_documents:
            all_documents = []
            for path in directory.iterdir():
                if path.suffix == f".{document_type}":
                    documents = _load_documents_from_file(
                        path, csv_delimiter=csv_delimiter, json_handler=self._json_handler
                    )
                    all_documents.append(documents)

            _raise_on_no_documents(all_documents, document_type, directory_path)

            combined = _combine_documents(all_documents)

            return self.add_documents_in_batches(
                combined,
                batch_size=batch_size,
                primary_key=primary_key,
                compress=compress,
            )

        responses: list[TaskInfo] = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                responses.extend(
                    self.add_documents_in_batches(
                        documents,
                        batch_size=batch_size,
                        primary_key=primary_key,
                        compress=compress,
                    )
                )

        _raise_on_no_documents(responses, document_type, directory_path)

        return responses

    def add_documents_from_file(
        self,
        file_path: Path | str,
        primary_key: str | None = None,
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Add documents to the index from a json file.

        Args:
            file_path: Path to the json file.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task status.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.json")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_from_file(file_path)
        """
        documents = _load_documents_from_file(file_path, json_handler=self._json_handler)

        return self.add_documents(documents, primary_key=primary_key, compress=compress)

    def add_documents_from_file_in_batches(
        self,
        file_path: Path | str,
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        csv_delimiter: str | None = None,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Adds documents form a json file in batches to reduce RAM usage with indexing.

        Args:
            file_path: Path to the json file.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids to track the action.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.json")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_from_file_in_batches(file_path)
        """
        documents = _load_documents_from_file(
            file_path, csv_delimiter, json_handler=self._json_handler
        )

        return self.add_documents_in_batches(
            documents,
            batch_size=batch_size,
            primary_key=primary_key,
            compress=compress,
        )

    def add_documents_from_raw_file(
        self,
        file_path: Path | str,
        primary_key: str | None = None,
        *,
        csv_delimiter: str | None = None,
        compress: bool = False,
    ) -> TaskInfo:
        """Directly send csv or ndjson files to Meilisearch without pre-processing.

        The can reduce RAM usage from Meilisearch during indexing, but does not include the option
        for batching.

        Args:
            file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
                allowed.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task.

        Raises:
            ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
                a non-csv file.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.csv")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.add_documents_from_raw_file(file_path)
        """
        upload_path = Path(file_path) if isinstance(file_path, str) else file_path
        if not upload_path.exists():
            raise MeilisearchError("No file found at the specified path")

        if upload_path.suffix not in (".csv", ".ndjson"):
            raise ValueError("Only csv and ndjson files can be sent as binary files")

        if csv_delimiter and upload_path.suffix != ".csv":
            raise ValueError("A csv_delimiter can only be used with csv files")

        if (
            csv_delimiter
            and len(csv_delimiter) != 1
            or csv_delimiter
            and not csv_delimiter.isascii()
        ):
            raise ValueError("csv_delimiter must be a single ascii character")

        content_type = "text/csv" if upload_path.suffix == ".csv" else "application/x-ndjson"
        parameters = {}

        if primary_key:
            parameters["primaryKey"] = primary_key
        if csv_delimiter:
            parameters["csvDelimiter"] = csv_delimiter

        if parameters:
            url = _build_encoded_url(self._documents_url, parameters)
        else:
            url = self._documents_url

        with open(upload_path) as f:
            data = f.read()

        response = self._http_requests.post(
            url, body=data, content_type=content_type, compress=compress
        )

        return TaskInfo(**response.json())

    def edit_documents(
        self, function: str, *, context: JsonDict | None = None, filter: str | None = None
    ) -> TaskInfo:
        """Edit documents with a function.

        Edit documents is only available in Meilisearch >= v1.10.0, and is experimental in
        Meilisearch v1.10.0. In order to use this feature you first need to enable it by
        sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.

        Args:
            function: Rhai function to use to update the documents.
            context: Parameters to use in the function. Defaults to None.
            filter: Filter the documents before applying the function. Defaults to None.

        Returns:
            The details of the task.

        Raises:
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.edit_documents("doc.title = `${doc.title.to_upper()}`")
        """
        url = f"{self._documents_url}/edit"
        payload: JsonDict = {"function": function}

        if context:
            payload["context"] = context

        if filter:
            payload["filter"] = filter

        response = self._http_requests.post(url, payload)

        return TaskInfo(**response.json())

    def update_documents(
        self,
        documents: Sequence[JsonMapping],
        primary_key: str | None = None,
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Update documents in the index.

        Args:
            documents: List of documents.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> documents = [
            >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
            >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
            >>> ]
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_documents(documents)
        """
        if primary_key:
            url = _build_encoded_url(self._documents_url, {"primaryKey": primary_key})
        else:
            url = self._documents_url

        if self._pre_update_documents_plugins:
            pre = Index._run_plugins(
                self._pre_update_documents_plugins,
                Event.PRE,
                documents=documents,
                primary_key=primary_key,
            )
            if pre.get("document_result"):
                documents = pre["document_result"]

        response = self._http_requests.put(url, documents, compress=compress)
        result = TaskInfo(**response.json())
        if self._post_update_documents_plugins:
            post = Index._run_plugins(
                self._post_update_documents_plugins, Event.POST, result=result
            )
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def update_documents_in_batches(
        self,
        documents: Sequence[JsonMapping],
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Update documents in batches to reduce RAM usage with indexing.

        Each batch tries to fill the max_payload_size

        Args:
            documents: List of documents.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids 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_sdk import Client
            >>> documents = [
            >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
            >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
            >>> ]
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_documents_in_batches(documents)
        """
        return [
            self.update_documents(x, primary_key, compress=compress)
            for x in _batch(documents, batch_size)
        ]

    def update_documents_from_directory(
        self,
        directory_path: Path | str,
        *,
        primary_key: str | None = None,
        document_type: str = "json",
        csv_delimiter: str | None = None,
        combine_documents: bool = True,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Load all json files from a directory and update the documents.

        Args:
            directory_path: Path to the directory that contains the json files.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            document_type: The type of document being added. Accepted types are json, csv, and
                ndjson. For csv files the first row of the document should be a header row contining
                the field names, and ever for should have a title.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            combine_documents: If set to True this will combine the documents from all the files
                before indexing them. Defaults to True.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task status.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> directory_path = Path("/path/to/directory/containing/files")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_documents_from_directory(directory_path)
        """
        directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

        if combine_documents:
            all_documents = []
            for path in directory.iterdir():
                if path.suffix == f".{document_type}":
                    documents = _load_documents_from_file(
                        path, csv_delimiter, json_handler=self._json_handler
                    )
                    all_documents.append(documents)

            _raise_on_no_documents(all_documents, document_type, directory_path)

            combined = _combine_documents(all_documents)

            response = self.update_documents(combined, primary_key, compress=compress)
            return [response]

        responses = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                responses.append(self.update_documents(documents, primary_key, compress=compress))

        _raise_on_no_documents(responses, document_type, directory_path)

        return responses

    def update_documents_from_directory_in_batches(
        self,
        directory_path: Path | str,
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        document_type: str = "json",
        csv_delimiter: str | None = None,
        combine_documents: bool = True,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Load all json files from a directory and update the documents.

        Args:
            directory_path: Path to the directory that contains the json files.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            document_type: The type of document being added. Accepted types are json, csv, and
                ndjson. For csv files the first row of the document should be a header row contining
                the field names, and ever for should have a title.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            combine_documents: If set to True this will combine the documents from all the files
                before indexing them. Defaults to True.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids to track the action.

        Raises:
            InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> directory_path = Path("/path/to/directory/containing/files")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_documents_from_directory_in_batches(directory_path)
        """
        directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

        if combine_documents:
            all_documents = []
            for path in directory.iterdir():
                if path.suffix == f".{document_type}":
                    documents = _load_documents_from_file(
                        path, csv_delimiter, json_handler=self._json_handler
                    )
                    all_documents.append(documents)

            _raise_on_no_documents(all_documents, document_type, directory_path)

            combined = _combine_documents(all_documents)

            return self.update_documents_in_batches(
                combined,
                batch_size=batch_size,
                primary_key=primary_key,
                compress=compress,
            )

        responses: list[TaskInfo] = []

        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                responses.extend(
                    self.update_documents_in_batches(
                        documents,
                        batch_size=batch_size,
                        primary_key=primary_key,
                        compress=compress,
                    )
                )

        _raise_on_no_documents(responses, document_type, directory_path)

        return responses

    def update_documents_from_file(
        self,
        file_path: Path | str,
        primary_key: str | None = None,
        csv_delimiter: str | None = None,
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Add documents in the index from a json file.

        Args:
            file_path: Path to the json file.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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 pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.json")
            >>> client = Client("http://localhost.com", "masterKey") as client:
            >>> index = client.index("movies")
            >>> index.update_documents_from_file(file_path)
        """
        documents = _load_documents_from_file(
            file_path, csv_delimiter, json_handler=self._json_handler
        )

        return self.update_documents(documents, primary_key=primary_key, compress=compress)

    def update_documents_from_file_in_batches(
        self,
        file_path: Path | str,
        *,
        batch_size: int = 1000,
        primary_key: str | None = None,
        compress: bool = False,
    ) -> list[TaskInfo]:
        """Updates documents form a json file in batches to reduce RAM usage with indexing.

        Args:
            file_path: Path to the json file.
            batch_size: The number of documents that should be included in each batch.
                Defaults to 1000.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            List of update ids 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 pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.json")
            >>> client = Client("http://localhost.com", "masterKey") as client:
            >>> index = client.index("movies")
            >>> index.update_documents_from_file_in_batches(file_path)
        """
        documents = _load_documents_from_file(file_path, json_handler=self._json_handler)

        return self.update_documents_in_batches(
            documents,
            batch_size=batch_size,
            primary_key=primary_key,
            compress=compress,
        )

    def update_documents_from_raw_file(
        self,
        file_path: Path | str,
        primary_key: str | None = None,
        csv_delimiter: str | None = None,
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Directly send csv or ndjson files to Meilisearch without pre-processing.

        The can reduce RAM usage from Meilisearch during indexing, but does not include the option
        for batching.

        Args:
            file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
                allowed.
            primary_key: The primary key of the documents. This will be ignored if already set.
                Defaults to None.
            csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                can only be used if the file is a csv file. Defaults to comma.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        Returns:
            The details of the task status.

        Raises:
            ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
                a non-csv file.
            MeilisearchError: If the file path is not valid
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from pathlib import Path
            >>> from meilisearch_python_sdk import Client
            >>> file_path = Path("/path/to/file.csv")
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_documents_from_raw_file(file_path)
        """
        upload_path = Path(file_path) if isinstance(file_path, str) else file_path
        if not upload_path.exists():
            raise MeilisearchError("No file found at the specified path")

        if upload_path.suffix not in (".csv", ".ndjson"):
            raise ValueError("Only csv and ndjson files can be sent as binary files")

        if csv_delimiter and upload_path.suffix != ".csv":
            raise ValueError("A csv_delimiter can only be used with csv files")

        if (
            csv_delimiter
            and len(csv_delimiter) != 1
            or csv_delimiter
            and not csv_delimiter.isascii()
        ):
            raise ValueError("csv_delimiter must be a single ascii character")

        content_type = "text/csv" if upload_path.suffix == ".csv" else "application/x-ndjson"
        parameters = {}

        if primary_key:
            parameters["primaryKey"] = primary_key
        if csv_delimiter:
            parameters["csvDelimiter"] = csv_delimiter

        if parameters:
            url = _build_encoded_url(self._documents_url, parameters)
        else:
            url = self._documents_url

        with open(upload_path) as f:
            data = f.read()

        response = self._http_requests.put(
            url, body=data, content_type=content_type, compress=compress
        )

        return TaskInfo(**response.json())

    def delete_document(self, document_id: str) -> TaskInfo:
        """Delete one document from the index.

        Args:
            document_id: Unique identifier of the document.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_document("1234")
        """
        if self._pre_delete_document_plugins:
            Index._run_plugins(
                self._pre_delete_document_plugins, Event.PRE, document_id=document_id
            )

        response = self._http_requests.delete(f"{self._documents_url}/{document_id}")
        result = TaskInfo(**response.json())
        if self._post_delete_document_plugins:
            post = Index._run_plugins(self._post_delete_document_plugins, Event.POST, result=result)
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def delete_documents(self, ids: list[str]) -> TaskInfo:
        """Delete multiple documents from the index.

        Args:
            ids: List of unique identifiers of documents.

        Returns:
            List of update ids 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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_documents(["1234", "5678"])
        """
        if self._pre_delete_documents_plugins:
            Index._run_plugins(self._pre_delete_documents_plugins, Event.PRE, ids=ids)

        response = self._http_requests.post(f"{self._documents_url}/delete-batch", ids)
        result = TaskInfo(**response.json())
        if self._post_delete_documents_plugins:
            post = Index._run_plugins(
                self._post_delete_documents_plugins, Event.POST, result=result
            )
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def delete_documents_by_filter(self, filter: Filter) -> TaskInfo:
        """Delete documents from the index by filter.

        Args:
            filter: The filter value information.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_documents_by_filter("genre=horor"))
        """
        if self._pre_delete_documents_by_filter_plugins:
            Index._run_plugins(
                self._pre_delete_documents_by_filter_plugins, Event.PRE, filter=filter
            )

        response = self._http_requests.post(
            f"{self._documents_url}/delete", body={"filter": filter}
        )
        result = TaskInfo(**response.json())
        if self._post_delete_documents_by_filter_plugins:
            post = Index._run_plugins(
                self._post_delete_documents_by_filter_plugins, Event.POST, result=result
            )
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def delete_documents_in_batches_by_filter(
        self, filters: list[str | list[str | list[str]]]
    ) -> list[TaskInfo]:
        """Delete batches of documents from the index by filter.

        Args:
            filters: A list of filter value information.

        Returns:
            The a list of details of the task statuses.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_documents_in_batches_by_filter(
            >>>     [
            >>>         "genre=horor"),
            >>>         "release_date=1520035200"),
            >>>     ]
            >>> )
        """
        return [self.delete_documents_by_filter(filter) for filter in filters]

    def delete_all_documents(self) -> TaskInfo:
        """Delete all documents from the index.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.delete_all_document()
        """
        if self._pre_delete_all_documents_plugins:
            Index._run_plugins(self._pre_delete_all_documents_plugins, Event.PRE)

        response = self._http_requests.delete(self._documents_url)
        result = TaskInfo(**response.json())
        if self._post_delete_all_documents_plugins:
            post = Index._run_plugins(
                self._post_delete_all_documents_plugins, Event.POST, result=result
            )
            if isinstance(post.get("generic_result"), TaskInfo):
                result = post["generic_result"]

        return result

    def get_settings(self) -> MeilisearchSettings:
        """Get settings of the index.

        Returns:
            Settings of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> settings = index.get_settings()
        """
        response = self._http_requests.get(self._settings_url)
        response_json = response.json()
        settings = MeilisearchSettings(**response_json)

        if response_json.get("embedders"):
            # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
            settings.embedders = _embedder_json_to_settings_model(  # pragma: no cover
                response_json["embedders"]
            )

        return settings

    def update_settings(self, body: MeilisearchSettings, *, compress: bool = False) -> TaskInfo:
        """Update settings of the index.

        Args:
            body: Settings of the index.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> from meilisearch_python_sdk import MeilisearchSettings
            >>> new_settings = MeilisearchSettings(
            >>>     synonyms={"wolverine": ["xmen", "logan"], "logan": ["wolverine"]},
            >>>     stop_words=["the", "a", "an"],
            >>>     ranking_rules=[
            >>>         "words",
            >>>         "typo",
            >>>         "proximity",
            >>>         "attribute",
            >>>         "sort",
            >>>         "exactness",
            >>>         "release_date:desc",
            >>>         "rank:desc",
            >>>    ],
            >>>    filterable_attributes=["genre", "director"],
            >>>    distinct_attribute="url",
            >>>    searchable_attributes=["title", "description", "genre"],
            >>>    displayed_attributes=["title", "description", "genre", "release_date"],
            >>>    sortable_attributes=["title", "release_date"],
            >>> )
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_settings(new_settings)
        """
        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())

    def reset_settings(self) -> TaskInfo:
        """Reset settings of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_settings()
        """
        response = self._http_requests.delete(self._settings_url)

        return TaskInfo(**response.json())

    def get_ranking_rules(self) -> list[str]:
        """Get ranking rules of the index.

        Returns:
            List containing the ranking rules of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> ranking_rules = index.get_ranking_rules()
        """
        response = self._http_requests.get(f"{self._settings_url}/ranking-rules")

        return response.json()

    def update_ranking_rules(self, ranking_rules: list[str], *, compress: bool = False) -> TaskInfo:
        """Update ranking rules of the index.

        Args:
            ranking_rules: List containing the ranking rules.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> ranking_rules=[
            >>>      "words",
            >>>      "typo",
            >>>      "proximity",
            >>>      "attribute",
            >>>      "sort",
            >>>      "exactness",
            >>>      "release_date:desc",
            >>>      "rank:desc",
            >>> ],
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_ranking_rules(ranking_rules)
        """
        response = self._http_requests.put(
            f"{self._settings_url}/ranking-rules", ranking_rules, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_ranking_rules(self) -> TaskInfo:
        """Reset ranking rules of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_ranking_rules()
        """
        response = self._http_requests.delete(f"{self._settings_url}/ranking-rules")

        return TaskInfo(**response.json())

    def get_distinct_attribute(self) -> str | None:
        """Get distinct attribute of the index.

        Returns:
            String containing the distinct attribute of the index. If no distinct attribute
                `None` is returned.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> distinct_attribute = index.get_distinct_attribute()
        """
        response = self._http_requests.get(f"{self._settings_url}/distinct-attribute")

        if not response.json():
            return None

        return response.json()

    def update_distinct_attribute(self, body: str, *, compress: bool = False) -> TaskInfo:
        """Update distinct attribute of the index.

        Args:
            body: Distinct attribute.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_distinct_attribute("url")
        """
        response = self._http_requests.put(
            f"{self._settings_url}/distinct-attribute", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_distinct_attribute(self) -> TaskInfo:
        """Reset distinct attribute of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_distinct_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/distinct-attribute")

        return TaskInfo(**response.json())

    def get_searchable_attributes(self) -> list[str]:
        """Get searchable attributes of the index.

        Returns:
            List containing the searchable attributes of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> searchable_attributes = index.get_searchable_attributes()
        """
        response = self._http_requests.get(f"{self._settings_url}/searchable-attributes")

        return response.json()

    def update_searchable_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
        """Update searchable attributes of the index.

        Args:
            body: List containing the searchable attributes.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_searchable_attributes(["title", "description", "genre"])
        """
        response = self._http_requests.put(
            f"{self._settings_url}/searchable-attributes", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_searchable_attributes(self) -> TaskInfo:
        """Reset searchable attributes of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_searchable_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/searchable-attributes")

        return TaskInfo(**response.json())

    def get_displayed_attributes(self) -> list[str]:
        """Get displayed attributes of the index.

        Returns:
            List containing the displayed attributes of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> displayed_attributes = index.get_displayed_attributes()
        """
        response = self._http_requests.get(f"{self._settings_url}/displayed-attributes")

        return response.json()

    def update_displayed_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
        """Update displayed attributes of the index.

        Args:
            body: List containing the displayed attributes.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_displayed_attributes(
            >>>     ["title", "description", "genre", "release_date"]
            >>> )
        """
        response = self._http_requests.put(
            f"{self._settings_url}/displayed-attributes", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_displayed_attributes(self) -> TaskInfo:
        """Reset displayed attributes of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_displayed_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/displayed-attributes")

        return TaskInfo(**response.json())

    def get_stop_words(self) -> list[str] | None:
        """Get stop words of the index.

        Returns:
            List containing the stop words of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> stop_words = index.get_stop_words()
        """
        response = self._http_requests.get(f"{self._settings_url}/stop-words")

        if not response.json():
            return None

        return response.json()

    def update_stop_words(self, body: list[str], *, compress: bool = False) -> TaskInfo:
        """Update stop words of the index.

        Args:
            body: List containing the stop words of the index.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_stop_words(["the", "a", "an"])
        """
        response = self._http_requests.put(
            f"{self._settings_url}/stop-words", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_stop_words(self) -> TaskInfo:
        """Reset stop words of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_stop_words()
        """
        response = self._http_requests.delete(f"{self._settings_url}/stop-words")

        return TaskInfo(**response.json())

    def get_synonyms(self) -> dict[str, list[str]] | None:
        """Get synonyms of the index.

        Returns:
            The synonyms of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> synonyms = index.get_synonyms()
        """
        response = self._http_requests.get(f"{self._settings_url}/synonyms")

        if not response.json():
            return None

        return response.json()

    def update_synonyms(self, body: dict[str, list[str]], *, compress: bool = False) -> TaskInfo:
        """Update synonyms of the index.

        Args:
            body: The synonyms of the index.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey") as client:
            >>> index = client.index("movies")
            >>> index.update_synonyms(
            >>>     {"wolverine": ["xmen", "logan"], "logan": ["wolverine"]}
            >>> )
        """
        response = self._http_requests.put(
            f"{self._settings_url}/synonyms", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_synonyms(self) -> TaskInfo:
        """Reset synonyms of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_synonyms()
        """
        response = self._http_requests.delete(f"{self._settings_url}/synonyms")

        return TaskInfo(**response.json())

    def get_filterable_attributes(self) -> list[str] | None:
        """Get filterable attributes of the index.

        Returns:
            List containing the filterable attributes of the index.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> filterable_attributes = index.get_filterable_attributes()
        """
        response = self._http_requests.get(f"{self._settings_url}/filterable-attributes")

        if not response.json():
            return None

        return response.json()

    def update_filterable_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
        """Update filterable attributes of the index.

        Args:
            body: List containing the filterable attributes of the index.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_filterable_attributes(["genre", "director"])
        """
        response = self._http_requests.put(
            f"{self._settings_url}/filterable-attributes", body, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_filterable_attributes(self) -> TaskInfo:
        """Reset filterable attributes of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_filterable_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/filterable-attributes")

        return TaskInfo(**response.json())

    def get_sortable_attributes(self) -> list[str]:
        """Get sortable attributes of the AsyncIndex.

        Returns:
            List containing the sortable attributes of the AsyncIndex.

        Raises:
            MeilisearchCommunicationError: If there was an error communicating with the server.
            MeilisearchApiError: If the Meilisearch API returned an error.

        Examples
            >>> from meilisearch_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> sortable_attributes = index.get_sortable_attributes()
        """
        response = self._http_requests.get(f"{self._settings_url}/sortable-attributes")

        return response.json()

    def update_sortable_attributes(
        self, sortable_attributes: list[str], *, compress: bool = False
    ) -> TaskInfo:
        """Get sortable attributes of the AsyncIndex.

        Args:
            sortable_attributes: List of attributes for searching.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_sortable_attributes(["title", "release_date"])
        """
        response = self._http_requests.put(
            f"{self._settings_url}/sortable-attributes", sortable_attributes, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_sortable_attributes(self) -> TaskInfo:
        """Reset sortable attributes of the index to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_sortable_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/sortable-attributes")

        return TaskInfo(**response.json())

    def get_typo_tolerance(self) -> TypoTolerance:
        """Get typo tolerance for the index.

        Returns:
            TypoTolerance 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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> sortable_attributes = index.get_typo_tolerance()
        """
        response = self._http_requests.get(f"{self._settings_url}/typo-tolerance")

        return TypoTolerance(**response.json())

    def update_typo_tolerance(
        self, typo_tolerance: TypoTolerance, *, compress: bool = False
    ) -> TaskInfo:
        """Update typo tolerance.

        Args:
            typo_tolerance: Typo tolerance settings.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> TypoTolerance(enabled=False)
            >>> index.update_typo_tolerance()
        """
        response = self._http_requests.patch(
            f"{self._settings_url}/typo-tolerance",
            typo_tolerance.model_dump(by_alias=True),
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_typo_tolerance(self) -> TaskInfo:
        """Reset typo tolerance to default values.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_typo_tolerance()
        """
        response = self._http_requests.delete(f"{self._settings_url}/typo-tolerance")

        return TaskInfo(**response.json())

    def get_faceting(self) -> Faceting:
        """Get faceting for the index.

        Returns:
            Faceting 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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> faceting = index.get_faceting()
        """
        response = self._http_requests.get(f"{self._settings_url}/faceting")

        return Faceting(**response.json())

    def update_faceting(self, faceting: Faceting, *, compress: bool = False) -> TaskInfo:
        """Partially update the faceting settings for an index.

        Args:
            faceting: Faceting values.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_faceting(faceting=Faceting(max_values_per_facet=100))
        """
        response = self._http_requests.patch(
            f"{self._settings_url}/faceting",
            faceting.model_dump(by_alias=True),
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_faceting(self) -> TaskInfo:
        """Reset an index's faceting settings to their 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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_faceting()
        """
        response = self._http_requests.delete(f"{self._settings_url}/faceting")

        return TaskInfo(**response.json())

    def get_pagination(self) -> Pagination:
        """Get pagination settings for the index.

        Returns:
            Pagination 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> pagination_settings = index.get_pagination()
        """
        response = self._http_requests.get(f"{self._settings_url}/pagination")

        return Pagination(**response.json())

    def update_pagination(self, settings: Pagination, *, compress: bool = False) -> TaskInfo:
        """Partially update the pagination settings for an index.

        Args:
            settings: settings for pagination.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> from meilisearch_python_sdk.models.settings import Pagination
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_pagination(settings=Pagination(max_total_hits=123))
        """
        response = self._http_requests.patch(
            f"{self._settings_url}/pagination",
            settings.model_dump(by_alias=True),
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_pagination(self) -> TaskInfo:
        """Reset an index's pagination settings to their 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_pagination()
        """
        response = self._http_requests.delete(f"{self._settings_url}/pagination")

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> separator_token_settings = index.get_separator_tokens()
        """
        response = self._http_requests.get(f"{self._settings_url}/separator-tokens")

        return response.json()

    def update_separator_tokens(
        self, separator_tokens: list[str], *, compress: bool = False
    ) -> TaskInfo:
        """Update the separator tokens settings for an index.

        Args:
            separator_tokens: List of separator tokens.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_separator_tokens(separator_tokenes=["|", "/")
        """
        response = self._http_requests.put(
            f"{self._settings_url}/separator-tokens", separator_tokens, compress=compress
        )

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_separator_tokens()
        """
        response = self._http_requests.delete(f"{self._settings_url}/separator-tokens")

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> non_separator_token_settings = index.get_non_separator_tokens()
        """
        response = self._http_requests.get(f"{self._settings_url}/non-separator-tokens")

        return response.json()

    def update_non_separator_tokens(
        self, non_separator_tokens: list[str], *, compress: bool = False
    ) -> TaskInfo:
        """Update the non-separator tokens settings for an index.

        Args:
            non_separator_tokens: List of non-separator tokens.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_non_separator_tokens(non_separator_tokens=["@", "#")
        """
        response = self._http_requests.put(
            f"{self._settings_url}/non-separator-tokens", non_separator_tokens, compress=compress
        )

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_non_separator_tokens()
        """
        response = self._http_requests.delete(f"{self._settings_url}/non-separator-tokens")

        return TaskInfo(**response.json())

    def get_search_cutoff_ms(self) -> int | None:
        """Get search cutoff time in ms.

        Returns:
            Integer representing the search cutoff time in ms, or None.

        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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> search_cutoff_ms_settings = index.get_search_cutoff_ms()
        """
        response = self._http_requests.get(f"{self._settings_url}/search-cutoff-ms")

        return response.json()

    def update_search_cutoff_ms(self, search_cutoff_ms: int, *, compress: bool = False) -> TaskInfo:
        """Update the search cutoff for an index.

        Args:
            search_cutoff_ms: Integer value of the search cutoff time in ms.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_search_cutoff_ms(100)
        """
        response = self._http_requests.put(
            f"{self._settings_url}/search-cutoff-ms", search_cutoff_ms, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_search_cutoff_ms(self) -> TaskInfo:
        """Reset the search cutoff time 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_search_cutoff_ms()
        """
        response = self._http_requests.delete(f"{self._settings_url}/search-cutoff-ms")

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> word_dictionary = index.get_word_dictionary()
        """
        response = self._http_requests.get(f"{self._settings_url}/dictionary")

        return response.json()

    def update_word_dictionary(self, dictionary: list[str], *, compress: bool = False) -> TaskInfo:
        """Update the word dictionary settings for an index.

        Args:
            dictionary: List of dictionary values.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_word_dictionary(dictionary=["S.O.S", "S.O")
        """
        response = self._http_requests.put(
            f"{self._settings_url}/dictionary", dictionary, compress=compress
        )

        return TaskInfo(**response.json())

    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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_word_dictionary()
        """
        response = self._http_requests.delete(f"{self._settings_url}/dictionary")

        return TaskInfo(**response.json())

    def get_proximity_precision(self) -> ProximityPrecision:
        """Get proximity precision settings for the index.

        Returns:
            Proximity precision 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> proximity_precision = index.get_proximity_precision()
        """
        response = self._http_requests.get(f"{self._settings_url}/proximity-precision")

        return ProximityPrecision[to_snake(response.json()).upper()]

    def update_proximity_precision(
        self, proximity_precision: ProximityPrecision, *, compress: bool = False
    ) -> TaskInfo:
        """Update the proximity precision settings for an index.

        Args:
            proximity_precision: The proximity precision value.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> from meilisearch_python_sdk.models.settings import ProximityPrecision
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_proximity_precision(ProximityPrecision.BY_ATTRIBUTE)
        """
        response = self._http_requests.put(
            f"{self._settings_url}/proximity-precision",
            proximity_precision.value,
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_proximity_precision(self) -> TaskInfo:
        """Reset an index's proximity precision 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_proximity_precision()
        """
        response = self._http_requests.delete(f"{self._settings_url}/proximity-precision")

        return TaskInfo(**response.json())

    def get_embedders(self) -> Embedders | None:
        """Get embedder settings for the index.

        Returns:
            Embedders 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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> embedders = await index.get_embedders()
        """
        response = self._http_requests.get(f"{self._settings_url}/embedders")

        return _embedder_json_to_embedders_model(response.json())

    def update_embedders(self, embedders: Embedders, *, compress: bool = False) -> TaskInfo:
        """Update the embedders settings for an index.

        Args:
            embedders: The embedders value.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import Client
            >>> from meilisearch_python_sdk.models.settings import Embedders, UserProvidedEmbedder
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_embedders(
            >>>     Embedders(embedders={dimensions=512)})
            >>> )
        """
        payload = {}
        for key, embedder in embedders.embedders.items():
            payload[key] = {
                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(
            f"{self._settings_url}/embedders", payload, compress=compress
        )

        return TaskInfo(**response.json())

    # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
    def reset_embedders(self) -> TaskInfo:  # pragma: no cover
        """Reset an index's embedders 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
            >>> client = AsyncClient("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_embedders()
        """
        response = self._http_requests.delete(f"{self._settings_url}/embedders")

        return TaskInfo(**response.json())

    def get_localized_attributes(self) -> list[LocalizedAttributes] | None:
        """Get localized attributes settings for the index.

        Returns:
            Localized attributes 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 AsyncClient
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> localized_attributes = await index.get_localized_attributes()
        """
        response = self._http_requests.get(f"{self._settings_url}/localized-attributes")

        if not response.json():
            return None

        return [LocalizedAttributes(**x) for x in response.json()]

    def update_localized_attributes(
        self, localized_attributes: list[LocalizedAttributes], *, compress: bool = False
    ) -> TaskInfo:
        """Update the localized attributes settings for an index.

        Args:
            localized_attributes: The localized attributes value.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_sdk import AsyncClient
            >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
            >>>
            >>>
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_localized_attributes([
            >>>     LocalizedAttributes(locales=["eng", "spa"], attribute_patterns=["*"]),
            >>>     LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
            >>> ])
        """
        payload = [x.model_dump(by_alias=True) for x in localized_attributes]
        response = self._http_requests.put(
            f"{self._settings_url}/localized-attributes", payload, compress=compress
        )

        return TaskInfo(**response.json())

    def reset_localized_attributes(self) -> TaskInfo:
        """Reset an index's localized attributes 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 AsyncClient
            >>> Client("http://localhost.com", "masterKey") as client:
            >>> index = client.index("movies")
            >>> index.reset_localized_attributes()
        """
        response = self._http_requests.delete(f"{self._settings_url}/localized-attributes")

        return TaskInfo(**response.json())

    def get_facet_search(self) -> bool:
        """Get setting for facet search opt-out.

        Returns:
            True if facet search is enabled or False if not.

        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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> facet_search = await index.get_facet_search()
        """
        response = self._http_requests.get(f"{self._settings_url}/facet-search")

        return response.json()

    def update_facet_search(self, facet_search: bool, *, compress: bool = False) -> TaskInfo:
        """Update setting for facet search opt-out.

        Args:
            facet_search: Boolean indicating if facet search should be disabled.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_facet_search(True)
        """
        response = self._http_requests.put(
            f"{self._settings_url}/facet-search",
            facet_search,
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_facet_search(self) -> TaskInfo:
        """Reset the facet search opt-out settings.

        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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> await index.reset_facet_search()
        """
        response = self._http_requests.delete(f"{self._settings_url}/facet-search")

        return TaskInfo(**response.json())

    def get_prefix_search(self) -> bool:
        """Get setting for prefix search opt-out.

        Returns:
            True if prefix search is enabled or False if not.

        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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> prefix_search = index.get_prefix_search()
        """
        response = self._http_requests.get(f"{self._settings_url}/prefix-search")

        return response.json()

    def update_prefix_search(
        self,
        prefix_search: Literal["disabled", "indexingTime", "searchTime"],
        *,
        compress: bool = False,
    ) -> TaskInfo:
        """Update setting for prefix search opt-out.

        Args:
            prefix_search: Value indicating prefix search setting.
            compress: If set to True the data will be sent in gzip format. Defaults to False.

        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_python_sdk import Client
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.update_prefix_search("disabled")
        """
        response = self._http_requests.put(
            f"{self._settings_url}/prefix-search",
            prefix_search,
            compress=compress,
        )

        return TaskInfo(**response.json())

    def reset_prefix_search(self) -> TaskInfo:
        """Reset the prefix search opt-out settings.

        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
            >>> client = Client("http://localhost.com", "masterKey")
            >>> index = client.index("movies")
            >>> index.reset_prefix_search()
        """
        response = self._http_requests.delete(f"{self._settings_url}/prefix-search")

        return TaskInfo(**response.json())

    @staticmethod
    def _run_plugins(
        plugins: Sequence[Plugin | DocumentPlugin | PostSearchPlugin],
        event: Event,
        **kwargs: Any,
    ) -> dict[str, Any]:
        results: dict[str, Any] = {
            "generic_result": None,
            "document_result": None,
            "search_result": None,
        }
        generic_tasks = []
        document_tasks = []
        search_tasks = []
        for plugin in plugins:
            if _plugin_has_method(plugin, "run_plugin"):
                generic_tasks.append(plugin.run_plugin(event=event, **kwargs))  # type: ignore[union-attr]
            if _plugin_has_method(plugin, "run_document_plugin"):
                document_tasks.append(
                    plugin.run_document_plugin(event=event, **kwargs)  # type: ignore[union-attr]
                )
            if _plugin_has_method(plugin, "run_post_search_plugin"):
                search_tasks.append(
                    plugin.run_post_search_plugin(event=event, **kwargs)  # type: ignore[union-attr]
                )

        if generic_tasks:
            for result in reversed(generic_tasks):
                if result:
                    results["generic_result"] = result
                    break

        if document_tasks:
            results["document_result"] = document_tasks[-1]

        if search_tasks:
            results["search_result"] = search_tasks[-1]

        return results

__init__(http_client, uid, primary_key=None, created_at=None, updated_at=None, plugins=None, json_handler=None, *, hits_type=JsonDict)

Class initializer.

Parameters:

Name	Type	Description	Default
http_client	Client	An instance of the Client. This automatically gets passed by the Client when creating and Index instance.	required
uid	str	The index's unique identifier.	required
primary_key	str | None	The primary key of the documents. Defaults to None.	None
created_at	str | datetime | None	The date and time the index was created. Defaults to None.	None
updated_at	str | datetime | None	The date and time the index was last updated. Defaults to None.	None
plugins	IndexPlugins | None	Optional plugins can be provided to extend functionality.	None
json_handler	BuiltinHandler | OrjsonHandler | UjsonHandler | None	The module to use for json operations. The options are BuiltinHandler (uses the json module from the standard library), OrjsonHandler (uses orjson), or UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding extra needs to be included. Default: BuiltinHandler.	None
hits_type	Any	Allows for a custom type to be passed to use for hits. Defaults to JsonDict	JsonDict

Source code in meilisearch_python_sdk/index.py

def __init__(
    self,
    http_client: Client,
    uid: str,
    primary_key: str | None = None,
    created_at: str | datetime | None = None,
    updated_at: str | datetime | None = None,
    plugins: IndexPlugins | None = None,
    json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
    *,
    hits_type: Any = JsonDict,
):
    """Class initializer.

    Args:
        http_client: An instance of the Client. This automatically gets passed by the
            Client when creating and Index instance.
        uid: The index's unique identifier.
        primary_key: The primary key of the documents. Defaults to None.
        created_at: The date and time the index was created. Defaults to None.
        updated_at: The date and time the index was last updated. Defaults to None.
        plugins: Optional plugins can be provided to extend functionality.
        json_handler: The module to use for json operations. The options are BuiltinHandler
            (uses the json module from the standard library), OrjsonHandler (uses orjson), or
            UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
            extra needs to be included. Default: BuiltinHandler.
        hits_type: Allows for a custom type to be passed to use for hits. Defaults to
            JsonDict
    """
    super().__init__(
        uid=uid,
        primary_key=primary_key,
        created_at=created_at,
        updated_at=updated_at,
        json_handler=json_handler,
        hits_type=hits_type,
    )
    self.http_client = http_client
    self._http_requests = HttpRequests(http_client, json_handler=self._json_handler)
    self.plugins = plugins

add_documents(documents, primary_key=None, *, compress=False)

Add documents to the index.

Parameters:

Name	Type	Description	Default
documents	Sequence[JsonMapping]	List of documents.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> documents = [ >>> {"id": 1, "title": "Movie 1", "genre": "comedy"}, >>> {"id": 2, "title": "Movie 2", "genre": "drama"}, >>> ] >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents(documents)

Source code in meilisearch_python_sdk/index.py

def add_documents(
    self,
    documents: Sequence[JsonMapping],
    primary_key: str | None = None,
    *,
    compress: bool = False,
) -> TaskInfo:
    """Add documents to the index.

    Args:
        documents: List of documents.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> documents = [
        >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
        >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
        >>> ]
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents(documents)
    """
    if primary_key:
        url = _build_encoded_url(self._documents_url, {"primaryKey": primary_key})
    else:
        url = self._documents_url

    if self._pre_add_documents_plugins:
        pre = Index._run_plugins(
            self._pre_add_documents_plugins,
            Event.PRE,
            documents=documents,
            primary_key=primary_key,
        )
        if pre.get("document_result"):
            documents = pre["document_result"]

    response = self._http_requests.post(url, documents, compress=compress)
    result = TaskInfo(**response.json())
    if self._post_add_documents_plugins:
        post = Index._run_plugins(self._post_add_documents_plugins, Event.POST, result=result)
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

add_documents_from_directory(directory_path, *, primary_key=None, document_type='json', csv_delimiter=None, combine_documents=True, compress=False)

Load all json files from a directory and add the documents to the index.

Parameters:

Name	Type	Description	Default
directory_path	Path | str	Path to the directory that contains the json files.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
document_type	str	The type of document being added. Accepted types are json, csv, and ndjson. For csv files the first row of the document should be a header row contining the field names, and ever for should have a title.	'json'
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
combine_documents	bool	If set to True this will combine the documents from all the files before indexing them. Defaults to True.	True
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	The details of the task status.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> directory_path = Path("/path/to/directory/containing/files") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_from_directory(directory_path)

Source code in meilisearch_python_sdk/index.py

def add_documents_from_directory(
    self,
    directory_path: Path | str,
    *,
    primary_key: str | None = None,
    document_type: str = "json",
    csv_delimiter: str | None = None,
    combine_documents: bool = True,
    compress: bool = False,
) -> list[TaskInfo]:
    """Load all json files from a directory and add the documents to the index.

    Args:
        directory_path: Path to the directory that contains the json files.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        document_type: The type of document being added. Accepted types are json, csv, and
            ndjson. For csv files the first row of the document should be a header row contining
            the field names, and ever for should have a title.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        combine_documents: If set to True this will combine the documents from all the files
            before indexing them. Defaults to True.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task status.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> directory_path = Path("/path/to/directory/containing/files")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_from_directory(directory_path)
    """
    directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

    if combine_documents:
        all_documents = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                all_documents.append(documents)

        _raise_on_no_documents(all_documents, document_type, directory_path)

        combined = _combine_documents(all_documents)

        response = self.add_documents(combined, primary_key, compress=compress)

        return [response]

    responses = []
    for path in directory.iterdir():
        if path.suffix == f".{document_type}":
            documents = _load_documents_from_file(
                path, csv_delimiter, json_handler=self._json_handler
            )
            responses.append(self.add_documents(documents, primary_key, compress=compress))

    _raise_on_no_documents(responses, document_type, directory_path)

    return responses

add_documents_from_directory_in_batches(directory_path, *, batch_size=1000, primary_key=None, document_type='json', csv_delimiter=None, combine_documents=True, compress=False)

Load all json files from a directory and add the documents to the index in batches.

Parameters:

Name	Type	Description	Default
directory_path	Path | str	Path to the directory that contains the json files.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
document_type	str	The type of document being added. Accepted types are json, csv, and ndjson. For csv files the first row of the document should be a header row contining the field names, and ever for should have a title.	'json'
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
combine_documents	bool	If set to True this will combine the documents from all the files before indexing them. Defaults to True.	True
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> directory_path = Path("/path/to/directory/containing/files") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_from_directory_in_batches(directory_path)

Source code in meilisearch_python_sdk/index.py

def add_documents_from_directory_in_batches(
    self,
    directory_path: Path | str,
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    document_type: str = "json",
    csv_delimiter: str | None = None,
    combine_documents: bool = True,
    compress: bool = False,
) -> list[TaskInfo]:
    """Load all json files from a directory and add the documents to the index in batches.

    Args:
        directory_path: Path to the directory that contains the json files.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        document_type: The type of document being added. Accepted types are json, csv, and
            ndjson. For csv files the first row of the document should be a header row contining
            the field names, and ever for should have a title.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        combine_documents: If set to True this will combine the documents from all the files
            before indexing them. Defaults to True.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids to track the action.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> directory_path = Path("/path/to/directory/containing/files")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_from_directory_in_batches(directory_path)
    """
    directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

    if combine_documents:
        all_documents = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter=csv_delimiter, json_handler=self._json_handler
                )
                all_documents.append(documents)

        _raise_on_no_documents(all_documents, document_type, directory_path)

        combined = _combine_documents(all_documents)

        return self.add_documents_in_batches(
            combined,
            batch_size=batch_size,
            primary_key=primary_key,
            compress=compress,
        )

    responses: list[TaskInfo] = []
    for path in directory.iterdir():
        if path.suffix == f".{document_type}":
            documents = _load_documents_from_file(
                path, csv_delimiter, json_handler=self._json_handler
            )
            responses.extend(
                self.add_documents_in_batches(
                    documents,
                    batch_size=batch_size,
                    primary_key=primary_key,
                    compress=compress,
                )
            )

    _raise_on_no_documents(responses, document_type, directory_path)

    return responses

add_documents_from_file(file_path, primary_key=None, *, compress=False)

Add documents to the index from a json file.

Parameters:

Name	Type	Description	Default
file_path	Path | str	Path to the json file.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.json") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_from_file(file_path)

Source code in meilisearch_python_sdk/index.py

def add_documents_from_file(
    self,
    file_path: Path | str,
    primary_key: str | None = None,
    *,
    compress: bool = False,
) -> TaskInfo:
    """Add documents to the index from a json file.

    Args:
        file_path: Path to the json file.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task status.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.json")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_from_file(file_path)
    """
    documents = _load_documents_from_file(file_path, json_handler=self._json_handler)

    return self.add_documents(documents, primary_key=primary_key, compress=compress)

add_documents_from_file_in_batches(file_path, *, batch_size=1000, primary_key=None, csv_delimiter=None, compress=False)

Adds documents form a json file in batches to reduce RAM usage with indexing.

Parameters:

Name	Type	Description	Default
file_path	Path | str	Path to the json file.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.json") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_from_file_in_batches(file_path)

Source code in meilisearch_python_sdk/index.py

def add_documents_from_file_in_batches(
    self,
    file_path: Path | str,
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    csv_delimiter: str | None = None,
    compress: bool = False,
) -> list[TaskInfo]:
    """Adds documents form a json file in batches to reduce RAM usage with indexing.

    Args:
        file_path: Path to the json file.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids to track the action.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.json")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_from_file_in_batches(file_path)
    """
    documents = _load_documents_from_file(
        file_path, csv_delimiter, json_handler=self._json_handler
    )

    return self.add_documents_in_batches(
        documents,
        batch_size=batch_size,
        primary_key=primary_key,
        compress=compress,
    )

add_documents_from_raw_file(file_path, primary_key=None, *, csv_delimiter=None, compress=False)

Directly send csv or ndjson files to Meilisearch without pre-processing.

The can reduce RAM usage from Meilisearch during indexing, but does not include the option for batching.

Parameters:

Name	Type	Description	Default
file_path	Path | str	The path to the file to send to Meilisearch. Only csv and ndjson files are allowed.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task.

Raises:

Type	Description
ValueError	If the file is not a csv or ndjson file, or if a csv_delimiter is sent for a non-csv file.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.csv") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_from_raw_file(file_path)

Source code in meilisearch_python_sdk/index.py

def add_documents_from_raw_file(
    self,
    file_path: Path | str,
    primary_key: str | None = None,
    *,
    csv_delimiter: str | None = None,
    compress: bool = False,
) -> TaskInfo:
    """Directly send csv or ndjson files to Meilisearch without pre-processing.

    The can reduce RAM usage from Meilisearch during indexing, but does not include the option
    for batching.

    Args:
        file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
            allowed.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task.

    Raises:
        ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
            a non-csv file.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.csv")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_from_raw_file(file_path)
    """
    upload_path = Path(file_path) if isinstance(file_path, str) else file_path
    if not upload_path.exists():
        raise MeilisearchError("No file found at the specified path")

    if upload_path.suffix not in (".csv", ".ndjson"):
        raise ValueError("Only csv and ndjson files can be sent as binary files")

    if csv_delimiter and upload_path.suffix != ".csv":
        raise ValueError("A csv_delimiter can only be used with csv files")

    if (
        csv_delimiter
        and len(csv_delimiter) != 1
        or csv_delimiter
        and not csv_delimiter.isascii()
    ):
        raise ValueError("csv_delimiter must be a single ascii character")

    content_type = "text/csv" if upload_path.suffix == ".csv" else "application/x-ndjson"
    parameters = {}

    if primary_key:
        parameters["primaryKey"] = primary_key
    if csv_delimiter:
        parameters["csvDelimiter"] = csv_delimiter

    if parameters:
        url = _build_encoded_url(self._documents_url, parameters)
    else:
        url = self._documents_url

    with open(upload_path) as f:
        data = f.read()

    response = self._http_requests.post(
        url, body=data, content_type=content_type, compress=compress
    )

    return TaskInfo(**response.json())

add_documents_in_batches(documents, *, batch_size=1000, primary_key=None, compress=False)

Adds documents in batches to reduce RAM usage with indexing.

Parameters:

Name	Type	Description	Default
documents	Sequence[JsonMapping]	List of documents.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> >>> documents = [ >>> {"id": 1, "title": "Movie 1", "genre": "comedy"}, >>> {"id": 2, "title": "Movie 2", "genre": "drama"}, >>> ] >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.add_documents_in_batches(documents)

Source code in meilisearch_python_sdk/index.py

def add_documents_in_batches(
    self,
    documents: Sequence[JsonMapping],
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    compress: bool = False,
) -> list[TaskInfo]:
    """Adds documents in batches to reduce RAM usage with indexing.

    Args:
        documents: List of documents.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids 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_sdk import Client
        >>> >>> documents = [
        >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
        >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
        >>> ]
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.add_documents_in_batches(documents)
    """
    return [
        self.add_documents(x, primary_key, compress=compress)
        for x in _batch(documents, batch_size)
    ]

create(http_client, uid, primary_key=None, *, settings=None, wait=True, timeout_in_ms=None, plugins=None, json_handler=None, hits_type=JsonDict) classmethod

Creates a new index.

In general this method should not be used directly and instead the index should be created through the Client.

Parameters:

Name	Type	Description	Default
http_client	Client	An instance of the Client. This automatically gets passed by the Client when creating an Index instance.	required
uid	str	The index's unique identifier.	required
primary_key	str | None	The primary key of the documents. Defaults to None.	None
settings	MeilisearchSettings | None	Settings for the index. The settings can also be updated independently of creating the index. The advantage to updating them here is updating the settings after adding documents will cause the documents to be re-indexed. Because of this it will be faster to update them before adding documents. Defaults to None (i.e. default Meilisearch index settings).	None
wait	bool	If set to True and settings are being updated, the index will be returned after the settings update has completed. If False it will not wait for settings to complete. Default: True	True
timeout_in_ms	int | None	Amount of time in milliseconds to wait before raising a MeilisearchTimeoutError. None can also be passed to wait indefinitely. Be aware that if the None option is used the wait time could be very long. Defaults to None.	None
plugins	IndexPlugins | None	Optional plugins can be provided to extend functionality.	None
json_handler	BuiltinHandler | OrjsonHandler | UjsonHandler | None	The module to use for json operations. The options are BuiltinHandler (uses the json module from the standard library), OrjsonHandler (uses orjson), or UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding extra needs to be included. Default: BuiltinHandler.	None
hits_type	Any	Allows for a custom type to be passed to use for hits. Defaults to JsonDict	JsonDict

Returns:

Type	Description
Self	An instance of Index containing the information of the newly created index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = index.create(client, "movies")

Source code in meilisearch_python_sdk/index.py

@classmethod
def create(
    cls,
    http_client: Client,
    uid: str,
    primary_key: str | None = None,
    *,
    settings: MeilisearchSettings | None = None,
    wait: bool = True,
    timeout_in_ms: int | None = None,
    plugins: IndexPlugins | None = None,
    json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
    hits_type: Any = JsonDict,
) -> Self:
    """Creates a new index.

    In general this method should not be used directly and instead the index should be created
    through the `Client`.

    Args:
        http_client: An instance of the Client. This automatically gets passed by the Client
            when creating an Index instance.
        uid: The index's unique identifier.
        primary_key: The primary key of the documents. Defaults to None.
        settings: Settings for the index. The settings can also be updated independently of
            creating the index. The advantage to updating them here is updating the settings after
            adding documents will cause the documents to be re-indexed. Because of this it will be
            faster to update them before adding documents. Defaults to None (i.e. default
            Meilisearch index settings).
        wait: If set to True and settings are being updated, the index will be returned after
            the settings update has completed. If False it will not wait for settings to complete.
            Default: True
        timeout_in_ms: Amount of time in milliseconds to wait before raising a
            MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
            if the `None` option is used the wait time could be very long. Defaults to None.
        plugins: Optional plugins can be provided to extend functionality.
        json_handler: The module to use for json operations. The options are BuiltinHandler
            (uses the json module from the standard library), OrjsonHandler (uses orjson), or
            UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
            extra needs to be included. Default: BuiltinHandler.
        hits_type: Allows for a custom type to be passed to use for hits. Defaults to
            JsonDict

    Returns:
        An instance of Index containing the information of the newly created index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = index.create(client, "movies")
    """
    if not primary_key:
        payload = {"uid": uid}
    else:
        payload = {"primaryKey": primary_key, "uid": uid}

    url = "indexes"
    handler = json_handler if json_handler else BuiltinHandler()
    http_request = HttpRequests(http_client, handler)
    response = http_request.post(url, payload)
    wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=timeout_in_ms)
    index_response = http_request.get(f"{url}/{uid}")
    index_dict = index_response.json()
    index = cls(
        http_client=http_client,
        uid=index_dict["uid"],
        primary_key=index_dict["primaryKey"],
        created_at=index_dict["createdAt"],
        updated_at=index_dict["updatedAt"],
        plugins=plugins,
        json_handler=json_handler,
        hits_type=hits_type,
    )

    if settings:
        settings_task = index.update_settings(settings)
        if wait:
            wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=timeout_in_ms)

    return index

delete()

Deletes the index.

Returns:

Type	Description
TaskInfo	The details of the task.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete()

Source code in meilisearch_python_sdk/index.py

def delete(self) -> TaskInfo:
    """Deletes the index.

    Returns:
        The details of the task.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete()
    """
    response = self._http_requests.delete(self._base_url_with_uid)
    return TaskInfo(**response.json())

delete_all_documents()

Delete all documents from the index.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_all_document()

Source code in meilisearch_python_sdk/index.py

def delete_all_documents(self) -> TaskInfo:
    """Delete all documents from the index.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_all_document()
    """
    if self._pre_delete_all_documents_plugins:
        Index._run_plugins(self._pre_delete_all_documents_plugins, Event.PRE)

    response = self._http_requests.delete(self._documents_url)
    result = TaskInfo(**response.json())
    if self._post_delete_all_documents_plugins:
        post = Index._run_plugins(
            self._post_delete_all_documents_plugins, Event.POST, result=result
        )
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

delete_document(document_id)

Delete one document from the index.

Parameters:

Name	Type	Description	Default
document_id	str	Unique identifier of the document.	required

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_document("1234")

Source code in meilisearch_python_sdk/index.py

def delete_document(self, document_id: str) -> TaskInfo:
    """Delete one document from the index.

    Args:
        document_id: Unique identifier of the document.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_document("1234")
    """
    if self._pre_delete_document_plugins:
        Index._run_plugins(
            self._pre_delete_document_plugins, Event.PRE, document_id=document_id
        )

    response = self._http_requests.delete(f"{self._documents_url}/{document_id}")
    result = TaskInfo(**response.json())
    if self._post_delete_document_plugins:
        post = Index._run_plugins(self._post_delete_document_plugins, Event.POST, result=result)
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

delete_documents(ids)

Delete multiple documents from the index.

Parameters:

Name	Type	Description	Default
ids	list[str]	List of unique identifiers of documents.	required

Returns:

Type	Description
TaskInfo	List of update ids to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_documents(["1234", "5678"])

Source code in meilisearch_python_sdk/index.py

def delete_documents(self, ids: list[str]) -> TaskInfo:
    """Delete multiple documents from the index.

    Args:
        ids: List of unique identifiers of documents.

    Returns:
        List of update ids 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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_documents(["1234", "5678"])
    """
    if self._pre_delete_documents_plugins:
        Index._run_plugins(self._pre_delete_documents_plugins, Event.PRE, ids=ids)

    response = self._http_requests.post(f"{self._documents_url}/delete-batch", ids)
    result = TaskInfo(**response.json())
    if self._post_delete_documents_plugins:
        post = Index._run_plugins(
            self._post_delete_documents_plugins, Event.POST, result=result
        )
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

delete_documents_by_filter(filter)

Delete documents from the index by filter.

Parameters:

Name	Type	Description	Default
filter	Filter	The filter value information.	required

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_documents_by_filter("genre=horor"))

Source code in meilisearch_python_sdk/index.py

def delete_documents_by_filter(self, filter: Filter) -> TaskInfo:
    """Delete documents from the index by filter.

    Args:
        filter: The filter value information.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_documents_by_filter("genre=horor"))
    """
    if self._pre_delete_documents_by_filter_plugins:
        Index._run_plugins(
            self._pre_delete_documents_by_filter_plugins, Event.PRE, filter=filter
        )

    response = self._http_requests.post(
        f"{self._documents_url}/delete", body={"filter": filter}
    )
    result = TaskInfo(**response.json())
    if self._post_delete_documents_by_filter_plugins:
        post = Index._run_plugins(
            self._post_delete_documents_by_filter_plugins, Event.POST, result=result
        )
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

delete_documents_in_batches_by_filter(filters)

Delete batches of documents from the index by filter.

Parameters:

Name	Type	Description	Default
filters	list[str | list[str | list[str]]]	A list of filter value information.	required

Returns:

Type	Description
list[TaskInfo]	The a list of details of the task statuses.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_documents_in_batches_by_filter( >>> [ >>> "genre=horor"), >>> "release_date=1520035200"), >>> ] >>> )

Source code in meilisearch_python_sdk/index.py

def delete_documents_in_batches_by_filter(
    self, filters: list[str | list[str | list[str]]]
) -> list[TaskInfo]:
    """Delete batches of documents from the index by filter.

    Args:
        filters: A list of filter value information.

    Returns:
        The a list of details of the task statuses.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_documents_in_batches_by_filter(
        >>>     [
        >>>         "genre=horor"),
        >>>         "release_date=1520035200"),
        >>>     ]
        >>> )
    """
    return [self.delete_documents_by_filter(filter) for filter in filters]

delete_if_exists()

Delete the index if it already exists.

Returns:

Type	Description
bool	True if the index was deleted or False if not.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.delete_if_exists()

Source code in meilisearch_python_sdk/index.py

def delete_if_exists(self) -> bool:
    """Delete the index if it already exists.

    Returns:
        True if the index was deleted or False if not.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.delete_if_exists()
    """
    response = self.delete()
    status = wait_for_task(self.http_client, response.task_uid, timeout_in_ms=100000)
    if status.status == "succeeded":
        return True

    return False

edit_documents(function, *, context=None, filter=None)

Edit documents with a function.

Edit documents is only available in Meilisearch >= v1.10.0, and is experimental in Meilisearch v1.10.0. In order to use this feature you first need to enable it by sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.

Parameters:

Name	Type	Description	Default
function	str	Rhai function to use to update the documents.	required
context	JsonDict | None	Parameters to use in the function. Defaults to None.	None
filter	str | None	Filter the documents before applying the function. Defaults to None.	None

Returns:

Type	Description
TaskInfo	The details of the task.

Raises:

Type	Description
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.edit_documents("doc.title = ${doc.title.to_upper()}")

Source code in meilisearch_python_sdk/index.py

def edit_documents(
    self, function: str, *, context: JsonDict | None = None, filter: str | None = None
) -> TaskInfo:
    """Edit documents with a function.

    Edit documents is only available in Meilisearch >= v1.10.0, and is experimental in
    Meilisearch v1.10.0. In order to use this feature you first need to enable it by
    sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.

    Args:
        function: Rhai function to use to update the documents.
        context: Parameters to use in the function. Defaults to None.
        filter: Filter the documents before applying the function. Defaults to None.

    Returns:
        The details of the task.

    Raises:
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.edit_documents("doc.title = `${doc.title.to_upper()}`")
    """
    url = f"{self._documents_url}/edit"
    payload: JsonDict = {"function": function}

    if context:
        payload["context"] = context

    if filter:
        payload["filter"] = filter

    response = self._http_requests.post(url, payload)

    return TaskInfo(**response.json())

facet_search(query=None, *, facet_name, facet_query, offset=0, limit=20, filter=None, facets=None, attributes_to_retrieve=None, attributes_to_crop=None, crop_length=200, attributes_to_highlight=None, sort=None, show_matches_position=False, highlight_pre_tag='<em>', highlight_post_tag='</em>', crop_marker='...', matching_strategy='last', hits_per_page=None, page=None, attributes_to_search_on=None, show_ranking_score=False, show_ranking_score_details=False, ranking_score_threshold=None, vector=None, locales=None)

Search the index.

Parameters:

Name	Type	Description	Default
query	str | None	String containing the word(s) to search	None
facet_name	str	The name of the facet to search	required
facet_query	str	The facet search value	required
offset	int	Number of documents to skip. Defaults to 0.	0
limit	int	Maximum number of documents returned. Defaults to 20.	20
filter	Filter | None	Filter queries by an attribute value. Defaults to None.	None
facets	list[str] | None	Facets for which to retrieve the matching count. Defaults to None.	None
attributes_to_retrieve	list[str] | None	Attributes to display in the returned documents. Defaults to ["*"].	None
attributes_to_crop	list[str] | None	Attributes whose values have to be cropped. Defaults to None.	None
crop_length	int	The maximun number of words to display. Defaults to 200.	200
attributes_to_highlight	list[str] | None	Attributes whose values will contain highlighted matching terms. Defaults to None.	None
sort	list[str] | None	Attributes by which to sort the results. Defaults to None.	None
show_matches_position	bool	Defines whether an object that contains information about the matches should be returned or not. Defaults to False.	False
highlight_pre_tag	str	The opening tag for highlighting text. Defaults to .	'<em>'
highlight_post_tag	str	The closing tag for highlighting text. Defaults to	'</em>'
crop_marker	str	Marker to display when the number of words excedes the crop_length. Defaults to ...	'...'
matching_strategy	Literal['all', 'last', 'frequency']	Specifies the matching strategy Meilisearch should use. Defaults to last.	'last'
hits_per_page	int | None	Sets the number of results returned per page.	None
page	int | None	Sets the specific results page to fetch.	None
attributes_to_search_on	list[str] | None	List of field names. Allow search over a subset of searchable attributes without modifying the index settings. Defaults to None.	None
show_ranking_score	bool	If set to True the ranking score will be returned with each document in the search. Defaults to False.	False
show_ranking_score_details	bool	If set to True the ranking details will be returned with each document in the search. Defaults to False. Note: This parameter can only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order to use this feature in Meilisearch v1.3.0 you first need to enable the feature by sending a PATCH request to /experimental-features with { "scoreDetails": true }. Because this feature is experimental it may be removed or updated causing breaking changes in this library without a major version bump so use with caution. This feature became stable in Meiliseach v1.7.0.	False
ranking_score_threshold	float | None	If set, no document whose _rankingScore is under the rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults to None.	None
vector	list[float] | None	List of vectors for vector search. Defaults to None. Note: This parameter can only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order to use this feature in Meilisearch v1.3.0 you first need to enable the feature by sending a PATCH request to /experimental-features with { "vectorStore": true }. Because this feature is experimental it may be removed or updated causing breaking changes in this library without a major version bump so use with caution.	None
locales	list[str] | None	Specifies the languages for the search. This parameter can only be used with Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.	None

Returns:

Type	Description
FacetSearchResults	Results of the search

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> search_results = index.search( >>> "Tron", >>> facet_name="genre", >>> facet_query="Sci-fi" >>> )

Source code in meilisearch_python_sdk/index.py

def facet_search(
    self,
    query: str | None = None,
    *,
    facet_name: str,
    facet_query: str,
    offset: int = 0,
    limit: int = 20,
    filter: Filter | None = None,
    facets: list[str] | None = None,
    attributes_to_retrieve: list[str] | None = None,
    attributes_to_crop: list[str] | None = None,
    crop_length: int = 200,
    attributes_to_highlight: list[str] | None = None,
    sort: list[str] | None = None,
    show_matches_position: bool = False,
    highlight_pre_tag: str = "<em>",
    highlight_post_tag: str = "</em>",
    crop_marker: str = "...",
    matching_strategy: Literal["all", "last", "frequency"] = "last",
    hits_per_page: int | None = None,
    page: int | None = None,
    attributes_to_search_on: list[str] | None = None,
    show_ranking_score: bool = False,
    show_ranking_score_details: bool = False,
    ranking_score_threshold: float | None = None,
    vector: list[float] | None = None,
    locales: list[str] | None = None,
) -> FacetSearchResults:
    """Search the index.

    Args:
        query: String containing the word(s) to search
        facet_name: The name of the facet to search
        facet_query: The facet search value
        offset: Number of documents to skip. Defaults to 0.
        limit: Maximum number of documents returned. Defaults to 20.
        filter: Filter queries by an attribute value. Defaults to None.
        facets: Facets for which to retrieve the matching count. Defaults to None.
        attributes_to_retrieve: Attributes to display in the returned documents.
            Defaults to ["*"].
        attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
        crop_length: The maximun number of words to display. Defaults to 200.
        attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
            Defaults to None.
        sort: Attributes by which to sort the results. Defaults to None.
        show_matches_position: Defines whether an object that contains information about the
            matches should be returned or not. Defaults to False.
        highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
        highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
        crop_marker: Marker to display when the number of words excedes the `crop_length`.
            Defaults to ...
        matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
            `last`.
        hits_per_page: Sets the number of results returned per page.
        page: Sets the specific results page to fetch.
        attributes_to_search_on: List of field names. Allow search over a subset of searchable
            attributes without modifying the index settings. Defaults to None.
        show_ranking_score: If set to True the ranking score will be returned with each document
            in the search. Defaults to False.
        show_ranking_score_details: If set to True the ranking details will be returned with
            each document in the search. Defaults to False. Note: This parameter can only be
            used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order
            to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
            sending a PATCH request to /experimental-features with { "scoreDetails": true }.
            Because this feature is experimental it may be removed or updated causing breaking
            changes in this library without a major version bump so use with caution. This
            feature became stable in Meiliseach v1.7.0.
        ranking_score_threshold: If set, no document whose _rankingScore is under the
            rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
            to None.
        vector: List of vectors for vector search. Defaults to None. Note: This parameter can
            only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
            In order to use this feature in Meilisearch v1.3.0 you first need to enable the
            feature by sending a PATCH request to /experimental-features with
            { "vectorStore": true }. Because this feature is experimental it may be removed or
            updated causing breaking changes in this library without a major version bump so use
            with caution.
        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.

    Returns:
        Results of the search

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> search_results = index.search(
        >>>     "Tron",
        >>>     facet_name="genre",
        >>>     facet_query="Sci-fi"
        >>> )
    """
    if ranking_score_threshold:
        _validate_ranking_score_threshold(ranking_score_threshold)

    body = _process_search_parameters(
        q=query,
        facet_name=facet_name,
        facet_query=facet_query,
        offset=offset,
        limit=limit,
        filter=filter,
        facets=facets,
        attributes_to_retrieve=attributes_to_retrieve,
        attributes_to_crop=attributes_to_crop,
        crop_length=crop_length,
        attributes_to_highlight=attributes_to_highlight,
        sort=sort,
        show_matches_position=show_matches_position,
        highlight_pre_tag=highlight_pre_tag,
        highlight_post_tag=highlight_post_tag,
        crop_marker=crop_marker,
        matching_strategy=matching_strategy,
        hits_per_page=hits_per_page,
        page=page,
        attributes_to_search_on=attributes_to_search_on,
        show_ranking_score=show_ranking_score,
        show_ranking_score_details=show_ranking_score_details,
        ranking_score_threshold=ranking_score_threshold,
        vector=vector,
        locales=locales,
    )

    if self._pre_facet_search_plugins:
        Index._run_plugins(
            self._pre_facet_search_plugins,
            Event.PRE,
            query=query,
            offset=offset,
            limit=limit,
            filter=filter,
            facets=facets,
            attributes_to_retrieve=attributes_to_retrieve,
            attributes_to_crop=attributes_to_crop,
            crop_length=crop_length,
            attributes_to_highlight=attributes_to_highlight,
            sort=sort,
            show_matches_position=show_matches_position,
            highlight_pre_tag=highlight_pre_tag,
            highlight_post_tag=highlight_post_tag,
            crop_marker=crop_marker,
            matching_strategy=matching_strategy,
            hits_per_page=hits_per_page,
            page=page,
            attributes_to_search_on=attributes_to_search_on,
            show_ranking_score=show_ranking_score,
            show_ranking_score_details=show_ranking_score_details,
            ranking_score_threshold=ranking_score_threshold,
            vector=vector,
        )

    response = self._http_requests.post(f"{self._base_url_with_uid}/facet-search", body=body)
    result = FacetSearchResults(**response.json())
    if self._post_facet_search_plugins:
        post = Index._run_plugins(self._post_facet_search_plugins, Event.POST, result=result)
        if isinstance(post["generic_result"], FacetSearchResults):
            result = post["generic_result"]

    return result

fetch_info()

Gets the infromation about the index.

Returns:

Type	Description
Self	An instance of the AsyncIndex containing the retrieved information.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index_info = index.fetch_info()

Source code in meilisearch_python_sdk/index.py

def fetch_info(self) -> Self:
    """Gets the infromation about the index.

    Returns:
        An instance of the AsyncIndex containing the retrieved information.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index_info = index.fetch_info()
    """
    response = self._http_requests.get(self._base_url_with_uid)
    index_dict = response.json()
    self._set_fetch_info(
        index_dict["primaryKey"], index_dict["createdAt"], index_dict["updatedAt"]
    )
    return self

get_displayed_attributes()

Get displayed attributes of the index.

Returns:

Type	Description
list[str]	List containing the displayed attributes of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> displayed_attributes = index.get_displayed_attributes()

Source code in meilisearch_python_sdk/index.py

def get_displayed_attributes(self) -> list[str]:
    """Get displayed attributes of the index.

    Returns:
        List containing the displayed attributes of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> displayed_attributes = index.get_displayed_attributes()
    """
    response = self._http_requests.get(f"{self._settings_url}/displayed-attributes")

    return response.json()

get_distinct_attribute()

Get distinct attribute of the index.

Returns:

Type	Description
str | None	String containing the distinct attribute of the index. If no distinct attribute None is returned.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> distinct_attribute = index.get_distinct_attribute()

Source code in meilisearch_python_sdk/index.py

def get_distinct_attribute(self) -> str | None:
    """Get distinct attribute of the index.

    Returns:
        String containing the distinct attribute of the index. If no distinct attribute
            `None` is returned.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> distinct_attribute = index.get_distinct_attribute()
    """
    response = self._http_requests.get(f"{self._settings_url}/distinct-attribute")

    if not response.json():
        return None

    return response.json()

get_document(document_id)

Get one document with given document identifier.

Parameters:

Name	Type	Description	Default
document_id	str	Unique identifier of the document.	required

Returns:

Type	Description
JsonDict	The document information

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> document = index.get_document("1234")

Source code in meilisearch_python_sdk/index.py

def get_document(self, document_id: str) -> JsonDict:
    """Get one document with given document identifier.

    Args:
        document_id: Unique identifier of the document.

    Returns:
        The document information

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> document = index.get_document("1234")
    """
    response = self._http_requests.get(f"{self._documents_url}/{document_id}")

    return response.json()

get_documents(*, offset=0, limit=20, fields=None, filter=None)

Get a batch documents from the index.

Parameters:

Name	Type	Description	Default
offset	int	Number of documents to skip. Defaults to 0.	0
limit	int	Maximum number of documents returnedd. Defaults to 20.	20
fields	list[str] | None	Document attributes to show. If this value is None then all attributes are retrieved. Defaults to None.	None
filter	Filter | None	Filter value information. Defaults to None. Note: This parameter can only be used with Meilisearch >= v1.2.0	None

Returns:

Type	Description
DocumentsInfo	Documents info.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> documents = index.get_documents()

Source code in meilisearch_python_sdk/index.py

def get_documents(
    self,
    *,
    offset: int = 0,
    limit: int = 20,
    fields: list[str] | None = None,
    filter: Filter | None = None,
) -> DocumentsInfo:
    """Get a batch documents from the index.

    Args:
        offset: Number of documents to skip. Defaults to 0.
        limit: Maximum number of documents returnedd. Defaults to 20.
        fields: Document attributes to show. If this value is None then all
            attributes are retrieved. Defaults to None.
        filter: Filter value information. Defaults to None. Note: This parameter can only be
            used with Meilisearch >= v1.2.0

    Returns:
        Documents info.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.


    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> documents = index.get_documents()
    """
    parameters: JsonDict = {
        "offset": offset,
        "limit": limit,
    }

    if not filter:
        if fields:
            parameters["fields"] = ",".join(fields)

        url = _build_encoded_url(self._documents_url, parameters)
        response = self._http_requests.get(url)

        return DocumentsInfo(**response.json())

    if fields:
        parameters["fields"] = fields

    parameters["filter"] = filter
    response = self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)

    return DocumentsInfo(**response.json())

get_embedders()

Get embedder settings for the index.

Returns:

Type	Description
Embedders | None	Embedders for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> embedders = await index.get_embedders()

Source code in meilisearch_python_sdk/index.py

def get_embedders(self) -> Embedders | None:
    """Get embedder settings for the index.

    Returns:
        Embedders 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> embedders = await index.get_embedders()
    """
    response = self._http_requests.get(f"{self._settings_url}/embedders")

    return _embedder_json_to_embedders_model(response.json())

get_facet_search()

Get setting for facet search opt-out.

Returns:

Type	Description
bool	True if facet search is enabled or False if not.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> facet_search = await index.get_facet_search()

Source code in meilisearch_python_sdk/index.py

def get_facet_search(self) -> bool:
    """Get setting for facet search opt-out.

    Returns:
        True if facet search is enabled or False if not.

    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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> facet_search = await index.get_facet_search()
    """
    response = self._http_requests.get(f"{self._settings_url}/facet-search")

    return response.json()

get_faceting()

Get faceting for the index.

Returns:

Type	Description
Faceting	Faceting for the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> faceting = index.get_faceting()

Source code in meilisearch_python_sdk/index.py

def get_faceting(self) -> Faceting:
    """Get faceting for the index.

    Returns:
        Faceting 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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> faceting = index.get_faceting()
    """
    response = self._http_requests.get(f"{self._settings_url}/faceting")

    return Faceting(**response.json())

get_filterable_attributes()

Get filterable attributes of the index.

Returns:

Type	Description
list[str] | None	List containing the filterable attributes of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> filterable_attributes = index.get_filterable_attributes()

Source code in meilisearch_python_sdk/index.py

def get_filterable_attributes(self) -> list[str] | None:
    """Get filterable attributes of the index.

    Returns:
        List containing the filterable attributes of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> filterable_attributes = index.get_filterable_attributes()
    """
    response = self._http_requests.get(f"{self._settings_url}/filterable-attributes")

    if not response.json():
        return None

    return response.json()

get_localized_attributes()

Get localized attributes settings for the index.

Returns:

Type	Description
list[LocalizedAttributes] | None	Localized attributes for the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_async_client import AsyncClient >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> localized_attributes = await index.get_localized_attributes()

Source code in meilisearch_python_sdk/index.py

def get_localized_attributes(self) -> list[LocalizedAttributes] | None:
    """Get localized attributes settings for the index.

    Returns:
        Localized attributes 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 AsyncClient
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> localized_attributes = await index.get_localized_attributes()
    """
    response = self._http_requests.get(f"{self._settings_url}/localized-attributes")

    if not response.json():
        return None

    return [LocalizedAttributes(**x) for x in response.json()]

get_non_separator_tokens()

Get non-separator token settings for the index.

Returns:

Type	Description
list[str]	Non-separator tokens for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> non_separator_token_settings = index.get_non_separator_tokens()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> non_separator_token_settings = index.get_non_separator_tokens()
    """
    response = self._http_requests.get(f"{self._settings_url}/non-separator-tokens")

    return response.json()

get_pagination()

Get pagination settings for the index.

Returns:

Type	Description
Pagination	Pagination for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> pagination_settings = index.get_pagination()

Source code in meilisearch_python_sdk/index.py

def get_pagination(self) -> Pagination:
    """Get pagination settings for the index.

    Returns:
        Pagination 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> pagination_settings = index.get_pagination()
    """
    response = self._http_requests.get(f"{self._settings_url}/pagination")

    return Pagination(**response.json())

get_prefix_search()

Get setting for prefix search opt-out.

Returns:

Type	Description
bool	True if prefix search is enabled or False if not.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> prefix_search = index.get_prefix_search()

Source code in meilisearch_python_sdk/index.py

def get_prefix_search(self) -> bool:
    """Get setting for prefix search opt-out.

    Returns:
        True if prefix search is enabled or False if not.

    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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> prefix_search = index.get_prefix_search()
    """
    response = self._http_requests.get(f"{self._settings_url}/prefix-search")

    return response.json()

get_primary_key()

Get the primary key.

Returns:

Type	Description
str | None	The primary key for the documents in the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> primary_key = index.get_primary_key()

Source code in meilisearch_python_sdk/index.py

def get_primary_key(self) -> str | None:
    """Get the primary key.

    Returns:
        The primary key for the documents in the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> primary_key = index.get_primary_key()
    """
    info = self.fetch_info()
    return info.primary_key

get_proximity_precision()

Get proximity precision settings for the index.

Returns:

Type	Description
ProximityPrecision	Proximity precision for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> proximity_precision = index.get_proximity_precision()

Source code in meilisearch_python_sdk/index.py

def get_proximity_precision(self) -> ProximityPrecision:
    """Get proximity precision settings for the index.

    Returns:
        Proximity precision 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> proximity_precision = index.get_proximity_precision()
    """
    response = self._http_requests.get(f"{self._settings_url}/proximity-precision")

    return ProximityPrecision[to_snake(response.json()).upper()]

get_ranking_rules()

Get ranking rules of the index.

Returns:

Type	Description
list[str]	List containing the ranking rules of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> ranking_rules = index.get_ranking_rules()

Source code in meilisearch_python_sdk/index.py

def get_ranking_rules(self) -> list[str]:
    """Get ranking rules of the index.

    Returns:
        List containing the ranking rules of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> ranking_rules = index.get_ranking_rules()
    """
    response = self._http_requests.get(f"{self._settings_url}/ranking-rules")

    return response.json()

get_search_cutoff_ms()

Get search cutoff time in ms.

Returns:

Type	Description
int | None	Integer representing the search cutoff time in ms, or None.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> search_cutoff_ms_settings = index.get_search_cutoff_ms()

Source code in meilisearch_python_sdk/index.py

def get_search_cutoff_ms(self) -> int | None:
    """Get search cutoff time in ms.

    Returns:
        Integer representing the search cutoff time in ms, or None.

    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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> search_cutoff_ms_settings = index.get_search_cutoff_ms()
    """
    response = self._http_requests.get(f"{self._settings_url}/search-cutoff-ms")

    return response.json()

get_searchable_attributes()

Get searchable attributes of the index.

Returns:

Type	Description
list[str]	List containing the searchable attributes of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> searchable_attributes = index.get_searchable_attributes()

Source code in meilisearch_python_sdk/index.py

def get_searchable_attributes(self) -> list[str]:
    """Get searchable attributes of the index.

    Returns:
        List containing the searchable attributes of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> searchable_attributes = index.get_searchable_attributes()
    """
    response = self._http_requests.get(f"{self._settings_url}/searchable-attributes")

    return response.json()

get_separator_tokens()

Get separator token settings for the index.

Returns:

Type	Description
list[str]	Separator tokens for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> separator_token_settings = index.get_separator_tokens()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> separator_token_settings = index.get_separator_tokens()
    """
    response = self._http_requests.get(f"{self._settings_url}/separator-tokens")

    return response.json()

get_settings()

Get settings of the index.

Returns:

Type	Description
MeilisearchSettings	Settings of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> settings = index.get_settings()

Source code in meilisearch_python_sdk/index.py

def get_settings(self) -> MeilisearchSettings:
    """Get settings of the index.

    Returns:
        Settings of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> settings = index.get_settings()
    """
    response = self._http_requests.get(self._settings_url)
    response_json = response.json()
    settings = MeilisearchSettings(**response_json)

    if response_json.get("embedders"):
        # TODO: Add back after embedder setting issue fixed https://github.com/meilisearch/meilisearch/issues/4585
        settings.embedders = _embedder_json_to_settings_model(  # pragma: no cover
            response_json["embedders"]
        )

    return settings

get_sortable_attributes()

Get sortable attributes of the AsyncIndex.

Returns:

Type	Description
list[str]	List containing the sortable attributes of the AsyncIndex.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> sortable_attributes = index.get_sortable_attributes()

Source code in meilisearch_python_sdk/index.py

def get_sortable_attributes(self) -> list[str]:
    """Get sortable attributes of the AsyncIndex.

    Returns:
        List containing the sortable attributes of the AsyncIndex.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> sortable_attributes = index.get_sortable_attributes()
    """
    response = self._http_requests.get(f"{self._settings_url}/sortable-attributes")

    return response.json()

get_stats()

Get stats of the index.

Returns:

Type	Description
IndexStats	Stats of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> stats = index.get_stats()

Source code in meilisearch_python_sdk/index.py

def get_stats(self) -> IndexStats:
    """Get stats of the index.

    Returns:
        Stats of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> stats = index.get_stats()
    """
    response = self._http_requests.get(self._stats_url)

    return IndexStats(**response.json())

get_stop_words()

Get stop words of the index.

Returns:

Type	Description
list[str] | None	List containing the stop words of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> stop_words = index.get_stop_words()

Source code in meilisearch_python_sdk/index.py

def get_stop_words(self) -> list[str] | None:
    """Get stop words of the index.

    Returns:
        List containing the stop words of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> stop_words = index.get_stop_words()
    """
    response = self._http_requests.get(f"{self._settings_url}/stop-words")

    if not response.json():
        return None

    return response.json()

get_synonyms()

Get synonyms of the index.

Returns:

Type	Description
dict[str, list[str]] | None	The synonyms of the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> synonyms = index.get_synonyms()

Source code in meilisearch_python_sdk/index.py

def get_synonyms(self) -> dict[str, list[str]] | None:
    """Get synonyms of the index.

    Returns:
        The synonyms of the index.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> synonyms = index.get_synonyms()
    """
    response = self._http_requests.get(f"{self._settings_url}/synonyms")

    if not response.json():
        return None

    return response.json()

get_typo_tolerance()

Get typo tolerance for the index.

Returns:

Type	Description
TypoTolerance	TypoTolerance for the index.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> sortable_attributes = index.get_typo_tolerance()

Source code in meilisearch_python_sdk/index.py

def get_typo_tolerance(self) -> TypoTolerance:
    """Get typo tolerance for the index.

    Returns:
        TypoTolerance 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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> sortable_attributes = index.get_typo_tolerance()
    """
    response = self._http_requests.get(f"{self._settings_url}/typo-tolerance")

    return TypoTolerance(**response.json())

get_word_dictionary()

Get word dictionary settings for the index.

Returns:

Type	Description
list[str]	Word dictionary for the index.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> word_dictionary = index.get_word_dictionary()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> word_dictionary = index.get_word_dictionary()
    """
    response = self._http_requests.get(f"{self._settings_url}/dictionary")

    return response.json()

reset_displayed_attributes()

Reset displayed attributes of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_displayed_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_displayed_attributes(self) -> TaskInfo:
    """Reset displayed attributes of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_displayed_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/displayed-attributes")

    return TaskInfo(**response.json())

reset_distinct_attribute()

Reset distinct attribute of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_distinct_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_distinct_attribute(self) -> TaskInfo:
    """Reset distinct attribute of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_distinct_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/distinct-attribute")

    return TaskInfo(**response.json())

reset_embedders()

Reset an index's embedders settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = AsyncClient("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_embedders()

Source code in meilisearch_python_sdk/index.py

def reset_embedders(self) -> TaskInfo:  # pragma: no cover
    """Reset an index's embedders 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
        >>> client = AsyncClient("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_embedders()
    """
    response = self._http_requests.delete(f"{self._settings_url}/embedders")

    return TaskInfo(**response.json())

reset_facet_search()

Reset the facet search opt-out settings.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> await index.reset_facet_search()

Source code in meilisearch_python_sdk/index.py

def reset_facet_search(self) -> TaskInfo:
    """Reset the facet search opt-out settings.

    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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> await index.reset_facet_search()
    """
    response = self._http_requests.delete(f"{self._settings_url}/facet-search")

    return TaskInfo(**response.json())

reset_faceting()

Reset an index's faceting settings to their default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_faceting()

Source code in meilisearch_python_sdk/index.py

def reset_faceting(self) -> TaskInfo:
    """Reset an index's faceting settings to their 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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_faceting()
    """
    response = self._http_requests.delete(f"{self._settings_url}/faceting")

    return TaskInfo(**response.json())

reset_filterable_attributes()

Reset filterable attributes of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_filterable_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_filterable_attributes(self) -> TaskInfo:
    """Reset filterable attributes of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_filterable_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/filterable-attributes")

    return TaskInfo(**response.json())

reset_localized_attributes()

Reset an index's localized attributes settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_async_client import AsyncClient >>> Client("http://localhost.com", "masterKey") as client: >>> index = client.index("movies") >>> index.reset_localized_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_localized_attributes(self) -> TaskInfo:
    """Reset an index's localized attributes 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 AsyncClient
        >>> Client("http://localhost.com", "masterKey") as client:
        >>> index = client.index("movies")
        >>> index.reset_localized_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/localized-attributes")

    return TaskInfo(**response.json())

reset_non_separator_tokens()

Reset an index's non-separator tokens settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_non_separator_tokens()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_non_separator_tokens()
    """
    response = self._http_requests.delete(f"{self._settings_url}/non-separator-tokens")

    return TaskInfo(**response.json())

reset_pagination()

Reset an index's pagination settings to their default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_pagination()

Source code in meilisearch_python_sdk/index.py

def reset_pagination(self) -> TaskInfo:
    """Reset an index's pagination settings to their 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_pagination()
    """
    response = self._http_requests.delete(f"{self._settings_url}/pagination")

    return TaskInfo(**response.json())

reset_prefix_search()

Reset the prefix search opt-out settings.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_prefix_search()

Source code in meilisearch_python_sdk/index.py

def reset_prefix_search(self) -> TaskInfo:
    """Reset the prefix search opt-out settings.

    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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_prefix_search()
    """
    response = self._http_requests.delete(f"{self._settings_url}/prefix-search")

    return TaskInfo(**response.json())

reset_proximity_precision()

Reset an index's proximity precision settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_proximity_precision()

Source code in meilisearch_python_sdk/index.py

def reset_proximity_precision(self) -> TaskInfo:
    """Reset an index's proximity precision 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_proximity_precision()
    """
    response = self._http_requests.delete(f"{self._settings_url}/proximity-precision")

    return TaskInfo(**response.json())

reset_ranking_rules()

Reset ranking rules of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_ranking_rules()

Source code in meilisearch_python_sdk/index.py

def reset_ranking_rules(self) -> TaskInfo:
    """Reset ranking rules of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_ranking_rules()
    """
    response = self._http_requests.delete(f"{self._settings_url}/ranking-rules")

    return TaskInfo(**response.json())

reset_search_cutoff_ms()

Reset the search cutoff time to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_search_cutoff_ms()

Source code in meilisearch_python_sdk/index.py

def reset_search_cutoff_ms(self) -> TaskInfo:
    """Reset the search cutoff time 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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_search_cutoff_ms()
    """
    response = self._http_requests.delete(f"{self._settings_url}/search-cutoff-ms")

    return TaskInfo(**response.json())

reset_searchable_attributes()

Reset searchable attributes of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_searchable_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_searchable_attributes(self) -> TaskInfo:
    """Reset searchable attributes of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_searchable_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/searchable-attributes")

    return TaskInfo(**response.json())

reset_separator_tokens()

Reset an index's separator tokens settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_separator_tokens()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_separator_tokens()
    """
    response = self._http_requests.delete(f"{self._settings_url}/separator-tokens")

    return TaskInfo(**response.json())

reset_settings()

Reset settings of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_settings()

Source code in meilisearch_python_sdk/index.py

def reset_settings(self) -> TaskInfo:
    """Reset settings of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_settings()
    """
    response = self._http_requests.delete(self._settings_url)

    return TaskInfo(**response.json())

reset_sortable_attributes()

Reset sortable attributes of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_sortable_attributes()

Source code in meilisearch_python_sdk/index.py

def reset_sortable_attributes(self) -> TaskInfo:
    """Reset sortable attributes of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_sortable_attributes()
    """
    response = self._http_requests.delete(f"{self._settings_url}/sortable-attributes")

    return TaskInfo(**response.json())

reset_stop_words()

Reset stop words of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_stop_words()

Source code in meilisearch_python_sdk/index.py

def reset_stop_words(self) -> TaskInfo:
    """Reset stop words of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_stop_words()
    """
    response = self._http_requests.delete(f"{self._settings_url}/stop-words")

    return TaskInfo(**response.json())

reset_synonyms()

Reset synonyms of the index to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_synonyms()

Source code in meilisearch_python_sdk/index.py

def reset_synonyms(self) -> TaskInfo:
    """Reset synonyms of the index to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_synonyms()
    """
    response = self._http_requests.delete(f"{self._settings_url}/synonyms")

    return TaskInfo(**response.json())

reset_typo_tolerance()

Reset typo tolerance to default values.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_typo_tolerance()

Source code in meilisearch_python_sdk/index.py

def reset_typo_tolerance(self) -> TaskInfo:
    """Reset typo tolerance to default values.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_typo_tolerance()
    """
    response = self._http_requests.delete(f"{self._settings_url}/typo-tolerance")

    return TaskInfo(**response.json())

reset_word_dictionary()

Reset an index's word dictionary settings to the default value.

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
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 >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.reset_word_dictionary()

Source code in meilisearch_python_sdk/index.py

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
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.reset_word_dictionary()
    """
    response = self._http_requests.delete(f"{self._settings_url}/dictionary")

    return TaskInfo(**response.json())

search(query=None, *, offset=0, limit=20, filter=None, facets=None, attributes_to_retrieve=None, attributes_to_crop=None, crop_length=200, attributes_to_highlight=None, sort=None, show_matches_position=False, highlight_pre_tag='<em>', highlight_post_tag='</em>', crop_marker='...', matching_strategy='last', hits_per_page=None, page=None, attributes_to_search_on=None, distinct=None, show_ranking_score=False, show_ranking_score_details=False, ranking_score_threshold=None, vector=None, hybrid=None, locales=None)

Search the index.

Parameters:

Name	Type	Description	Default
query	str | None	String containing the word(s) to search	None
offset	int	Number of documents to skip. Defaults to 0.	0
limit	int	Maximum number of documents returned. Defaults to 20.	20
filter	Filter | None	Filter queries by an attribute value. Defaults to None.	None
facets	list[str] | None	Facets for which to retrieve the matching count. Defaults to None.	None
attributes_to_retrieve	list[str] | None	Attributes to display in the returned documents. Defaults to ["*"].	None
attributes_to_crop	list[str] | None	Attributes whose values have to be cropped. Defaults to None.	None
crop_length	int	The maximun number of words to display. Defaults to 200.	200
attributes_to_highlight	list[str] | None	Attributes whose values will contain highlighted matching terms. Defaults to None.	None
sort	list[str] | None	Attributes by which to sort the results. Defaults to None.	None
show_matches_position	bool	Defines whether an object that contains information about the matches should be returned or not. Defaults to False.	False
highlight_pre_tag	str	The opening tag for highlighting text. Defaults to .	'<em>'
highlight_post_tag	str	The closing tag for highlighting text. Defaults to	'</em>'
crop_marker	str	Marker to display when the number of words excedes the crop_length. Defaults to ...	'...'
matching_strategy	Literal['all', 'last', 'frequency']	Specifies the matching strategy Meilisearch should use. Defaults to last.	'last'
hits_per_page	int | None	Sets the number of results returned per page.	None
page	int | None	Sets the specific results page to fetch.	None
attributes_to_search_on	list[str] | None	List of field names. Allow search over a subset of searchable attributes without modifying the index settings. Defaults to None.	None
distinct	str | None	If set the distinct value will return at most one result for the filterable attribute. Note that a filterable attributes must be set for this work. Defaults to None.	None
show_ranking_score	bool	If set to True the ranking score will be returned with each document in the search. Defaults to False.	False
show_ranking_score_details	bool	If set to True the ranking details will be returned with each document in the search. Defaults to False. Note: This parameter can only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order to use this feature in Meilisearch v1.3.0 you first need to enable the feature by sending a PATCH request to /experimental-features with { "scoreDetails": true }. Because this feature is experimental it may be removed or updated causing breaking changes in this library without a major version bump so use with caution. This feature became stable in Meiliseach v1.7.0.	False
ranking_score_threshold	float | None	If set, no document whose _rankingScore is under the rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults to None.	None
vector	list[float] | None	List of vectors for vector search. Defaults to None. Note: This parameter can only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order to use this feature in Meilisearch v1.3.0 you first need to enable the feature by sending a PATCH request to /experimental-features with { "vectorStore": true }. Because this feature is experimental it may be removed or updated causing breaking changes in this library without a major version bump so use with caution.	None
hybrid	Hybrid | None	Hybrid search information. Defaults to None. Note: This parameter can only be used with Meilisearch >= v1.6.0, and is experimental in Meilisearch v1.6.0. In order to use this feature in Meilisearch v1.6.0 you first need to enable the feature by sending a PATCH request to /experimental-features with { "vectorStore": true }. Because this feature is experimental it may be removed or updated causing breaking changes in this library without a major version bump so use with caution.	None
locales	list[str] | None	Specifies the languages for the search. This parameter can only be used with Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.	None

Returns:

Type	Description
SearchResults	Results of the search

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> search_results = index.search("Tron")

Source code in meilisearch_python_sdk/index.py

def search(
    self,
    query: str | None = None,
    *,
    offset: int = 0,
    limit: int = 20,
    filter: Filter | None = None,
    facets: list[str] | None = None,
    attributes_to_retrieve: list[str] | None = None,
    attributes_to_crop: list[str] | None = None,
    crop_length: int = 200,
    attributes_to_highlight: list[str] | None = None,
    sort: list[str] | None = None,
    show_matches_position: bool = False,
    highlight_pre_tag: str = "<em>",
    highlight_post_tag: str = "</em>",
    crop_marker: str = "...",
    matching_strategy: Literal["all", "last", "frequency"] = "last",
    hits_per_page: int | None = None,
    page: int | None = None,
    attributes_to_search_on: list[str] | None = None,
    distinct: str | None = None,
    show_ranking_score: bool = False,
    show_ranking_score_details: bool = False,
    ranking_score_threshold: float | None = None,
    vector: list[float] | None = None,
    hybrid: Hybrid | None = None,
    locales: list[str] | None = None,
) -> SearchResults:
    """Search the index.

    Args:
        query: String containing the word(s) to search
        offset: Number of documents to skip. Defaults to 0.
        limit: Maximum number of documents returned. Defaults to 20.
        filter: Filter queries by an attribute value. Defaults to None.
        facets: Facets for which to retrieve the matching count. Defaults to None.
        attributes_to_retrieve: Attributes to display in the returned documents.
            Defaults to ["*"].
        attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
        crop_length: The maximun number of words to display. Defaults to 200.
        attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
            Defaults to None.
        sort: Attributes by which to sort the results. Defaults to None.
        show_matches_position: Defines whether an object that contains information about the
            matches should be returned or not. Defaults to False.
        highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
        highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
        crop_marker: Marker to display when the number of words excedes the `crop_length`.
            Defaults to ...
        matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
            `last`.
        hits_per_page: Sets the number of results returned per page.
        page: Sets the specific results page to fetch.
        attributes_to_search_on: List of field names. Allow search over a subset of searchable
            attributes without modifying the index settings. Defaults to None.
        distinct: If set the distinct value will return at most one result for the
            filterable attribute. Note that a filterable attributes must be set for this work.
            Defaults to None.
        show_ranking_score: If set to True the ranking score will be returned with each document
            in the search. Defaults to False.
        show_ranking_score_details: If set to True the ranking details will be returned with
            each document in the search. Defaults to False. Note: This parameter can only be
            used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0. In order
            to use this feature in Meilisearch v1.3.0 you first need to enable the feature by
            sending a PATCH request to /experimental-features with { "scoreDetails": true }.
            Because this feature is experimental it may be removed or updated causing breaking
            changes in this library without a major version bump so use with caution. This
            feature became stable in Meiliseach v1.7.0.
        ranking_score_threshold: If set, no document whose _rankingScore is under the
            rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
            to None.
        vector: List of vectors for vector search. Defaults to None. Note: This parameter can
            only be used with Meilisearch >= v1.3.0, and is experimental in Meilisearch v1.3.0.
            In order to use this feature in Meilisearch v1.3.0 you first need to enable the
            feature by sending a PATCH request to /experimental-features with
            { "vectorStore": true }. Because this feature is experimental it may be removed or
            updated causing breaking changes in this library without a major version bump so use
            with caution.
        hybrid: Hybrid search information. Defaults to None. Note: This parameter can
            only be used with Meilisearch >= v1.6.0, and is experimental in Meilisearch v1.6.0.
            In order to use this feature in Meilisearch v1.6.0 you first need to enable the
            feature by sending a PATCH request to /experimental-features with
            { "vectorStore": true }. Because this feature is experimental it may be removed or
            updated causing breaking changes in this library without a major version bump so use
            with caution.
        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.

    Returns:
        Results of the search

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> search_results = index.search("Tron")
    """
    if ranking_score_threshold:
        _validate_ranking_score_threshold(ranking_score_threshold)

    body = _process_search_parameters(
        q=query,
        offset=offset,
        limit=limit,
        filter=filter,
        facets=facets,
        attributes_to_retrieve=attributes_to_retrieve,
        attributes_to_crop=attributes_to_crop,
        crop_length=crop_length,
        attributes_to_highlight=attributes_to_highlight,
        sort=sort,
        show_matches_position=show_matches_position,
        highlight_pre_tag=highlight_pre_tag,
        highlight_post_tag=highlight_post_tag,
        crop_marker=crop_marker,
        matching_strategy=matching_strategy,
        hits_per_page=hits_per_page,
        page=page,
        attributes_to_search_on=attributes_to_search_on,
        distinct=distinct,
        show_ranking_score=show_ranking_score,
        show_ranking_score_details=show_ranking_score_details,
        vector=vector,
        hybrid=hybrid,
        ranking_score_threshold=ranking_score_threshold,
        locales=locales,
    )

    if self._pre_search_plugins:
        Index._run_plugins(
            self._pre_search_plugins,
            Event.PRE,
            query=query,
            offset=offset,
            limit=limit,
            filter=filter,
            facets=facets,
            attributes_to_retrieve=attributes_to_retrieve,
            attributes_to_crop=attributes_to_crop,
            crop_length=crop_length,
            attributes_to_highlight=attributes_to_highlight,
            sort=sort,
            show_matches_position=show_matches_position,
            highlight_pre_tag=highlight_pre_tag,
            highlight_post_tag=highlight_post_tag,
            crop_marker=crop_marker,
            matching_strategy=matching_strategy,
            hits_per_page=hits_per_page,
            page=page,
            attributes_to_search_on=attributes_to_search_on,
            distinct=distinct,
            show_ranking_score=show_ranking_score,
            show_ranking_score_details=show_ranking_score_details,
            vector=vector,
            hybrid=hybrid,
        )

    response = self._http_requests.post(f"{self._base_url_with_uid}/search", body=body)
    result = SearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
    if self._post_search_plugins:
        post = Index._run_plugins(self._post_search_plugins, Event.POST, search_results=result)
        if post.get("search_result"):
            result = post["search_result"]

    return result

search_similar_documents(id, *, offset=None, limit=None, filter=None, embedder='default', attributes_to_retrieve=None, show_ranking_score=False, show_ranking_score_details=False, ranking_score_threshold=None)

Search the index.

Parameters:

Name	Type	Description	Default
id	str	The id for the target document that is being used to find similar documents.	required
offset	int | None	Number of documents to skip. Defaults to 0.	None
limit	int | None	Maximum number of documents returned. Defaults to 20.	None
filter	str | None	Filter queries by an attribute value. Defaults to None.	None
embedder	str	The vector DB to use for the search.	'default'
attributes_to_retrieve	list[str] | None	Attributes to display in the returned documents. Defaults to ["*"].	None
show_ranking_score	bool	If set to True the ranking score will be returned with each document in the search. Defaults to False.	False
show_ranking_score_details	bool	If set to True the ranking details will be returned with each document in the search. Defaults to False.	False
ranking_score_threshold	float | None	If set, no document whose _rankingScore is under the rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults to None.	None

Returns:

Type	Description
SimilarSearchResults	Results of the search

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> search_results = index.search_similar_documents("123")

Source code in meilisearch_python_sdk/index.py

def search_similar_documents(
    self,
    id: str,
    *,
    offset: int | None = None,
    limit: int | None = None,
    filter: str | None = None,
    embedder: str = "default",
    attributes_to_retrieve: list[str] | None = None,
    show_ranking_score: bool = False,
    show_ranking_score_details: bool = False,
    ranking_score_threshold: float | None = None,
) -> SimilarSearchResults:
    """Search the index.

    Args:
        id: The id for the target document that is being used to find similar documents.
        offset: Number of documents to skip. Defaults to 0.
        limit: Maximum number of documents returned. Defaults to 20.
        filter: Filter queries by an attribute value. Defaults to None.
        embedder: The vector DB to use for the search.
        attributes_to_retrieve: Attributes to display in the returned documents.
            Defaults to ["*"].
        show_ranking_score: If set to True the ranking score will be returned with each document
            in the search. Defaults to False.
        show_ranking_score_details: If set to True the ranking details will be returned with
            each document in the search. Defaults to False.
        ranking_score_threshold: If set, no document whose _rankingScore is under the
            rankingScoreThreshold is returned. The value must be between 0.0 and 1.0. Defaults
            to None.

    Returns:
        Results of the search

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> search_results = index.search_similar_documents("123")
    """
    payload = {
        "id": id,
        "filter": filter,
        "embedder": embedder,
        "attributesToRetrieve": attributes_to_retrieve,
        "showRankingScore": show_ranking_score,
        "showRankingScoreDetails": show_ranking_score_details,
        "rankingScoreThreshold": ranking_score_threshold,
    }

    if offset:
        payload["offset"] = offset

    if limit:
        payload["limit"] = limit

    response = self._http_requests.post(f"{self._base_url_with_uid}/similar", body=payload)

    return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]

update(primary_key)

Update the index primary key.

Parameters:

Name	Type	Description	Default
primary_key	str	The primary key of the documents.	required

Returns:

Type	Description
Self	An instance of the AsyncIndex with the updated information.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> updated_index = index.update()

Source code in meilisearch_python_sdk/index.py

def update(self, primary_key: str) -> Self:
    """Update the index primary key.

    Args:
        primary_key: The primary key of the documents.

    Returns:
        An instance of the AsyncIndex with the updated information.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> updated_index = index.update()
    """
    payload = {"primaryKey": primary_key}
    response = self._http_requests.patch(self._base_url_with_uid, payload)
    wait_for_task(self.http_client, response.json()["taskUid"], timeout_in_ms=100000)
    index_response = self._http_requests.get(self._base_url_with_uid)
    self.primary_key = index_response.json()["primaryKey"]
    return self

update_displayed_attributes(body, *, compress=False)

Update displayed attributes of the index.

Parameters:

Name	Type	Description	Default
body	list[str]	List containing the displayed attributes.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_displayed_attributes( >>> ["title", "description", "genre", "release_date"] >>> )

Source code in meilisearch_python_sdk/index.py

def update_displayed_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
    """Update displayed attributes of the index.

    Args:
        body: List containing the displayed attributes.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_displayed_attributes(
        >>>     ["title", "description", "genre", "release_date"]
        >>> )
    """
    response = self._http_requests.put(
        f"{self._settings_url}/displayed-attributes", body, compress=compress
    )

    return TaskInfo(**response.json())

update_distinct_attribute(body, *, compress=False)

Update distinct attribute of the index.

Parameters:

Name	Type	Description	Default
body	str	Distinct attribute.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_distinct_attribute("url")

Source code in meilisearch_python_sdk/index.py

def update_distinct_attribute(self, body: str, *, compress: bool = False) -> TaskInfo:
    """Update distinct attribute of the index.

    Args:
        body: Distinct attribute.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_distinct_attribute("url")
    """
    response = self._http_requests.put(
        f"{self._settings_url}/distinct-attribute", body, compress=compress
    )

    return TaskInfo(**response.json())

update_documents(documents, primary_key=None, *, compress=False)

Update documents in the index.

Parameters:

Name	Type	Description	Default
documents	Sequence[JsonMapping]	List of documents.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> documents = [ >>> {"id": 1, "title": "Movie 1", "genre": "comedy"}, >>> {"id": 2, "title": "Movie 2", "genre": "drama"}, >>> ] >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_documents(documents)

Source code in meilisearch_python_sdk/index.py

def update_documents(
    self,
    documents: Sequence[JsonMapping],
    primary_key: str | None = None,
    *,
    compress: bool = False,
) -> TaskInfo:
    """Update documents in the index.

    Args:
        documents: List of documents.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task.

    Raises:
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from meilisearch_python_sdk import Client
        >>> documents = [
        >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
        >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
        >>> ]
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_documents(documents)
    """
    if primary_key:
        url = _build_encoded_url(self._documents_url, {"primaryKey": primary_key})
    else:
        url = self._documents_url

    if self._pre_update_documents_plugins:
        pre = Index._run_plugins(
            self._pre_update_documents_plugins,
            Event.PRE,
            documents=documents,
            primary_key=primary_key,
        )
        if pre.get("document_result"):
            documents = pre["document_result"]

    response = self._http_requests.put(url, documents, compress=compress)
    result = TaskInfo(**response.json())
    if self._post_update_documents_plugins:
        post = Index._run_plugins(
            self._post_update_documents_plugins, Event.POST, result=result
        )
        if isinstance(post.get("generic_result"), TaskInfo):
            result = post["generic_result"]

    return result

update_documents_from_directory(directory_path, *, primary_key=None, document_type='json', csv_delimiter=None, combine_documents=True, compress=False)

Load all json files from a directory and update the documents.

Parameters:

Name	Type	Description	Default
directory_path	Path | str	Path to the directory that contains the json files.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
document_type	str	The type of document being added. Accepted types are json, csv, and ndjson. For csv files the first row of the document should be a header row contining the field names, and ever for should have a title.	'json'
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
combine_documents	bool	If set to True this will combine the documents from all the files before indexing them. Defaults to True.	True
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	The details of the task status.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> directory_path = Path("/path/to/directory/containing/files") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_documents_from_directory(directory_path)

Source code in meilisearch_python_sdk/index.py

def update_documents_from_directory(
    self,
    directory_path: Path | str,
    *,
    primary_key: str | None = None,
    document_type: str = "json",
    csv_delimiter: str | None = None,
    combine_documents: bool = True,
    compress: bool = False,
) -> list[TaskInfo]:
    """Load all json files from a directory and update the documents.

    Args:
        directory_path: Path to the directory that contains the json files.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        document_type: The type of document being added. Accepted types are json, csv, and
            ndjson. For csv files the first row of the document should be a header row contining
            the field names, and ever for should have a title.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        combine_documents: If set to True this will combine the documents from all the files
            before indexing them. Defaults to True.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task status.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> directory_path = Path("/path/to/directory/containing/files")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_documents_from_directory(directory_path)
    """
    directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

    if combine_documents:
        all_documents = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                all_documents.append(documents)

        _raise_on_no_documents(all_documents, document_type, directory_path)

        combined = _combine_documents(all_documents)

        response = self.update_documents(combined, primary_key, compress=compress)
        return [response]

    responses = []
    for path in directory.iterdir():
        if path.suffix == f".{document_type}":
            documents = _load_documents_from_file(
                path, csv_delimiter, json_handler=self._json_handler
            )
            responses.append(self.update_documents(documents, primary_key, compress=compress))

    _raise_on_no_documents(responses, document_type, directory_path)

    return responses

update_documents_from_directory_in_batches(directory_path, *, batch_size=1000, primary_key=None, document_type='json', csv_delimiter=None, combine_documents=True, compress=False)

Load all json files from a directory and update the documents.

Parameters:

Name	Type	Description	Default
directory_path	Path | str	Path to the directory that contains the json files.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
document_type	str	The type of document being added. Accepted types are json, csv, and ndjson. For csv files the first row of the document should be a header row contining the field names, and ever for should have a title.	'json'
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
combine_documents	bool	If set to True this will combine the documents from all the files before indexing them. Defaults to True.	True
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
InvalidDocumentError	If the docucment is not a valid format for Meilisearch.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> directory_path = Path("/path/to/directory/containing/files") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_documents_from_directory_in_batches(directory_path)

Source code in meilisearch_python_sdk/index.py

def update_documents_from_directory_in_batches(
    self,
    directory_path: Path | str,
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    document_type: str = "json",
    csv_delimiter: str | None = None,
    combine_documents: bool = True,
    compress: bool = False,
) -> list[TaskInfo]:
    """Load all json files from a directory and update the documents.

    Args:
        directory_path: Path to the directory that contains the json files.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        document_type: The type of document being added. Accepted types are json, csv, and
            ndjson. For csv files the first row of the document should be a header row contining
            the field names, and ever for should have a title.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        combine_documents: If set to True this will combine the documents from all the files
            before indexing them. Defaults to True.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids to track the action.

    Raises:
        InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> directory_path = Path("/path/to/directory/containing/files")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_documents_from_directory_in_batches(directory_path)
    """
    directory = Path(directory_path) if isinstance(directory_path, str) else directory_path

    if combine_documents:
        all_documents = []
        for path in directory.iterdir():
            if path.suffix == f".{document_type}":
                documents = _load_documents_from_file(
                    path, csv_delimiter, json_handler=self._json_handler
                )
                all_documents.append(documents)

        _raise_on_no_documents(all_documents, document_type, directory_path)

        combined = _combine_documents(all_documents)

        return self.update_documents_in_batches(
            combined,
            batch_size=batch_size,
            primary_key=primary_key,
            compress=compress,
        )

    responses: list[TaskInfo] = []

    for path in directory.iterdir():
        if path.suffix == f".{document_type}":
            documents = _load_documents_from_file(
                path, csv_delimiter, json_handler=self._json_handler
            )
            responses.extend(
                self.update_documents_in_batches(
                    documents,
                    batch_size=batch_size,
                    primary_key=primary_key,
                    compress=compress,
                )
            )

    _raise_on_no_documents(responses, document_type, directory_path)

    return responses

update_documents_from_file(file_path, primary_key=None, csv_delimiter=None, *, compress=False)

Add documents in the index from a json file.

Parameters:

Name	Type	Description	Default
file_path	Path | str	Path to the json file.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.json") >>> client = Client("http://localhost.com", "masterKey") as client: >>> index = client.index("movies") >>> index.update_documents_from_file(file_path)

Source code in meilisearch_python_sdk/index.py

def update_documents_from_file(
    self,
    file_path: Path | str,
    primary_key: str | None = None,
    csv_delimiter: str | None = None,
    *,
    compress: bool = False,
) -> TaskInfo:
    """Add documents in the index from a json file.

    Args:
        file_path: Path to the json file.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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 pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.json")
        >>> client = Client("http://localhost.com", "masterKey") as client:
        >>> index = client.index("movies")
        >>> index.update_documents_from_file(file_path)
    """
    documents = _load_documents_from_file(
        file_path, csv_delimiter, json_handler=self._json_handler
    )

    return self.update_documents(documents, primary_key=primary_key, compress=compress)

update_documents_from_file_in_batches(file_path, *, batch_size=1000, primary_key=None, compress=False)

Updates documents form a json file in batches to reduce RAM usage with indexing.

Parameters:

Name	Type	Description	Default
file_path	Path | str	Path to the json file.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.json") >>> client = Client("http://localhost.com", "masterKey") as client: >>> index = client.index("movies") >>> index.update_documents_from_file_in_batches(file_path)

Source code in meilisearch_python_sdk/index.py

def update_documents_from_file_in_batches(
    self,
    file_path: Path | str,
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    compress: bool = False,
) -> list[TaskInfo]:
    """Updates documents form a json file in batches to reduce RAM usage with indexing.

    Args:
        file_path: Path to the json file.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids 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 pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.json")
        >>> client = Client("http://localhost.com", "masterKey") as client:
        >>> index = client.index("movies")
        >>> index.update_documents_from_file_in_batches(file_path)
    """
    documents = _load_documents_from_file(file_path, json_handler=self._json_handler)

    return self.update_documents_in_batches(
        documents,
        batch_size=batch_size,
        primary_key=primary_key,
        compress=compress,
    )

update_documents_from_raw_file(file_path, primary_key=None, csv_delimiter=None, *, compress=False)

Directly send csv or ndjson files to Meilisearch without pre-processing.

The can reduce RAM usage from Meilisearch during indexing, but does not include the option for batching.

Parameters:

Name	Type	Description	Default
file_path	Path | str	The path to the file to send to Meilisearch. Only csv and ndjson files are allowed.	required
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
csv_delimiter	str | None	A single ASCII character to specify the delimiter for csv files. This can only be used if the file is a csv file. Defaults to comma.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
ValueError	If the file is not a csv or ndjson file, or if a csv_delimiter is sent for a non-csv file.
MeilisearchError	If the file path is not valid
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from pathlib import Path >>> from meilisearch_python_sdk import Client >>> file_path = Path("/path/to/file.csv") >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_documents_from_raw_file(file_path)

Source code in meilisearch_python_sdk/index.py

def update_documents_from_raw_file(
    self,
    file_path: Path | str,
    primary_key: str | None = None,
    csv_delimiter: str | None = None,
    *,
    compress: bool = False,
) -> TaskInfo:
    """Directly send csv or ndjson files to Meilisearch without pre-processing.

    The can reduce RAM usage from Meilisearch during indexing, but does not include the option
    for batching.

    Args:
        file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
            allowed.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
            can only be used if the file is a csv file. Defaults to comma.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        The details of the task status.

    Raises:
        ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
            a non-csv file.
        MeilisearchError: If the file path is not valid
        MeilisearchCommunicationError: If there was an error communicating with the server.
        MeilisearchApiError: If the Meilisearch API returned an error.

    Examples
        >>> from pathlib import Path
        >>> from meilisearch_python_sdk import Client
        >>> file_path = Path("/path/to/file.csv")
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_documents_from_raw_file(file_path)
    """
    upload_path = Path(file_path) if isinstance(file_path, str) else file_path
    if not upload_path.exists():
        raise MeilisearchError("No file found at the specified path")

    if upload_path.suffix not in (".csv", ".ndjson"):
        raise ValueError("Only csv and ndjson files can be sent as binary files")

    if csv_delimiter and upload_path.suffix != ".csv":
        raise ValueError("A csv_delimiter can only be used with csv files")

    if (
        csv_delimiter
        and len(csv_delimiter) != 1
        or csv_delimiter
        and not csv_delimiter.isascii()
    ):
        raise ValueError("csv_delimiter must be a single ascii character")

    content_type = "text/csv" if upload_path.suffix == ".csv" else "application/x-ndjson"
    parameters = {}

    if primary_key:
        parameters["primaryKey"] = primary_key
    if csv_delimiter:
        parameters["csvDelimiter"] = csv_delimiter

    if parameters:
        url = _build_encoded_url(self._documents_url, parameters)
    else:
        url = self._documents_url

    with open(upload_path) as f:
        data = f.read()

    response = self._http_requests.put(
        url, body=data, content_type=content_type, compress=compress
    )

    return TaskInfo(**response.json())

update_documents_in_batches(documents, *, batch_size=1000, primary_key=None, compress=False)

Update documents in batches to reduce RAM usage with indexing.

Each batch tries to fill the max_payload_size

Parameters:

Name	Type	Description	Default
documents	Sequence[JsonMapping]	List of documents.	required
batch_size	int	The number of documents that should be included in each batch. Defaults to 1000.	1000
primary_key	str | None	The primary key of the documents. This will be ignored if already set. Defaults to None.	None
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
list[TaskInfo]	List of update ids to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> documents = [ >>> {"id": 1, "title": "Movie 1", "genre": "comedy"}, >>> {"id": 2, "title": "Movie 2", "genre": "drama"}, >>> ] >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_documents_in_batches(documents)

Source code in meilisearch_python_sdk/index.py

def update_documents_in_batches(
    self,
    documents: Sequence[JsonMapping],
    *,
    batch_size: int = 1000,
    primary_key: str | None = None,
    compress: bool = False,
) -> list[TaskInfo]:
    """Update documents in batches to reduce RAM usage with indexing.

    Each batch tries to fill the max_payload_size

    Args:
        documents: List of documents.
        batch_size: The number of documents that should be included in each batch.
            Defaults to 1000.
        primary_key: The primary key of the documents. This will be ignored if already set.
            Defaults to None.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    Returns:
        List of update ids 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_sdk import Client
        >>> documents = [
        >>>     {"id": 1, "title": "Movie 1", "genre": "comedy"},
        >>>     {"id": 2, "title": "Movie 2", "genre": "drama"},
        >>> ]
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_documents_in_batches(documents)
    """
    return [
        self.update_documents(x, primary_key, compress=compress)
        for x in _batch(documents, batch_size)
    ]

update_embedders(embedders, *, compress=False)

Update the embedders settings for an index.

Parameters:

Name	Type	Description	Default
embedders	Embedders	The embedders value.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk.models.settings import Embedders, UserProvidedEmbedder >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_embedders( >>> Embedders(embedders={dimensions=512)}) >>> )

Source code in meilisearch_python_sdk/index.py

def update_embedders(self, embedders: Embedders, *, compress: bool = False) -> TaskInfo:
    """Update the embedders settings for an index.

    Args:
        embedders: The embedders value.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> from meilisearch_python_sdk.models.settings import Embedders, UserProvidedEmbedder
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_embedders(
        >>>     Embedders(embedders={dimensions=512)})
        >>> )
    """
    payload = {}
    for key, embedder in embedders.embedders.items():
        payload[key] = {
            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(
        f"{self._settings_url}/embedders", payload, compress=compress
    )

    return TaskInfo(**response.json())

update_facet_search(facet_search, *, compress=False)

Update setting for facet search opt-out.

Parameters:

Name	Type	Description	Default
facet_search	bool	Boolean indicating if facet search should be disabled.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_facet_search(True)

Source code in meilisearch_python_sdk/index.py

def update_facet_search(self, facet_search: bool, *, compress: bool = False) -> TaskInfo:
    """Update setting for facet search opt-out.

    Args:
        facet_search: Boolean indicating if facet search should be disabled.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_facet_search(True)
    """
    response = self._http_requests.put(
        f"{self._settings_url}/facet-search",
        facet_search,
        compress=compress,
    )

    return TaskInfo(**response.json())

update_faceting(faceting, *, compress=False)

Partially update the faceting settings for an index.

Parameters:

Name	Type	Description	Default
faceting	Faceting	Faceting values.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_faceting(faceting=Faceting(max_values_per_facet=100))

Source code in meilisearch_python_sdk/index.py

def update_faceting(self, faceting: Faceting, *, compress: bool = False) -> TaskInfo:
    """Partially update the faceting settings for an index.

    Args:
        faceting: Faceting values.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_faceting(faceting=Faceting(max_values_per_facet=100))
    """
    response = self._http_requests.patch(
        f"{self._settings_url}/faceting",
        faceting.model_dump(by_alias=True),
        compress=compress,
    )

    return TaskInfo(**response.json())

update_filterable_attributes(body, *, compress=False)

Update filterable attributes of the index.

Parameters:

Name	Type	Description	Default
body	list[str]	List containing the filterable attributes of the index.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_filterable_attributes(["genre", "director"])

Source code in meilisearch_python_sdk/index.py

def update_filterable_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
    """Update filterable attributes of the index.

    Args:
        body: List containing the filterable attributes of the index.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_filterable_attributes(["genre", "director"])
    """
    response = self._http_requests.put(
        f"{self._settings_url}/filterable-attributes", body, compress=compress
    )

    return TaskInfo(**response.json())

update_localized_attributes(localized_attributes, *, compress=False)

Update the localized attributes settings for an index.

Parameters:

Name	Type	Description	Default
localized_attributes	list[LocalizedAttributes]	The localized attributes value.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import AsyncClient >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes >>> >>> >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_localized_attributes([ >>> LocalizedAttributes(locales=["eng", "spa"], attribute_patterns=[""]), >>> LocalizedAttributes(locales=["ita"], attribute_patterns=["_it"]), >>> ])

Source code in meilisearch_python_sdk/index.py

def update_localized_attributes(
    self, localized_attributes: list[LocalizedAttributes], *, compress: bool = False
) -> TaskInfo:
    """Update the localized attributes settings for an index.

    Args:
        localized_attributes: The localized attributes value.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import AsyncClient
        >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
        >>>
        >>>
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_localized_attributes([
        >>>     LocalizedAttributes(locales=["eng", "spa"], attribute_patterns=["*"]),
        >>>     LocalizedAttributes(locales=["ita"], attribute_patterns=["*_it"]),
        >>> ])
    """
    payload = [x.model_dump(by_alias=True) for x in localized_attributes]
    response = self._http_requests.put(
        f"{self._settings_url}/localized-attributes", payload, compress=compress
    )

    return TaskInfo(**response.json())

update_non_separator_tokens(non_separator_tokens, *, compress=False)

Update the non-separator tokens settings for an index.

Parameters:

Name	Type	Description	Default
non_separator_tokens	list[str]	List of non-separator tokens.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_non_separator_tokens(non_separator_tokens=["@", "#")

Source code in meilisearch_python_sdk/index.py

def update_non_separator_tokens(
    self, non_separator_tokens: list[str], *, compress: bool = False
) -> TaskInfo:
    """Update the non-separator tokens settings for an index.

    Args:
        non_separator_tokens: List of non-separator tokens.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_non_separator_tokens(non_separator_tokens=["@", "#")
    """
    response = self._http_requests.put(
        f"{self._settings_url}/non-separator-tokens", non_separator_tokens, compress=compress
    )

    return TaskInfo(**response.json())

update_pagination(settings, *, compress=False)

Partially update the pagination settings for an index.

Parameters:

Name	Type	Description	Default
settings	Pagination	settings for pagination.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk.models.settings import Pagination >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_pagination(settings=Pagination(max_total_hits=123))

Source code in meilisearch_python_sdk/index.py

def update_pagination(self, settings: Pagination, *, compress: bool = False) -> TaskInfo:
    """Partially update the pagination settings for an index.

    Args:
        settings: settings for pagination.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> from meilisearch_python_sdk.models.settings import Pagination
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_pagination(settings=Pagination(max_total_hits=123))
    """
    response = self._http_requests.patch(
        f"{self._settings_url}/pagination",
        settings.model_dump(by_alias=True),
        compress=compress,
    )

    return TaskInfo(**response.json())

update_prefix_search(prefix_search, *, compress=False)

Update setting for prefix search opt-out.

Parameters:

Name	Type	Description	Default
prefix_search	Literal['disabled', 'indexingTime', 'searchTime']	Value indicating prefix search setting.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_prefix_search("disabled")

Source code in meilisearch_python_sdk/index.py

def update_prefix_search(
    self,
    prefix_search: Literal["disabled", "indexingTime", "searchTime"],
    *,
    compress: bool = False,
) -> TaskInfo:
    """Update setting for prefix search opt-out.

    Args:
        prefix_search: Value indicating prefix search setting.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_prefix_search("disabled")
    """
    response = self._http_requests.put(
        f"{self._settings_url}/prefix-search",
        prefix_search,
        compress=compress,
    )

    return TaskInfo(**response.json())

update_proximity_precision(proximity_precision, *, compress=False)

Update the proximity precision settings for an index.

Parameters:

Name	Type	Description	Default
proximity_precision	ProximityPrecision	The proximity precision value.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk.models.settings import ProximityPrecision >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_proximity_precision(ProximityPrecision.BY_ATTRIBUTE)

Source code in meilisearch_python_sdk/index.py

def update_proximity_precision(
    self, proximity_precision: ProximityPrecision, *, compress: bool = False
) -> TaskInfo:
    """Update the proximity precision settings for an index.

    Args:
        proximity_precision: The proximity precision value.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> from meilisearch_python_sdk.models.settings import ProximityPrecision
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_proximity_precision(ProximityPrecision.BY_ATTRIBUTE)
    """
    response = self._http_requests.put(
        f"{self._settings_url}/proximity-precision",
        proximity_precision.value,
        compress=compress,
    )

    return TaskInfo(**response.json())

update_ranking_rules(ranking_rules, *, compress=False)

Update ranking rules of the index.

Parameters:

Name	Type	Description	Default
ranking_rules	list[str]	List containing the ranking rules.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> ranking_rules=[ >>> "words", >>> "typo", >>> "proximity", >>> "attribute", >>> "sort", >>> "exactness", >>> "release_date:desc", >>> "rank:desc", >>> ], >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_ranking_rules(ranking_rules)

Source code in meilisearch_python_sdk/index.py

def update_ranking_rules(self, ranking_rules: list[str], *, compress: bool = False) -> TaskInfo:
    """Update ranking rules of the index.

    Args:
        ranking_rules: List containing the ranking rules.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> ranking_rules=[
        >>>      "words",
        >>>      "typo",
        >>>      "proximity",
        >>>      "attribute",
        >>>      "sort",
        >>>      "exactness",
        >>>      "release_date:desc",
        >>>      "rank:desc",
        >>> ],
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_ranking_rules(ranking_rules)
    """
    response = self._http_requests.put(
        f"{self._settings_url}/ranking-rules", ranking_rules, compress=compress
    )

    return TaskInfo(**response.json())

update_search_cutoff_ms(search_cutoff_ms, *, compress=False)

Update the search cutoff for an index.

Parameters:

Name	Type	Description	Default
search_cutoff_ms	int	Integer value of the search cutoff time in ms.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_search_cutoff_ms(100)

Source code in meilisearch_python_sdk/index.py

def update_search_cutoff_ms(self, search_cutoff_ms: int, *, compress: bool = False) -> TaskInfo:
    """Update the search cutoff for an index.

    Args:
        search_cutoff_ms: Integer value of the search cutoff time in ms.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_search_cutoff_ms(100)
    """
    response = self._http_requests.put(
        f"{self._settings_url}/search-cutoff-ms", search_cutoff_ms, compress=compress
    )

    return TaskInfo(**response.json())

update_searchable_attributes(body, *, compress=False)

Update searchable attributes of the index.

Parameters:

Name	Type	Description	Default
body	list[str]	List containing the searchable attributes.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_searchable_attributes(["title", "description", "genre"])

Source code in meilisearch_python_sdk/index.py

def update_searchable_attributes(self, body: list[str], *, compress: bool = False) -> TaskInfo:
    """Update searchable attributes of the index.

    Args:
        body: List containing the searchable attributes.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_searchable_attributes(["title", "description", "genre"])
    """
    response = self._http_requests.put(
        f"{self._settings_url}/searchable-attributes", body, compress=compress
    )

    return TaskInfo(**response.json())

update_separator_tokens(separator_tokens, *, compress=False)

Update the separator tokens settings for an index.

Parameters:

Name	Type	Description	Default
separator_tokens	list[str]	List of separator tokens.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_separator_tokens(separator_tokenes=["|", "/")

Source code in meilisearch_python_sdk/index.py

def update_separator_tokens(
    self, separator_tokens: list[str], *, compress: bool = False
) -> TaskInfo:
    """Update the separator tokens settings for an index.

    Args:
        separator_tokens: List of separator tokens.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_separator_tokens(separator_tokenes=["|", "/")
    """
    response = self._http_requests.put(
        f"{self._settings_url}/separator-tokens", separator_tokens, compress=compress
    )

    return TaskInfo(**response.json())

update_settings(body, *, compress=False)

Update settings of the index.

Parameters:

Name	Type	Description	Default
body	MeilisearchSettings	Settings of the index.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> from meilisearch_python_sdk import MeilisearchSettings >>> new_settings = MeilisearchSettings( >>> synonyms={"wolverine": ["xmen", "logan"], "logan": ["wolverine"]}, >>> stop_words=["the", "a", "an"], >>> ranking_rules=[ >>> "words", >>> "typo", >>> "proximity", >>> "attribute", >>> "sort", >>> "exactness", >>> "release_date:desc", >>> "rank:desc", >>> ], >>> filterable_attributes=["genre", "director"], >>> distinct_attribute="url", >>> searchable_attributes=["title", "description", "genre"], >>> displayed_attributes=["title", "description", "genre", "release_date"], >>> sortable_attributes=["title", "release_date"], >>> ) >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_settings(new_settings)

Source code in meilisearch_python_sdk/index.py

def update_settings(self, body: MeilisearchSettings, *, compress: bool = False) -> TaskInfo:
    """Update settings of the index.

    Args:
        body: Settings of the index.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> from meilisearch_python_sdk import MeilisearchSettings
        >>> new_settings = MeilisearchSettings(
        >>>     synonyms={"wolverine": ["xmen", "logan"], "logan": ["wolverine"]},
        >>>     stop_words=["the", "a", "an"],
        >>>     ranking_rules=[
        >>>         "words",
        >>>         "typo",
        >>>         "proximity",
        >>>         "attribute",
        >>>         "sort",
        >>>         "exactness",
        >>>         "release_date:desc",
        >>>         "rank:desc",
        >>>    ],
        >>>    filterable_attributes=["genre", "director"],
        >>>    distinct_attribute="url",
        >>>    searchable_attributes=["title", "description", "genre"],
        >>>    displayed_attributes=["title", "description", "genre", "release_date"],
        >>>    sortable_attributes=["title", "release_date"],
        >>> )
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_settings(new_settings)
    """
    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())

update_sortable_attributes(sortable_attributes, *, compress=False)

Get sortable attributes of the AsyncIndex.

Parameters:

Name	Type	Description	Default
sortable_attributes	list[str]	List of attributes for searching.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_sortable_attributes(["title", "release_date"])

Source code in meilisearch_python_sdk/index.py

def update_sortable_attributes(
    self, sortable_attributes: list[str], *, compress: bool = False
) -> TaskInfo:
    """Get sortable attributes of the AsyncIndex.

    Args:
        sortable_attributes: List of attributes for searching.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_sortable_attributes(["title", "release_date"])
    """
    response = self._http_requests.put(
        f"{self._settings_url}/sortable-attributes", sortable_attributes, compress=compress
    )

    return TaskInfo(**response.json())

update_stop_words(body, *, compress=False)

Update stop words of the index.

Parameters:

Name	Type	Description	Default
body	list[str]	List containing the stop words of the index.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_stop_words(["the", "a", "an"])

Source code in meilisearch_python_sdk/index.py

def update_stop_words(self, body: list[str], *, compress: bool = False) -> TaskInfo:
    """Update stop words of the index.

    Args:
        body: List containing the stop words of the index.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_stop_words(["the", "a", "an"])
    """
    response = self._http_requests.put(
        f"{self._settings_url}/stop-words", body, compress=compress
    )

    return TaskInfo(**response.json())

update_synonyms(body, *, compress=False)

Update synonyms of the index.

Parameters:

Name	Type	Description	Default
body	dict[str, list[str]]	The synonyms of the index.	required

Returns:

Type	Description
TaskInfo	The details of the task status.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") as client: >>> index = client.index("movies") >>> index.update_synonyms( >>> {"wolverine": ["xmen", "logan"], "logan": ["wolverine"]} >>> )

Source code in meilisearch_python_sdk/index.py

def update_synonyms(self, body: dict[str, list[str]], *, compress: bool = False) -> TaskInfo:
    """Update synonyms of the index.

    Args:
        body: The synonyms of the index.

    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_python_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey") as client:
        >>> index = client.index("movies")
        >>> index.update_synonyms(
        >>>     {"wolverine": ["xmen", "logan"], "logan": ["wolverine"]}
        >>> )
    """
    response = self._http_requests.put(
        f"{self._settings_url}/synonyms", body, compress=compress
    )

    return TaskInfo(**response.json())

update_typo_tolerance(typo_tolerance, *, compress=False)

Update typo tolerance.

Parameters:

Name	Type	Description	Default
typo_tolerance	TypoTolerance	Typo tolerance settings.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> TypoTolerance(enabled=False) >>> index.update_typo_tolerance()

Source code in meilisearch_python_sdk/index.py

def update_typo_tolerance(
    self, typo_tolerance: TypoTolerance, *, compress: bool = False
) -> TaskInfo:
    """Update typo tolerance.

    Args:
        typo_tolerance: Typo tolerance settings.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> TypoTolerance(enabled=False)
        >>> index.update_typo_tolerance()
    """
    response = self._http_requests.patch(
        f"{self._settings_url}/typo-tolerance",
        typo_tolerance.model_dump(by_alias=True),
        compress=compress,
    )

    return TaskInfo(**response.json())

update_word_dictionary(dictionary, *, compress=False)

Update the word dictionary settings for an index.

Parameters:

Name	Type	Description	Default
dictionary	list[str]	List of dictionary values.	required
compress	bool	If set to True the data will be sent in gzip format. Defaults to False.	False

Returns:

Type	Description
TaskInfo	Task to track the action.

Raises:

Type	Description
MeilisearchCommunicationError	If there was an error communicating with the server.
MeilisearchApiError	If the Meilisearch API returned an error.

Examples >>> from meilisearch_python_sdk import Client >>> client = Client("http://localhost.com", "masterKey") >>> index = client.index("movies") >>> index.update_word_dictionary(dictionary=["S.O.S", "S.O")

Source code in meilisearch_python_sdk/index.py

def update_word_dictionary(self, dictionary: list[str], *, compress: bool = False) -> TaskInfo:
    """Update the word dictionary settings for an index.

    Args:
        dictionary: List of dictionary values.
        compress: If set to True the data will be sent in gzip format. Defaults to False.

    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_sdk import Client
        >>> client = Client("http://localhost.com", "masterKey")
        >>> index = client.index("movies")
        >>> index.update_word_dictionary(dictionary=["S.O.S", "S.O")
    """
    response = self._http_requests.put(
        f"{self._settings_url}/dictionary", dictionary, compress=compress
    )

    return TaskInfo(**response.json())