Merge pull request #1656 from weaviate/fix/missing-bm25-stub

Add missing default stub to `query.bm25`

Author: tsmith023

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

@@ -229,3 +229,20 @@ class _BM25QueryAsync(
         return_properties: Type[TProperties],
         return_references: Type[TReferences]
     ) -> GroupByReturn[TProperties, TReferences]: ...
+    @overload
+    async def bm25(
+        self,
+        query: Optional[str],
+        *,
+        query_properties: Optional[List[str]] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        auto_limit: Optional[int] = None,
+        filters: Optional[_Filters] = None,
+        group_by: Optional[GroupBy] = None,
+        rerank: Optional[Rerank] = None,
+        include_vector: INCLUDE_VECTOR = False,
+        return_metadata: Optional[METADATA] = None,
+        return_properties: Optional[ReturnProperties[TProperties]] = None,
+        return_references: Optional[ReturnReferences[TReferences]] = None
+    ) -> QuerySearchReturnType[Properties, References, TProperties, TReferences]: ...

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

@@ -243,6 +243,26 @@ def bm25(
         return_references: Type[TReferences],
     ) -> executor.Result[GroupByReturn[TProperties, TReferences]]: ...
 
+    @overload
+    def bm25(
+        self,
+        query: Optional[str],
+        *,
+        query_properties: Optional[List[str]] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        auto_limit: Optional[int] = None,
+        filters: Optional[_Filters] = None,
+        group_by: Optional[GroupBy] = None,
+        rerank: Optional[Rerank] = None,
+        include_vector: INCLUDE_VECTOR = False,
+        return_metadata: Optional[METADATA] = None,
+        return_properties: Optional[ReturnProperties[TProperties]] = None,
+        return_references: Optional[ReturnReferences[TReferences]] = None,
+    ) -> executor.Result[
+        QuerySearchReturnType[Properties, References, TProperties, TReferences]
+    ]: ...
+
     def bm25(
         self,
         query: Optional[str],

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

@@ -229,3 +229,20 @@ class _BM25Query(
         return_properties: Type[TProperties],
         return_references: Type[TReferences]
     ) -> GroupByReturn[TProperties, TReferences]: ...
+    @overload
+    def bm25(
+        self,
+        query: Optional[str],
+        *,
+        query_properties: Optional[List[str]] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        auto_limit: Optional[int] = None,
+        filters: Optional[_Filters] = None,
+        group_by: Optional[GroupBy] = None,
+        rerank: Optional[Rerank] = None,
+        include_vector: INCLUDE_VECTOR = False,
+        return_metadata: Optional[METADATA] = None,
+        return_properties: Optional[ReturnProperties[TProperties]] = None,
+        return_references: Optional[ReturnReferences[TReferences]] = None
+    ) -> QuerySearchReturnType[Properties, References, TProperties, TReferences]: ...