meilisearch-python-sdk 6.0.0__tar.gz → 7.0.0__tar.gz

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/.github/workflows/testing.yml

@@ -53,8 +53,9 @@ jobs:
         run: just test-parallel-ci
       - name: Upload coverage
         uses: codecov/codecov-action@v5.5.2
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
 
   parallel-testing-http2:
@@ -93,8 +94,9 @@ jobs:
         run: just test-parallel-ci-http2
       - name: Upload coverage
         uses: codecov/codecov-action@v5.5.2
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
 
   no-parallel-testing:
@@ -122,8 +124,9 @@ jobs:
         run: just test-no-parallel-ci
       - name: Upload coverage
         uses: codecov/codecov-action@v5.5.2
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
 
   no-parallel-testing-http2:
@@ -162,8 +165,9 @@ jobs:
         run: just test-no-parallel-ci-http2
       - name: Upload coverage
         uses: codecov/codecov-action@v5.5.2
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
   example-testing:
     strategy:

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.11
+    rev: v0.14.14
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 6.0.0
+Version: 7.0.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/_client.py

@@ -814,6 +814,9 @@ class AsyncClient(BaseClient):
             if query.media is None:
                 del q["media"]
 
+            if query.show_performance_details is None:
+                del q["showPerformanceDetails"]
+
             processed_queries.append(q)
 
         if federation:
@@ -1970,6 +1973,12 @@ class Client(BaseClient):
                 del q["limit"]
                 del q["offset"]
 
+            if query.media is None:
+                del q["media"]
+
+            if query.show_performance_details is None:
+                del q["showPerformanceDetails"]
+
             processed_queries.append(q)
 
         if federation:

meilisearch_python_sdk-7.0.0/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "7.0.0"

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/index/_common.py

@@ -140,6 +140,7 @@ def process_search_parameters(
     retrieve_vectors: bool | None = None,
     exhaustive_facet_count: bool | None = None,
     media: JsonMapping | None = None,
+    show_performance_details: bool = False,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -197,6 +198,9 @@ def process_search_parameters(
     if media is not None:
         body["media"] = media
 
+    if show_performance_details:
+        body["showPerformanceDetails"] = True
+
     return body
 
 

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/index/async_index.py

@@ -31,7 +31,7 @@ from meilisearch_python_sdk.index._common import (
 from meilisearch_python_sdk.index._common import combine_documents as combine_documents_
 from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 from meilisearch_python_sdk.models.documents import DocumentsInfo
-from meilisearch_python_sdk.models.index import IndexStats
+from meilisearch_python_sdk.models.index import Field, FieldResults, FieldsFilter, IndexStats
 from meilisearch_python_sdk.models.search import (
     FacetSearchResults,
     Hybrid,
@@ -712,6 +712,7 @@ class AsyncIndex(BaseIndex):
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
         media: JsonMapping | None = None,
+        show_performance_details: bool = False,
     ) -> SearchResults:
         """Search the index.
 
@@ -780,6 +781,8 @@ class AsyncIndex(BaseIndex):
                 to /experimental-features with { "multimodal": 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.
+            show_performance_details: When set to true, the search response contains a performance
+                trace. Default False.
 
         Returns:
             Results of the search
@@ -825,6 +828,7 @@ class AsyncIndex(BaseIndex):
             locales=locales,
             retrieve_vectors=retrieve_vectors,
             media=media,
+            show_performance_details=show_performance_details,
         )
         search_url = f"{self._base_url_with_uid}/search"
 
@@ -4815,6 +4819,46 @@ class AsyncIndex(BaseIndex):
 
         return TaskInfo(**self._http_requests.parse_json(response))
 
+    async def fields(
+        self, offset: int = 0, limit: int = 20, filter: FieldsFilter | None = None
+    ) -> FieldResults:
+        """Get the field properties on an index.
+
+        Args:
+            offset: Number of fields to skip. Defaults to 0.
+            limit: Maximum number of fields returned. Defaults to 20.
+            filter: Filter fields to return based on properties. Defaults to None.
+
+        Returns:
+            Field properties
+
+        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
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     docs = [{"id": 1, "title": "Some Title}]
+            >>>     index = await client.index("movies")
+            >>>     await index.add_documents(docs)
+            >>>     fields = await index.fields()
+        """
+        filter_value = filter.model_dump(by_alias=True) if filter else None
+        response = await self._http_requests.post(
+            f"{self._base_url_with_uid}/fields",
+            body={"offset": offset, "limit": limit, "filter": filter_value},
+        )
+        response_json = response.json()
+        fields = [Field(**field) for field in response_json["results"]]
+
+        return FieldResults(
+            fields=fields,
+            offset=response_json["offset"],
+            limit=response_json["limit"],
+            total=response_json["total"],
+        )
+
     @staticmethod
     async def _run_plugins(
         plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin | AsyncPostSearchPlugin],

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/index/index.py

@@ -28,7 +28,7 @@ from meilisearch_python_sdk.index._common import (
 from meilisearch_python_sdk.index._common import combine_documents as combine_documents_
 from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 from meilisearch_python_sdk.models.documents import DocumentsInfo
-from meilisearch_python_sdk.models.index import IndexStats
+from meilisearch_python_sdk.models.index import Field, FieldResults, FieldsFilter, IndexStats
 from meilisearch_python_sdk.models.search import (
     FacetSearchResults,
     Hybrid,
@@ -586,6 +586,7 @@ class Index(BaseIndex):
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
         media: JsonMapping | None = None,
+        show_performance_details: bool = False,
     ) -> SearchResults:
         """Search the index.
 
@@ -654,6 +655,8 @@ class Index(BaseIndex):
                 to /experimental-features with { "multimodal": 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.
+            show_performance_details: When set to true, the search response contains a performance
+                trace. Default False.
 
         Returns:
             Results of the search
@@ -699,6 +702,7 @@ class Index(BaseIndex):
             locales=locales,
             retrieve_vectors=retrieve_vectors,
             media=media,
+            show_performance_details=show_performance_details,
         )
 
         if self._pre_search_plugins:
@@ -3810,6 +3814,46 @@ class Index(BaseIndex):
 
         return TaskInfo(**self._http_requests.parse_json(response))
 
+    def fields(
+        self, offset: int = 0, limit: int = 20, filter: FieldsFilter | None = None
+    ) -> FieldResults:
+        """Get the field properties on an index.
+
+        Args:
+            offset: Number of fields to skip. Defaults to 0.
+            limit: Maximum number of fields returned. Defaults to 20.
+            filter: Filter fields to return based on properties. Defaults to None.
+
+        Returns:
+            Field properties
+
+        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
+            >>> with Client("http://localhost.com", "masterKey") as client:
+            >>>     docs = [{"id": 1, "title": "Some Title}]
+            >>>     index = client.index("movies")
+            >>>     index.add_documents(docs)
+            >>>     fields = index.fields()
+        """
+        filter_value = filter.model_dump(by_alias=True) if filter else None
+        response = self._http_requests.post(
+            f"{self._base_url_with_uid}/fields",
+            body={"offset": offset, "limit": limit, "filter": filter_value},
+        )
+        response_json = response.json()
+        fields = [Field(**field) for field in response_json["results"]]
+
+        return FieldResults(
+            fields=fields,
+            offset=response_json["offset"],
+            limit=response_json["limit"],
+            total=response_json["total"],
+        )
+
     @staticmethod
     def _run_plugins(
         plugins: Sequence[Plugin | DocumentPlugin | PostSearchPlugin],

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/models/index.py

@@ -44,3 +44,62 @@ class IndexStats(CamelBase):
     number_of_embeddings: int | None = None
     is_indexing: bool
     field_distribution: dict[str, int]
+
+
+class FieldsFilter(CamelBase):
+    attribute_patterns: str | None = None
+    displayed: bool | None = None
+    sortable: bool | None = None
+    searchable: bool | None = None
+    ranking_rule: bool | None = None
+    filterable: bool | None = None
+
+
+class FieldDisplayConfig(CamelBase):
+    enabled: bool
+
+
+class FieldSearchConfig(CamelBase):
+    enabled: bool
+
+
+class FieldSortableConfig(CamelBase):
+    enabled: bool
+
+
+class FieldRankingRuleConfig(CamelBase):
+    order: str | None = None
+
+
+class FieldDistinctConfig(CamelBase):
+    enabled: bool
+
+
+class FieldFilterableConfig(CamelBase):
+    enabled: bool
+    sort_by: str
+    facet_search: bool
+    equality: bool
+    comparison: bool
+
+
+class FieldLocalizedConfig(CamelBase):
+    locales: list[str]
+
+
+class Field(CamelBase):
+    name: str
+    displayed: FieldDisplayConfig
+    searchable: FieldSearchConfig
+    sortable: FieldSortableConfig
+    distinct: FieldDistinctConfig
+    ranking_rule: FieldRankingRuleConfig
+    filterable: FieldFilterableConfig
+    localized: FieldLocalizedConfig
+
+
+class FieldResults(CamelBase):
+    fields: list[Field]
+    offset: int
+    limit: int
+    total: int

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/meilisearch_python_sdk/models/search.py

@@ -72,6 +72,7 @@ class SearchParams(CamelBase):
     locales: list[str] | None = None
     retrieve_vectors: bool | None = None
     media: JsonMapping | None = None
+    show_performance_details: bool | None = None
 
     @field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
     @classmethod
@@ -96,6 +97,7 @@ class SearchResults(CamelBase, Generic[T]):
     hits_per_page: int | None = None
     semantic_hit_count: int | None = None
     query_vector: list[float] | None = None
+    performance_details: JsonDict | None = None
 
 
 class SearchResultsWithUID(SearchResults, Generic[T]):

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/pyproject.toml

@@ -39,14 +39,14 @@ all = ["orjson"]
 dev = [
   "mkdocs==1.6.1",
   "mkdocs-material==9.7.1",
-  "mkdocstrings[python]==1.0.0",
-  "mypy[fastercache]>=1.19.1",
+  "mkdocstrings[python]==1.0.2",
+  "mypy[faster-cache]>=1.19.1",
   "pytest==9.0.2",
   "pytest-cov==7.0.0",
   "pytest-asyncio==1.3.0",
   "pytest-xdist==3.8.0",
   "prek>=0.2.27",
-  "ruff==0.14.13",
+  "ruff==0.14.14",
   "types-aiofiles==25.1.0.20251011",
   "typing-extensions==4.15.0",
 ]

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/tests/test_async_index.py

@@ -4,6 +4,7 @@ from httpx import Response
 from meilisearch_python_sdk._http_requests import AsyncHttpRequests
 from meilisearch_python_sdk._task import async_wait_for_task
 from meilisearch_python_sdk.errors import MeilisearchApiError
+from meilisearch_python_sdk.models.index import FieldsFilter
 from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
@@ -1031,3 +1032,26 @@ async def test_compact(async_client, async_index_with_documents):
     result = await async_client.get_task(task_id=task.task_uid)
 
     assert result.status == "succeeded"
+
+
+async def test_fields(async_index_with_documents):
+    index = await async_index_with_documents()
+    result = await index.fields()
+    assert "genre" in [field.name for field in result.fields]
+
+
+async def test_fields_with_limit_and_offset(async_index_with_documents):
+    index = await async_index_with_documents()
+    result = await index.fields(limit=2, offset=2)
+    assert len(result.fields) == 2
+    assert "overview" in [field.name for field in result.fields]
+
+
+async def test_fields_with_filter(async_client, async_index_with_documents):
+    filter = FieldsFilter(sortable=True)
+    index = await async_index_with_documents()
+    task = await index.update_sortable_attributes(["title"])
+    await async_client.wait_for_task(task.task_uid)
+    result = await index.fields(filter=filter)
+    assert len(result.fields) == 1
+    assert "title" in result.fields[0].name

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/tests/test_async_search.py

@@ -632,6 +632,24 @@ async def test_multi_search_ranking_score_threshold(async_client, async_index_wi
     assert len(result[0].hits) > 0
 
 
+async def test_multi_search_show_performance_details(async_client, async_index_with_documents):
+    index1 = await async_index_with_documents()
+    index2 = await async_index_with_documents()
+    response = await async_client.multi_search(
+        [
+            SearchParams(
+                index_uid=index1.uid,
+                query="How to Train Your Dragon",
+                show_performance_details=True,
+            ),
+            SearchParams(index_uid=index2.uid, query=""),
+        ],
+    )
+
+    assert response[0].performance_details is not None
+    assert response[1].performance_details is None
+
+
 async def test_facet_search_ranking_score_threshold(async_index_with_documents_and_vectors):
     index = await async_index_with_documents_and_vectors()
     update = await index.update_filterable_attributes(["genre"])
@@ -703,3 +721,9 @@ async def test_search_show_matches_position(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.search("with", show_matches_position=True)
     assert "_matchesPosition" in response.hits[0]
+
+
+async def test_search_show_performance_parameters(async_index_with_documents):
+    index = await async_index_with_documents()
+    response = await index.search(show_performance_details=True)
+    assert response.performance_details is not None

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/tests/test_index.py

@@ -5,6 +5,7 @@ from meilisearch_python_sdk._http_requests import HttpRequests
 from meilisearch_python_sdk._task import wait_for_task
 from meilisearch_python_sdk.errors import MeilisearchApiError
 from meilisearch_python_sdk.index._common import process_search_parameters
+from meilisearch_python_sdk.models.index import FieldsFilter
 from meilisearch_python_sdk.models.settings import (
     Embedders,
     Faceting,
@@ -1032,3 +1033,26 @@ def test_compact(client, index_with_documents):
     result = client.get_task(task_id=task.task_uid)
 
     assert result.status == "succeeded"
+
+
+def test_fields(index_with_documents):
+    index = index_with_documents()
+    result = index.fields()
+    assert "genre" in [field.name for field in result.fields]
+
+
+def test_fields_with_limit_and_offset(index_with_documents):
+    index = index_with_documents()
+    result = index.fields(limit=2, offset=2)
+    assert len(result.fields) == 2
+    assert "overview" in [field.name for field in result.fields]
+
+
+def test_fields_with_filter(client, index_with_documents):
+    filter = FieldsFilter(sortable=True)
+    index = index_with_documents()
+    task = index.update_sortable_attributes(["title"])
+    client.wait_for_task(task.task_uid)
+    result = index.fields(filter=filter)
+    assert len(result.fields) == 1
+    assert "title" in result.fields[0].name

{meilisearch_python_sdk-6.0.0 → meilisearch_python_sdk-7.0.0}/tests/test_search.py

@@ -612,6 +612,24 @@ def test_multi_search_ranking_score_threshold(client, index_with_documents):
     assert len(result[0].hits) > 0
 
 
+def test_multi_search_show_performance_details(client, index_with_documents):
+    index1 = index_with_documents()
+    index2 = index_with_documents()
+    response = client.multi_search(
+        [
+            SearchParams(
+                index_uid=index1.uid,
+                query="How to Train Your Dragon",
+                show_performance_details=True,
+            ),
+            SearchParams(index_uid=index2.uid, query=""),
+        ],
+    )
+
+    assert response[0].performance_details is not None
+    assert response[1].performance_details is None
+
+
 def test_facet_search_ranking_score_threshold(index_with_documents_and_vectors):
     index = index_with_documents_and_vectors()
     update = index.update_filterable_attributes(["genre"])
@@ -683,3 +701,9 @@ def test_search_show_matches_position(index_with_documents):
     index = index_with_documents()
     response = index.search("with", show_matches_position=True)
     assert "_matchesPosition" in response.hits[0]
+
+
+async def test_search_show_performance_parameters(async_index_with_documents):
+    index = await async_index_with_documents()
+    response = await index.search(show_performance_details=True)
+    assert response.performance_details is not None