Skip to content

Commit 6017fde

Browse files
g-despotg-despot
committed
Rename _DiversityMMR to MMR
1 parent b68160d commit 6017fde

19 files changed

Lines changed: 236 additions & 229 deletions

File tree

‎weaviate/classes/query.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
BM25OperatorFactory as BM25Operator,
66
)
77
from weaviate.collections.classes.grpc import (
8+
MMR,
89
Diversity,
910
GroupBy,
1011
HybridFusion,
@@ -31,6 +32,7 @@
3132
"HybridFusion",
3233
"HybridVector",
3334
"BM25Operator",
35+
"MMR",
3436
"MetadataQuery",
3537
"Metrics",
3638
"Move",

‎weaviate/collections/classes/grpc.py‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,13 @@ class Rerank(_WeaviateInput):
269269

270270

271271
@dataclass
272-
class _DiversityMMR:
273-
"""Define MMR (Maximal Marginal Relevance) diversity selection."""
272+
class MMR:
273+
"""Define MMR (Maximal Marginal Relevance) diversity selection.
274+
275+
Args:
276+
limit: Optional number of candidates to consider for diversification.
277+
balance: Optional MMR lambda in [0.0, 1.0] — 1.0 is pure relevance, 0.0 is pure diversity.
278+
"""
274279

275280
limit: Optional[int] = None
276281
balance: Optional[float] = None
@@ -282,7 +287,7 @@ class Diversity:
282287
def __init__(self) -> None:
283288
raise TypeError("Diversity cannot be instantiated directly. Use Diversity.MMR(...).")
284289

285-
MMR = _DiversityMMR
290+
MMR = MMR
286291

287292

288293
@dataclass

‎weaviate/collections/grpc/query.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
QueryNested,
3232
Rerank,
3333
TargetVectorJoinType,
34-
_DiversityMMR,
34+
MMR,
3535
_MetadataQuery,
3636
_QueryReference,
3737
_QueryReferenceMultiTarget,
@@ -263,7 +263,7 @@ def near_vector(
263263
return_metadata: Optional[_MetadataQuery] = None,
264264
return_properties: Union[PROPERTIES, bool, None] = None,
265265
return_references: Optional[REFERENCES] = None,
266-
selection: Optional[_DiversityMMR] = None,
266+
selection: Optional[MMR] = None,
267267
) -> search_get_pb2.SearchRequest:
268268
return self.__create_request(
269269
limit=limit,
@@ -298,7 +298,7 @@ def near_object(
298298
return_metadata: Optional[_MetadataQuery] = None,
299299
return_properties: Union[PROPERTIES, bool, None] = None,
300300
return_references: Optional[REFERENCES] = None,
301-
selection: Optional[_DiversityMMR] = None,
301+
selection: Optional[MMR] = None,
302302
) -> search_get_pb2.SearchRequest:
303303
return self.__create_request(
304304
limit=limit,
@@ -335,7 +335,7 @@ def near_text(
335335
return_metadata: Optional[_MetadataQuery] = None,
336336
return_properties: Union[PROPERTIES, bool, None] = None,
337337
return_references: Optional[REFERENCES] = None,
338-
selection: Optional[_DiversityMMR] = None,
338+
selection: Optional[MMR] = None,
339339
) -> search_get_pb2.SearchRequest:
340340
return self.__create_request(
341341
limit=limit,
@@ -377,7 +377,7 @@ def near_media(
377377
return_metadata: Optional[_MetadataQuery] = None,
378378
return_properties: Union[PROPERTIES, bool, None] = None,
379379
return_references: Optional[REFERENCES] = None,
380-
selection: Optional[_DiversityMMR] = None,
380+
selection: Optional[MMR] = None,
381381
) -> search_get_pb2.SearchRequest:
382382
return self.__create_request(
383383
limit=limit,

‎weaviate/collections/grpc/shared.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
PrimitiveVectorType,
2828
TargetVectorJoinType,
2929
TwoDimensionalVectorType,
30-
_DiversityMMR,
30+
MMR,
3131
_HybridNearText,
3232
_HybridNearVector,
3333
_ListOfVectorsQuery,
@@ -313,7 +313,7 @@ def _parse_near_options(
313313

314314
@staticmethod
315315
def _selection_to_grpc(
316-
selection: Optional[_DiversityMMR],
316+
selection: Optional[MMR],
317317
) -> Optional[base_search_pb2.Selection]:
318318
if selection is None:
319319
return None
@@ -330,7 +330,7 @@ def _parse_near_vector(
330330
certainty: Optional[NUMBER],
331331
distance: Optional[NUMBER],
332332
target_vector: Optional[TargetVectorJoinType],
333-
selection: Optional[_DiversityMMR] = None,
333+
selection: Optional[MMR] = None,
334334
) -> base_search_pb2.NearVector:
335335
if self._validate_arguments:
336336
_validate_input(
@@ -439,7 +439,7 @@ def _parse_near_text(
439439
move_to: Optional[Move],
440440
move_away: Optional[Move],
441441
target_vector: Optional[TargetVectorJoinType],
442-
selection: Optional[_DiversityMMR] = None,
442+
selection: Optional[MMR] = None,
443443
) -> base_search_pb2.NearTextSearch:
444444
if self._validate_arguments:
445445
_validate_input(
@@ -477,7 +477,7 @@ def _parse_near_object(
477477
certainty: Optional[NUMBER],
478478
distance: Optional[NUMBER],
479479
target_vector: Optional[TargetVectorJoinType],
480-
selection: Optional[_DiversityMMR] = None,
480+
selection: Optional[MMR] = None,
481481
) -> base_search_pb2.NearObject:
482482
if self._validate_arguments:
483483
_validate_input(
@@ -511,7 +511,7 @@ def _parse_media(
511511
certainty: Optional[NUMBER],
512512
distance: Optional[NUMBER],
513513
target_vector: Optional[TargetVectorJoinType],
514-
selection: Optional[_DiversityMMR] = None,
514+
selection: Optional[MMR] = None,
515515
) -> dict:
516516
if self._validate_arguments:
517517
_validate_input(

‎weaviate/collections/queries/near_image/query/async_.pyi‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ from weaviate.collections.classes.grpc import (
88
GroupBy,
99
Rerank,
1010
TargetVectorJoinType,
11-
_DiversityMMR,
11+
MMR,
1212
)
1313
from weaviate.collections.classes.internal import (
1414
CrossReferences,
@@ -41,7 +41,7 @@ class _NearImageQueryAsync(
4141
filters: Optional[FilterReturn] = None,
4242
group_by: Literal[None] = None,
4343
rerank: Optional[Rerank] = None,
44-
selection: Optional[_DiversityMMR] = None,
44+
selection: Optional[MMR] = None,
4545
target_vector: Optional[TargetVectorJoinType] = None,
4646
include_vector: INCLUDE_VECTOR = False,
4747
return_metadata: Optional[METADATA] = None,
@@ -61,7 +61,7 @@ class _NearImageQueryAsync(
6161
filters: Optional[FilterReturn] = None,
6262
group_by: Literal[None] = None,
6363
rerank: Optional[Rerank] = None,
64-
selection: Optional[_DiversityMMR] = None,
64+
selection: Optional[MMR] = None,
6565
target_vector: Optional[TargetVectorJoinType] = None,
6666
include_vector: INCLUDE_VECTOR = False,
6767
return_metadata: Optional[METADATA] = None,
@@ -81,7 +81,7 @@ class _NearImageQueryAsync(
8181
filters: Optional[FilterReturn] = None,
8282
group_by: Literal[None] = None,
8383
rerank: Optional[Rerank] = None,
84-
selection: Optional[_DiversityMMR] = None,
84+
selection: Optional[MMR] = None,
8585
target_vector: Optional[TargetVectorJoinType] = None,
8686
include_vector: INCLUDE_VECTOR = False,
8787
return_metadata: Optional[METADATA] = None,
@@ -101,7 +101,7 @@ class _NearImageQueryAsync(
101101
filters: Optional[FilterReturn] = None,
102102
group_by: Literal[None] = None,
103103
rerank: Optional[Rerank] = None,
104-
selection: Optional[_DiversityMMR] = None,
104+
selection: Optional[MMR] = None,
105105
target_vector: Optional[TargetVectorJoinType] = None,
106106
include_vector: INCLUDE_VECTOR = False,
107107
return_metadata: Optional[METADATA] = None,
@@ -121,7 +121,7 @@ class _NearImageQueryAsync(
121121
filters: Optional[FilterReturn] = None,
122122
group_by: Literal[None] = None,
123123
rerank: Optional[Rerank] = None,
124-
selection: Optional[_DiversityMMR] = None,
124+
selection: Optional[MMR] = None,
125125
target_vector: Optional[TargetVectorJoinType] = None,
126126
include_vector: INCLUDE_VECTOR = False,
127127
return_metadata: Optional[METADATA] = None,
@@ -141,7 +141,7 @@ class _NearImageQueryAsync(
141141
filters: Optional[FilterReturn] = None,
142142
group_by: Literal[None] = None,
143143
rerank: Optional[Rerank] = None,
144-
selection: Optional[_DiversityMMR] = None,
144+
selection: Optional[MMR] = None,
145145
target_vector: Optional[TargetVectorJoinType] = None,
146146
include_vector: INCLUDE_VECTOR = False,
147147
return_metadata: Optional[METADATA] = None,
@@ -161,7 +161,7 @@ class _NearImageQueryAsync(
161161
filters: Optional[FilterReturn] = None,
162162
group_by: GroupBy,
163163
rerank: Optional[Rerank] = None,
164-
selection: Optional[_DiversityMMR] = None,
164+
selection: Optional[MMR] = None,
165165
target_vector: Optional[TargetVectorJoinType] = None,
166166
include_vector: INCLUDE_VECTOR = False,
167167
return_metadata: Optional[METADATA] = None,
@@ -181,7 +181,7 @@ class _NearImageQueryAsync(
181181
filters: Optional[FilterReturn] = None,
182182
group_by: GroupBy,
183183
rerank: Optional[Rerank] = None,
184-
selection: Optional[_DiversityMMR] = None,
184+
selection: Optional[MMR] = None,
185185
target_vector: Optional[TargetVectorJoinType] = None,
186186
include_vector: INCLUDE_VECTOR = False,
187187
return_metadata: Optional[METADATA] = None,
@@ -201,7 +201,7 @@ class _NearImageQueryAsync(
201201
filters: Optional[FilterReturn] = None,
202202
group_by: GroupBy,
203203
rerank: Optional[Rerank] = None,
204-
selection: Optional[_DiversityMMR] = None,
204+
selection: Optional[MMR] = None,
205205
target_vector: Optional[TargetVectorJoinType] = None,
206206
include_vector: INCLUDE_VECTOR = False,
207207
return_metadata: Optional[METADATA] = None,
@@ -221,7 +221,7 @@ class _NearImageQueryAsync(
221221
filters: Optional[FilterReturn] = None,
222222
group_by: GroupBy,
223223
rerank: Optional[Rerank] = None,
224-
selection: Optional[_DiversityMMR] = None,
224+
selection: Optional[MMR] = None,
225225
target_vector: Optional[TargetVectorJoinType] = None,
226226
include_vector: INCLUDE_VECTOR = False,
227227
return_metadata: Optional[METADATA] = None,
@@ -241,7 +241,7 @@ class _NearImageQueryAsync(
241241
filters: Optional[FilterReturn] = None,
242242
group_by: GroupBy,
243243
rerank: Optional[Rerank] = None,
244-
selection: Optional[_DiversityMMR] = None,
244+
selection: Optional[MMR] = None,
245245
target_vector: Optional[TargetVectorJoinType] = None,
246246
include_vector: INCLUDE_VECTOR = False,
247247
return_metadata: Optional[METADATA] = None,
@@ -261,7 +261,7 @@ class _NearImageQueryAsync(
261261
filters: Optional[FilterReturn] = None,
262262
group_by: GroupBy,
263263
rerank: Optional[Rerank] = None,
264-
selection: Optional[_DiversityMMR] = None,
264+
selection: Optional[MMR] = None,
265265
target_vector: Optional[TargetVectorJoinType] = None,
266266
include_vector: INCLUDE_VECTOR = False,
267267
return_metadata: Optional[METADATA] = None,
@@ -281,7 +281,7 @@ class _NearImageQueryAsync(
281281
filters: Optional[FilterReturn] = None,
282282
group_by: Optional[GroupBy] = None,
283283
rerank: Optional[Rerank] = None,
284-
selection: Optional[_DiversityMMR] = None,
284+
selection: Optional[MMR] = None,
285285
target_vector: Optional[TargetVectorJoinType] = None,
286286
include_vector: INCLUDE_VECTOR = False,
287287
return_metadata: Optional[METADATA] = None,

0 commit comments

Comments
 (0)