meilisearch-python-sdk 7.2.2__tar.gz → 7.3.0__tar.gz

meilisearch_python_sdk-7.3.0/.github/release-draft-template.yaml

@@ -0,0 +1,24 @@
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+categories:
+  - type: "pre-exclude"
+    when:
+      labels:
+        - "dependencies"
+        - "skip-changelog"
+  - title: "⚠️ Breaking changes"
+    semver-increment: "major"
+    when:
+      label: "breaking-change"
+  - title: "Features"
+    semver-increment: "minor"
+    when:
+      label: "enhancement"
+  - title: "Bug Fixes"
+    when:
+      label: "bug"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+template: |
+  ## Changes
+
+  $CHANGES

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/.github/workflows/docs_publish.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     environment: github-pages
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/.github/workflows/nightly_testing.yml

@@ -12,9 +12,9 @@ jobs:
       fail-fast: false
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: install Just

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/.github/workflows/pypi_publish.yml

@@ -12,9 +12,9 @@ jobs:
       # For PyPI's trusted publishing.
       id-token: write
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/.github/workflows/testing.yml

@@ -11,11 +11,11 @@ jobs:
   linting:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python
@@ -35,11 +35,11 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15-dev"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -65,11 +65,11 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15-dev"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -106,11 +106,11 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15-dev"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -136,11 +136,11 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15-dev"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -176,7 +176,7 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15-dev"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python ${{ matrix.python-version }}
@@ -191,11 +191,11 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.2.0
+        uses: astral-sh/setup-uv@v8.3.2
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/facebook/pyrefly-pre-commit
-    rev: 1.1.0
+    rev: 1.1.1
     hooks:
       - id: pyrefly-check
         name: pyrefly
@@ -20,11 +20,11 @@ repos:
         language: system
         entry: uv run pyrefly check
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.17
+    rev: v0.15.21
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/rvben/rumdl-pre-commit
-    rev: v0.2.18
+    rev: v0.2.32
     hooks:
       - id: rumdl-fmt

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 7.2.2
+Version: 7.3.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-7.2.2 → meilisearch_python_sdk-7.3.0}/docker-compose.https.yml

@@ -1,6 +1,6 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:v1.47.0
+    image: getmeili/meilisearch:v1.49.0
     ports:
       - "7700:7700"
     environment:

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   meilisearch:
-    image: getmeili/meilisearch:v1.47.0
+    image: getmeili/meilisearch:v1.49.0
     ports:
       - "7700:7700"
     environment:

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/_client/_common.py

@@ -41,6 +41,9 @@ def build_multi_search_payload(
         if query.show_performance_details is None:
             del q["showPerformanceDetails"]
 
+        if query.personalize is None:
+            del q["personalize"]
+
         processed_queries.append(q)
 
     if federation:

meilisearch_python_sdk-7.3.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/errors.py

@@ -1,3 +1,5 @@
+import json
+
 from httpx2 import Response
 
 
@@ -35,8 +37,13 @@ class MeilisearchApiError(MeilisearchError):
         self.message = ""
         self.link = ""
         self.error_type = ""
+        error_json = None
         if response.content:
-            error_json = response.json()
+            try:
+                error_json = response.json()
+            except json.JSONDecodeError:
+                error_json = None
+        if isinstance(error_json, dict):
             self.message = f"Error message: {error_json.get('message') or ''}"
             self.code = f"{error_json.get('code') or ''}"
             self.error_type = f"{error_json.get('type') or ''}"

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/index/_common.py

@@ -11,7 +11,7 @@ from pydantic import TypeAdapter
 
 from meilisearch_python_sdk.errors import MeilisearchError
 from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
-from meilisearch_python_sdk.models.search import Hybrid
+from meilisearch_python_sdk.models.search import Hybrid, Personalize
 from meilisearch_python_sdk.models.settings import (
     CompositeEmbedder,
     Embedders,
@@ -153,6 +153,7 @@ def process_search_parameters(
     exhaustive_facet_count: bool | None = None,
     media: JsonMapping | None = None,
     show_performance_details: bool = False,
+    personalize: Personalize | None = None,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -213,6 +214,11 @@ def process_search_parameters(
     if show_performance_details:
         body["showPerformanceDetails"] = True
 
+    # no cover becuse personlized search requires an api key and any mocked test here would be
+    # pointless
+    if personalize is not None:  # pragma: no cover
+        body["personalize"] = personalize.model_dump(by_alias=True)
+
     return body
 
 

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/index/async_index.py

@@ -36,6 +36,7 @@ from meilisearch_python_sdk.models.index import Field, FieldResults, FieldsFilte
 from meilisearch_python_sdk.models.search import (
     FacetSearchResults,
     Hybrid,
+    Personalize,
     SearchResults,
     SimilarSearchResults,
 )
@@ -44,6 +45,7 @@ from meilisearch_python_sdk.models.settings import (
     Faceting,
     FilterableAttributeFeatures,
     FilterableAttributes,
+    ForeignKey,
     LocalizedAttributes,
     MeilisearchSettings,
     Pagination,
@@ -593,6 +595,7 @@ class AsyncIndex(BaseIndex):
         retrieve_vectors: bool | None = None,
         media: JsonMapping | None = None,
         show_performance_details: bool = False,
+        personalize: Personalize | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -663,6 +666,7 @@ class AsyncIndex(BaseIndex):
                 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.
+            personalize: Personalize the search results.
 
         Returns:
             Results of the search
@@ -709,6 +713,7 @@ class AsyncIndex(BaseIndex):
             retrieve_vectors=retrieve_vectors,
             media=media,
             show_performance_details=show_performance_details,
+            personalize=personalize,
         )
         search_url = f"{self._base_url_with_uid}/search"
 
@@ -739,6 +744,7 @@ class AsyncIndex(BaseIndex):
                 show_ranking_score_details=show_ranking_score_details,
                 vector=vector,
                 hybrid=hybrid,
+                personalize=personalize,
             )
 
         if self._concurrent_search_plugins:
@@ -771,6 +777,7 @@ class AsyncIndex(BaseIndex):
                                 show_ranking_score=show_ranking_score,
                                 show_ranking_score_details=show_ranking_score_details,
                                 vector=vector,
+                                personalize=personalize,
                             )
                         )
 
@@ -815,6 +822,7 @@ class AsyncIndex(BaseIndex):
                                 show_ranking_score=show_ranking_score,
                                 show_ranking_score_details=show_ranking_score_details,
                                 vector=vector,
+                                personalize=personalize,
                             )
                         )
 
@@ -872,6 +880,7 @@ class AsyncIndex(BaseIndex):
         vector: list[float] | None = None,
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
+        personalize: Personalize | None = None,
         exhaustive_facet_count: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
@@ -926,6 +935,7 @@ class AsyncIndex(BaseIndex):
             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.
             retrieve_vectors: Return document vector data with search result.
+            personalize: Personalize the search results.
             exhaustive_facet_count: forcing the facet search to compute the facet counts the same
                 way as the paginated search. This parameter can only be used with Milisearch >=
                 v1.14.0. Defaults to None.
@@ -977,6 +987,7 @@ class AsyncIndex(BaseIndex):
             vector=vector,
             locales=locales,
             retrieve_vectors=retrieve_vectors,
+            personalize=personalize,
             exhaustive_facet_count=exhaustive_facet_count,
         )
         search_url = f"{self._base_url_with_uid}/facet-search"
@@ -1008,6 +1019,7 @@ class AsyncIndex(BaseIndex):
                 ranking_score_threshold=ranking_score_threshold,
                 vector=vector,
                 exhaustive_facet_count=exhaustive_facet_count,
+                personalize=personalize,
             )
 
         if self._concurrent_facet_search_plugins:
@@ -1041,6 +1053,7 @@ class AsyncIndex(BaseIndex):
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
                                 exhaustive_facet_count=exhaustive_facet_count,
+                                personalize=personalize,
                             )
                         )
 
@@ -1085,6 +1098,7 @@ class AsyncIndex(BaseIndex):
                                 ranking_score_threshold=ranking_score_threshold,
                                 vector=vector,
                                 exhaustive_facet_count=exhaustive_facet_count,
+                                personalize=personalize,
                             )
                         )
 
@@ -4665,6 +4679,81 @@ class AsyncIndex(BaseIndex):
 
         return TaskInfo(**self._http_requests.parse_json(response))
 
+    async def get_foreign_keys(self) -> list[ForeignKey]:
+        """Get foreign keys for the index.
+
+        Returns:
+            A list of the foreign keys
+
+        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:
+            >>>     index = await client.index("movies")
+            >>>     foreign_keys = await index.get_foreign_keys()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/foreign-keys")
+        foreign_keys = self._http_requests.parse_json(response)
+
+        return [ForeignKey(**foreign_key) for foreign_key in foreign_keys]
+
+    async def update_foreign_keys(
+        self,
+        foreign_keys: Sequence[ForeignKey],
+        *,
+        compress: bool = False,
+    ) -> TaskInfo:
+        """Update setting for foreign key.
+
+        Args:
+            foreign_keys: List of foreign keys.
+            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 AsyncClient
+            >>> from meilisearch_python_sdk.models.settings import ForeignKey
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.update_foreign_keys([ForeignKey(foreign_index_uid="title", field_name="title")])
+        """
+        response = await self._http_requests.put(
+            f"{self._settings_url}/foreign-keys",
+            [foreign_key.model_dump(by_alias=True) for foreign_key in foreign_keys],
+            compress=compress,
+        )
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
+    async def reset_foreign_keys(self) -> TaskInfo:
+        """Reset the foreign keys setting.
+
+        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
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.reset_foreign_keys()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/foreign-keys")
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
     async def fields(
         self, offset: int = 0, limit: int = 20, filter: FieldsFilter | None = None
     ) -> FieldResults:

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/index/index.py

@@ -33,6 +33,7 @@ from meilisearch_python_sdk.models.index import Field, FieldResults, FieldsFilte
 from meilisearch_python_sdk.models.search import (
     FacetSearchResults,
     Hybrid,
+    Personalize,
     SearchResults,
     SimilarSearchResults,
 )
@@ -41,6 +42,7 @@ from meilisearch_python_sdk.models.settings import (
     Faceting,
     FilterableAttributeFeatures,
     FilterableAttributes,
+    ForeignKey,
     LocalizedAttributes,
     MeilisearchSettings,
     Pagination,
@@ -531,6 +533,7 @@ class Index(BaseIndex):
         retrieve_vectors: bool | None = None,
         media: JsonMapping | None = None,
         show_performance_details: bool = False,
+        personalize: Personalize | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -601,6 +604,7 @@ class Index(BaseIndex):
                 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.
+            personalize: Personalize the search results.
 
         Returns:
             Results of the search
@@ -647,6 +651,7 @@ class Index(BaseIndex):
             retrieve_vectors=retrieve_vectors,
             media=media,
             show_performance_details=show_performance_details,
+            personalize=personalize,
         )
 
         if self._pre_search_plugins:
@@ -676,6 +681,7 @@ class Index(BaseIndex):
                 show_ranking_score_details=show_ranking_score_details,
                 vector=vector,
                 hybrid=hybrid,
+                personalize=personalize,
             )
 
         response = self._http_requests.post(f"{self._base_url_with_uid}/search", body=body)
@@ -716,6 +722,7 @@ class Index(BaseIndex):
         vector: list[float] | None = None,
         locales: list[str] | None = None,
         retrieve_vectors: bool | None = None,
+        personalize: Personalize | None = None,
         exhaustive_facet_count: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
@@ -773,6 +780,7 @@ class Index(BaseIndex):
             exhaustive_facet_count: forcing the facet search to compute the facet counts the same
                 way as the paginated search. This parameter can only be used with Milisearch >=
                 v1.14.0. Defaults to None.
+            personalize: Personalize the search results.
 
         Returns:
             Results of the search
@@ -821,6 +829,7 @@ class Index(BaseIndex):
             vector=vector,
             locales=locales,
             retrieve_vectors=retrieve_vectors,
+            personalize=personalize,
             exhaustive_facet_count=exhaustive_facet_count,
         )
 
@@ -850,6 +859,7 @@ class Index(BaseIndex):
                 show_ranking_score_details=show_ranking_score_details,
                 ranking_score_threshold=ranking_score_threshold,
                 vector=vector,
+                personalize=personalize,
                 exhaustive_facet_count=exhaustive_facet_count,
             )
 
@@ -3716,6 +3726,80 @@ class Index(BaseIndex):
 
         return TaskInfo(**self._http_requests.parse_json(response))
 
+    def get_foreign_keys(self) -> list[ForeignKey]:
+        """Get foreign keys for the index.
+
+        Returns:
+            A list of the foreign keys
+
+        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
+            >>> with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     foreign_keys = index.get_foreign_keys()
+        """
+        response = self._http_requests.get(f"{self._settings_url}/foreign-keys")
+        foreign_keys = self._http_requests.parse_json(response)
+
+        return [ForeignKey(**foreign_key) for foreign_key in foreign_keys]
+
+    def update_foreign_keys(
+        self,
+        foreign_keys: Sequence[ForeignKey],
+        *,
+        compress: bool = False,
+    ) -> TaskInfo:
+        """Update setting for foreign key.
+
+        Args:
+            foreign_keys: List of foreign keys.
+            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 AsyncClient
+            >>> with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     index.update_foreign_keys([ForeignKey(foreign_index_uid="title", field_name="title")])
+        """
+        response = self._http_requests.put(
+            f"{self._settings_url}/foreign-keys",
+            [foreign_key.model_dump(by_alias=True) for foreign_key in foreign_keys],
+            compress=compress,
+        )
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
+    def reset_foreign_keys(self) -> TaskInfo:
+        """Reset the foreign keys setting.
+
+        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
+            >>> with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     index.reset_foreign_keys()
+        """
+        response = self._http_requests.delete(f"{self._settings_url}/foreign-keys")
+
+        return TaskInfo(**self._http_requests.parse_json(response))
+
     def fields(
         self, offset: int = 0, limit: int = 20, filter: FieldsFilter | None = None
     ) -> FieldResults:

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/models/search.py

@@ -46,6 +46,10 @@ class FederationOptions(CamelBase):
     weight: float
 
 
+class Personalize(CamelBase):
+    user_context: str
+
+
 class SearchParams(CamelBase):
     index_uid: str
     query: str | None = Field(None, alias="q")
@@ -76,6 +80,7 @@ class SearchParams(CamelBase):
     retrieve_vectors: bool | None = None
     media: JsonMapping | None = None
     show_performance_details: bool | None = None
+    personalize: Personalize | None = None
 
     @field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
     @classmethod

{meilisearch_python_sdk-7.2.2 → meilisearch_python_sdk-7.3.0}/meilisearch_python_sdk/models/settings.py

@@ -163,6 +163,11 @@ class FilterableAttributes(CamelBase):
     features: FilterableAttributeFeatures
 
 
+class ForeignKey(CamelBase):
+    foreign_index_uid: str
+    field_name: str
+
+
 class MeilisearchSettings(CamelBase):
     synonyms: JsonDict | None = None
     stop_words: list[str] | None = None
@@ -195,3 +200,4 @@ class MeilisearchSettings(CamelBase):
     localized_attributes: list[LocalizedAttributes] | None = None
     facet_search: bool | None = None
     prefix_search: Literal["disabled", "indexingTime", "searchTime"] | None = None
+    foreign_keys: list[ForeignKey] | None = None