feat: 🚧 Attempt at adding new keyword search params

weaviate/collections/grpc/query.py

@@ -164,6 +164,8 @@ def hybrid(
         generative: Optional[_Generative] = None,
         rerank: Optional[Rerank] = None,
         target_vector: Optional[TargetVectorJoinType] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> search_get_pb2.SearchRequest:
         return self.__create_request(
             limit=limit,
@@ -184,6 +186,8 @@ def hybrid(
                 fusion_type,
                 distance,
                 target_vector,
+                minimum_should_match=minimum_should_match,
+                search_operator=search_operator,
             ),
         )
 
@@ -202,6 +206,8 @@ def bm25(
         return_references: Optional[REFERENCES] = None,
         generative: Optional[_Generative] = None,
         rerank: Optional[Rerank] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> search_get_pb2.SearchRequest:
         if self._validate_arguments:
             _validate_input(
@@ -224,7 +230,9 @@ def bm25(
             autocut=autocut,
             bm25=(
                 base_search_pb2.BM25(
-                    query=query, properties=properties if properties is not None else []
+                    query=query, properties=properties if properties is not None else [],
+                    minimum_should_match=minimum_should_match if minimum_should_match is not None else 1,
+                    search_operator=search_operator if search_operator is not None else "or",
                 )
                 if query is not None
                 else None

weaviate/collections/grpc/shared.py

@@ -582,6 +582,8 @@ def _parse_hybrid(
         fusion_type: Optional[HybridFusion],
         distance: Optional[NUMBER],
         target_vector: Optional[TargetVectorJoinType],
+        minimum_should_match: Optional[int],
+        search_operator: Optional[Literal["and", "or"]],
     ) -> Union[base_search_pb2.Hybrid, None]:
         if self._weaviate_version.is_lower_than(1, 25, 0) and (
             isinstance(vector, _HybridNearText) or isinstance(vector, _HybridNearVector)
@@ -618,6 +620,8 @@ def _parse_hybrid(
                         "target_vector",
                         target_vector,
                     ),
+                    _ValidateArgument([int, None], "minimum_should_match", minimum_should_match),
+                    _ValidateArgument([Literal["and", "or"], None], "search_operator", search_operator),
                 ]
             )
 
@@ -724,6 +728,8 @@ def _parse_hybrid(
                 vector_bytes=vector_bytes,
                 vector_distance=distance,
                 vectors=vectors,
+                minimum_should_match=minimum_should_match,
+                search_operator=search_operator,
             )
             if query is not None or vector is not None
             else None

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

@@ -51,6 +51,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[Properties, References]]: ...
 
     @overload
@@ -69,6 +71,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[Properties, CrossReferences]]: ...
 
     @overload
@@ -87,6 +91,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[Properties, TReferences]]: ...
 
     @overload
@@ -105,6 +111,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[TProperties, References]]: ...
 
     @overload
@@ -123,6 +131,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[TProperties, CrossReferences]]: ...
 
     @overload
@@ -141,6 +151,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QueryReturn[TProperties, TReferences]]: ...
 
     ###### GROUP BY ######
@@ -161,6 +173,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[Properties, References]]: ...
 
     @overload
@@ -179,6 +193,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[Properties, CrossReferences]]: ...
 
     @overload
@@ -197,6 +213,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[Properties, TReferences]]: ...
 
     @overload
@@ -215,6 +233,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[TProperties, References]]: ...
 
     @overload
@@ -233,6 +253,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[TProperties, CrossReferences]]: ...
 
     @overload
@@ -251,6 +273,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[GroupByReturn[TProperties, TReferences]]: ...
 
     @overload
@@ -269,6 +293,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Optional[ReturnProperties[TProperties]] = None,
         return_references: Optional[ReturnReferences[TReferences]] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[
         QuerySearchReturnType[Properties, References, TProperties, TReferences]
     ]: ...
@@ -288,6 +314,8 @@ def bm25(
         return_metadata: Optional[METADATA] = None,
         return_properties: Optional[ReturnProperties[TProperties]] = None,
         return_references: Optional[ReturnReferences[TReferences]] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> executor.Result[QuerySearchReturnType[Properties, References, TProperties, TReferences]]:
         """Search for objects in this collection using the keyword-based BM25 algorithm.
 
@@ -355,6 +383,8 @@ def resp(
             return_metadata=self._parse_return_metadata(return_metadata, include_vector),
             return_properties=self._parse_return_properties(return_properties),
             return_references=self._parse_return_references(cast(Any, return_references)),
+            minimum_should_match=minimum_should_match,
+            search_operator=search_operator,
         )
         return executor.execute(
             response_callback=resp,

weaviate/collections/queries/bm25/query/sync.pyi

@@ -35,6 +35,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[Properties, References]: ...
     @overload
     def bm25(
@@ -52,6 +54,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[Properties, CrossReferences]: ...
     @overload
     def bm25(
@@ -69,6 +73,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[Properties, TReferences]: ...
     @overload
     def bm25(
@@ -86,6 +92,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[TProperties, References]: ...
     @overload
     def bm25(
@@ -103,6 +111,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[TProperties, CrossReferences]: ...
     @overload
     def bm25(
@@ -120,6 +130,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QueryReturn[TProperties, TReferences]: ...
     @overload
     def bm25(
@@ -137,6 +149,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[Properties, References]: ...
     @overload
     def bm25(
@@ -154,6 +168,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[Properties, CrossReferences]: ...
     @overload
     def bm25(
@@ -171,6 +187,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Union[PROPERTIES, bool, None] = None,
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[Properties, TReferences]: ...
     @overload
     def bm25(
@@ -188,6 +206,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Literal[None] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[TProperties, References]: ...
     @overload
     def bm25(
@@ -205,6 +225,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: REFERENCES,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[TProperties, CrossReferences]: ...
     @overload
     def bm25(
@@ -222,6 +244,8 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Type[TProperties],
         return_references: Type[TReferences],
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> GroupByReturn[TProperties, TReferences]: ...
     @overload
     def bm25(
@@ -239,4 +263,6 @@ class _BM25Query(
         return_metadata: Optional[METADATA] = None,
         return_properties: Optional[ReturnProperties[TProperties]] = None,
         return_references: Optional[ReturnReferences[TReferences]] = None,
+        minimum_should_match: Optional[int] = None,
+        search_operator: Optional[Literal["and", "or"]] = None,
     ) -> QuerySearchReturnType[Properties, References, TProperties, TReferences]: ...

weaviate/proto/v1/base_search_pb2.pyi

@@ -9,6 +9,7 @@ from typing import (
     Mapping as _Mapping,
     Optional as _Optional,
     Union as _Union,
+    Literal as _Literal,
 )
 
 DESCRIPTOR: _descriptor.FileDescriptor
@@ -93,6 +94,8 @@ class Hybrid(_message.Message):
         "targets",
         "vector_distance",
         "vectors",
+        "minimum_should_match",
+        "search_operator",
     )
 
     class FusionType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
@@ -128,6 +131,8 @@ class Hybrid(_message.Message):
     targets: Targets
     vector_distance: float
     vectors: _containers.RepeatedCompositeFieldContainer[_base_pb2.Vectors]
+    minimum_should_match: int
+    search_operator: _Literal["and", "or"]
     def __init__(
         self,
         query: _Optional[str] = ...,
@@ -142,8 +147,11 @@ class Hybrid(_message.Message):
         targets: _Optional[_Union[Targets, _Mapping]] = ...,
         vector_distance: _Optional[float] = ...,
         vectors: _Optional[_Iterable[_Union[_base_pb2.Vectors, _Mapping]]] = ...,
+        minimum_should_match: _Optional[int] = ...,
+        search_operator: _Optional[_Literal["and", "or"]] = ...,
     ) -> None: ...
 
+
 class NearVector(_message.Message):
     __slots__ = (
         "vector",
@@ -395,11 +403,14 @@ class NearIMUSearch(_message.Message):
     ) -> None: ...
 
 class BM25(_message.Message):
-    __slots__ = ("query", "properties")
+    __slots__ = ("query", "properties", "minimum_should_match", "search_operator")
     QUERY_FIELD_NUMBER: _ClassVar[int]
     PROPERTIES_FIELD_NUMBER: _ClassVar[int]
     query: str
     properties: _containers.RepeatedScalarFieldContainer[str]
+    minimum_should_match: int
+    search_operator: _Literal["and", "or"]
     def __init__(
-        self, query: _Optional[str] = ..., properties: _Optional[_Iterable[str]] = ...
+        self, query: _Optional[str] = ..., properties: _Optional[_Iterable[str]] = ..., 
+        minimum_should_match: _Optional[int] = ..., search_operator: _Optional[_Literal["and", "or"]] = ... 
     ) -> None: ...