feat: Adding support Multimodal embedders.

Author: awais786

.code-samples.meilisearch.yaml

@@ -769,16 +769,21 @@ 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(
-      "",
+      "a futuristic space movie",
       {
           "media": {
-              "image_url": "https://image.tmdb.org/t/p/w500/gEU2QniE6E77NI6lCU6MxlNBvIx.jpg"
+              "textAndPoster": {
+                  "text": "a futuristic space movie",
+                  "image": {
+                      "mime": "image/jpeg",
+                      "data": "BASE64_ENCODED_IMAGE_DATA"
+                  }
+              }
           },
           "hybrid": {
-              "embedder": "voyage",
+              "embedder": "multimodal",
               "semanticRatio": 1.0
           },
-          "limit": 3
       }
   )
 webhooks_get_1: |-

meilisearch/client.py

@@ -1111,22 +1111,40 @@ def _valid_uuid(uuid: str) -> bool:
         match = uuid4hex.match(uuid)
         return bool(match)
 
-    def get_experimental_features(self) -> dict:
-        """
-        Retrieve the current settings for all experimental features.
-        Returns:
-            dict: A mapping of feature names to their enabled/disabled state.
+    def get_experimental_features(self) -> Dict[str, Any]:
+        """Retrieve the current settings for all experimental features.
+
+        Returns
+        -------
+        features:
+            A dictionary mapping feature names to their enabled/disabled state.
+            For example: {"multimodal": True, "vectorStore": False}
+
+        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 self.http.get(self.config.paths.experimental_features)
 
-    def update_experimental_features(self, features: dict) -> dict:
-        """
-        Update one or more experimental features.
+    def update_experimental_features(self, features: Dict[str, bool]) -> Dict[str, Any]:
+        """Update one or more experimental features.
 
-        Args:
-            features (dict): A dictionary mapping feature names to booleans.
-                             For example, {"multimodal": True} to enable multimodal.
-        Returns:
-            dict: The updated experimental features settings.
+        Parameters
+        ----------
+        features:
+            A dictionary mapping feature names to booleans.
+            For example, {"multimodal": True} to enable multimodal,
+            or {"multimodal": True, "vectorStore": False} to update multiple features.
+
+        Returns
+        -------
+        features:
+            The updated experimental features settings as a dictionary.
+
+        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 self.http.patch(self.config.paths.experimental_features, body=features)

meilisearch/models/embedders.py

@@ -167,10 +167,12 @@ 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)
+    indexing_fragments: Optional[Dict[str, Dict[str, Any]]]
+        Defines how to fragment documents for indexing (multi-modal search).
+        Fragments can contain complex nested structures (e.g., lists of objects).
+    search_fragments: Optional[Dict[str, Dict[str, Any]]]
+        Defines how to fragment search queries (multi-modal search).
+        Fragments can contain complex nested structures (e.g., lists of objects).
     request: Dict[str, Any]
         A JSON value representing the request Meilisearch makes to the remote embedder
     response: Dict[str, Any]
@@ -189,8 +191,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
+    indexing_fragments: Optional[Dict[str, Dict[str, Any]]] = None
+    search_fragments: Optional[Dict[str, Dict[str, Any]]] = None
     request: Dict[str, Any]
     response: Dict[str, Any]
     headers: Optional[Dict[str, str]] = None

tests/client/test_experimental_features.py

@@ -5,6 +5,7 @@ def test_get_experimental_features(client):
     """Test getting experimental features."""
     response = client.get_experimental_features()
     assert isinstance(response, dict)
+    # Check that at least one known experimental feature is present
     assert "multimodal" in response or "vectorStoreSetting" in response
 
 
@@ -23,7 +24,9 @@ def test_update_experimental_features(client):
 
 def test_update_multiple_experimental_features(client):
     """Test updating multiple experimental features at once."""
-    response = client.update_experimental_features({"multimodal": True, "vectorStoreSetting": True})
+    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