feat: Adding support Multimodal embedders.

Author: awais786

.code-samples.meilisearch.yaml

@@ -767,3 +767,17 @@ get_batch_1: |-
   client.get_batch(BATCH_UID)
 get_similar_post_1: |-
   client.index("INDEX_NAME").get_similar_documents({"id": "TARGET_DOCUMENT_ID", "embedder": "default"})
+search_parameter_reference_media_1: |-
+  client.index('movies_fragments').search(
+      "",
+      {
+          "media": {
+              "image_url": "https://image.tmdb.org/t/p/w500/gEU2QniE6E77NI6lCU6MxlNBvIx.jpg"
+          },
+          "hybrid": {
+              "embedder": "voyage",
+              "semanticRatio": 1.0
+          },
+          "limit": 3
+      }
+  )

meilisearch/client.py

@@ -531,6 +531,27 @@ def create_snapshot(self) -> TaskInfo:
 
         return TaskInfo(**task)
 
+    def swap_indexes(self, parameters: List[Mapping[str, List[str]]]) -> TaskInfo:
+        """Swap two indexes.
+
+        Parameters
+        ----------
+        indexes:
+            List of indexes to swap (ex: [{"indexes": ["indexA", "indexB"]}).
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        return TaskInfo(**self.http.post(self.config.paths.swap, parameters))
+
     def get_tasks(self, parameters: Optional[MutableMapping[str, Any]] = None) -> TaskResults:
         """Get all tasks.
 
@@ -977,48 +998,21 @@ def _valid_uuid(uuid: str) -> bool:
         return bool(match)
 
     def get_experimental_features(self) -> dict:
-        """Get current experimental features settings."""
+        """
+        Retrieve the current settings for all experimental features.
+        Returns:
+            dict: A mapping of feature names to their enabled/disabled state.
+        """
         return self.http.get(self.config.paths.experimental_features)
 
     def update_experimental_features(self, features: dict) -> dict:
-        """Update experimental features settings."""
-        return self.http.patch(self.config.paths.experimental_features, body=features)
-
-    def enable_multimodal(self) -> dict:
-        """Enable multimodal experimental feature."""
-        return self.update_experimental_features({"multimodal": True})
-
-    def disable_multimodal(self) -> dict:
-        """Disable multimodal experimental feature."""
-        return self.update_experimental_features({"multimodal": False})
-
-    def swap_indexes(self, swaps: List[Dict[str, list]]) -> TaskInfo:
         """
-        Swap or rename indexes in Meilisearch.
-        This method accepts a list of swap instructions.
-        Each instruction must contain:
-
-        - "indexes": a list of exactly two index UIDs
-        - "rename" (optional): boolean flag
-            * False (default): swap two existing indexes
-            * True: rename index_a → index_b (index_b must NOT exist)
+        Update one or more experimental features.
 
-        A single request can perform multiple swap or rename operations.
-        All operations in the request are atomic—either all succeed, or none do.
-
-        Example:
-            [
-                {"indexes": ["A", "B"]},
-                {"indexes": ["C_tmp", "C"], "rename": True}
-            ]
-
-        Returns
-        -------
-        TaskInfo
-            Task information for the asynchronous swap/rename task.
+        Args:
+            features (dict): A dictionary mapping feature names to booleans.
+                             For example, {"multimodal": True} to enable multimodal.
+        Returns:
+            dict: The updated experimental features settings.
         """
-        if not swaps or not all("indexes" in s and len(s["indexes"]) == 2 for s in swaps):
-            raise ValueError("Each swap must contain exactly two index UIDs under 'indexes' key.")
-
-        task = self.http.post("/swap-indexes",swaps)
-        return TaskInfo(**task)
+        return self.http.patch(self.config.paths.experimental_features, body=features)

meilisearch/config.py

@@ -47,6 +47,7 @@ class Paths:
         localized_attributes = "localized-attributes"
         edit = "edit"
         network = "network"
+        experimental_features = "experimental-features"
 
     def __init__(
         self,

meilisearch/models/embedders.py

@@ -167,6 +167,10 @@ class RestEmbedder(CamelBase):
         Template defining the data Meilisearch sends to the embedder
     document_template_max_bytes: Optional[int]
         Maximum allowed size of rendered document template (defaults to 400)
+    indexing_fragments: Optional[Dict[str, Dict[str, str]]]
+        Defines how to fragment documents for indexing (multi-modal search)
+    search_fragments: Optional[Dict[str, Dict[str, str]]]
+        Defines how to fragment search queries (multi-modal search)
     request: Dict[str, Any]
         A JSON value representing the request Meilisearch makes to the remote embedder
     response: Dict[str, Any]
@@ -185,6 +189,8 @@ class RestEmbedder(CamelBase):
     dimensions: Optional[int] = None
     document_template: Optional[str] = None
     document_template_max_bytes: Optional[int] = None
+    indexing_fragments: Optional[Dict[str, Dict[str, str]]] = None
+    search_fragments: Optional[Dict[str, Dict[str, str]]] = None
     request: Dict[str, Any]
     response: Dict[str, Any]
     headers: Optional[Dict[str, str]] = None

tests/client/test_experimental_features.py

@@ -0,0 +1,55 @@
+"""Tests for experimental features API."""
+
+
+def test_get_experimental_features(client):
+    """Test getting experimental features."""
+    response = client.get_experimental_features()
+    assert isinstance(response, dict)
+    assert "multimodal" in response or "vectorStoreSetting" in response
+
+
+def test_update_experimental_features(client):
+    """Test updating experimental features."""
+    # Enable multimodal
+    response = client.update_experimental_features({"multimodal": True})
+    assert isinstance(response, dict)
+    assert response.get("multimodal") is True
+
+    # Disable multimodal
+    response = client.update_experimental_features({"multimodal": False})
+    assert isinstance(response, dict)
+    assert response.get("multimodal") is False
+
+
+def test_enable_multimodal(client):
+    """Test enabling multimodal experimental feature."""
+    response = client.enable_multimodal()
+    assert isinstance(response, dict)
+    assert response.get("multimodal") is True
+
+    # Verify it's enabled
+    features = client.get_experimental_features()
+    assert features.get("multimodal") is True
+
+
+def test_disable_multimodal(client):
+    """Test disabling multimodal experimental feature."""
+    # First enable it
+    client.enable_multimodal()
+
+    # Then disable it
+    response = client.disable_multimodal()
+    assert isinstance(response, dict)
+    assert response.get("multimodal") is False
+
+    # Verify it's disabled
+    features = client.get_experimental_features()
+    assert features.get("multimodal") is False
+
+
+def test_update_multiple_experimental_features(client):
+    """Test updating multiple experimental features at once."""
+    response = client.update_experimental_features({"multimodal": True, "vectorStoreSetting": True})
+    assert isinstance(response, dict)
+    # At least one should be accepted (depending on Meilisearch version)
+    assert "multimodal" in response or "vectorStoreSetting" in response