FIx docstrings

Author: dirkkul

weaviate/collections/classes/grpc.py

@@ -617,9 +617,13 @@ def blend(
 class MMR:
     """Define MMR (Maximal Marginal Relevance) diversity selection.
 
+    Not supported for multi-vector indexes.
+
     Args:
-        limit: Optional number of candidates to consider for diversification.
-        balance: Optional MMR lambda in [0.0, 1.0] — 1.0 is pure relevance, 0.0 is pure diversity.
+        limit: Number of objects to select. The server requires it: it must be at least 1 and
+            no larger than the query's own `limit` when one is set.
+        balance: Optional MMR lambda in [0.0, 1.0]. 1.0 ranks purely by relevance to the query,
+            0.0 purely by dissimilarity to the objects already selected.
     """
 
     limit: Optional[int] = None
@@ -636,9 +640,13 @@ def __init__(self) -> None:
     def mmr(limit: Optional[int] = None, balance: Optional[float] = None) -> MMR:
         """Maximal Marginal Relevance diversity selection.
 
+        Not supported for multi-vector indexes.
+
         Args:
-            limit: Number of candidates to consider for diversification.
-            balance: MMR lambda in [0.0, 1.0] — 1.0 pure relevance, 0.0 pure diversity.
+            limit: Number of objects to select. The server requires it: it must be at least 1
+                and no larger than the query's own `limit` when one is set.
+            balance: MMR lambda in [0.0, 1.0]. 1.0 ranks purely by relevance to the query,
+                0.0 purely by dissimilarity to the objects already selected.
         """
         return MMR(limit=limit, balance=balance)
 

weaviate/collections/queries/hybrid/generate/executor.py

@@ -491,7 +491,7 @@ def hybrid(
             group_by: How the results should be grouped by a specific property.
             rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
             boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
-            diversity_selection: An `MMR` selection applied to the fused results to diversify the returned objects.
+            diversity_selection: An `MMR` selection applied to the fused results to diversify the returned objects. Requires Weaviate >= 1.38.6.
             target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
             include_vector: Whether to include the vector in the results. If not specified, this is set to False.
             return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/hybrid/query/executor.py

@@ -427,7 +427,7 @@ def hybrid(
             group_by: How the results should be grouped by a specific property.
             rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
             boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
-            diversity_selection: An `MMR` selection applied to the fused results to diversify the returned objects.
+            diversity_selection: An `MMR` selection applied to the fused results to diversify the returned objects. Requires Weaviate >= 1.38.6.
             target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
             include_vector: Whether to include the vector in the results. If not specified, this is set to False.
             return_metadata: The metadata to return for each object, defaults to `None`.