feat: export FilterReturn from weaviate.classes.query

integration/test_collection_aggregate.py

@@ -23,7 +23,7 @@
     Property,
     ReferenceProperty,
 )
-from weaviate.collections.classes.filters import Filter, _Filters
+from weaviate.collections.classes.filters import Filter, FilterReturn
 from weaviate.collections.classes.grpc import Move
 from weaviate.collections.classes.tenants import Tenant
 from weaviate.exceptions import (
@@ -153,7 +153,9 @@ def test_aggregation_groupby_no_results(collection_factory: CollectionFactory) -
         Filter.by_property("uuids").contains_any([UUID2]),
     ],
 )
-def test_over_all_with_filters(collection_factory: CollectionFactory, filter_: _Filters) -> None:
+def test_over_all_with_filters(
+    collection_factory: CollectionFactory, filter_: FilterReturn
+) -> None:
     collection = collection_factory(
         properties=[
             Property(name="text", data_type=DataType.TEXT),

integration/test_collection_filter.py

@@ -9,7 +9,7 @@
 from integration.conftest import CollectionFactory
 from weaviate.collections.classes.config import Configure, DataType, Property, ReferenceProperty
 from weaviate.collections.classes.data import DataObject
-from weaviate.collections.classes.filters import Filter, _Filters, _FilterValue
+from weaviate.collections.classes.filters import Filter, FilterReturn, _FilterValue
 from weaviate.collections.classes.grpc import MetadataQuery, QueryReference, Sort
 from weaviate.collections.classes.internal import ReferenceToMulti
 from weaviate.types import UUID
@@ -34,7 +34,7 @@
 )
 def test_filters_text(
     collection_factory: CollectionFactory,
-    weaviate_filter: _Filters,
+    weaviate_filter: FilterReturn,
     results: List[int],
 ) -> None:
     collection = collection_factory(
@@ -160,7 +160,7 @@ def test_filter_with_wrong_types(
 )
 def test_filters_nested(
     collection_factory: CollectionFactory,
-    weaviate_filter: _Filters,
+    weaviate_filter: FilterReturn,
     results: List[int],
 ) -> None:
     collection = collection_factory(
@@ -401,7 +401,7 @@ def test_filters_contains(
     ],
 )
 def test_ref_filters(
-    collection_factory: CollectionFactory, weaviate_filter: _Filters, results: List[int]
+    collection_factory: CollectionFactory, weaviate_filter: FilterReturn, results: List[int]
 ) -> None:
     to_collection = collection_factory(
         name="Target",

weaviate/classes/query.py

@@ -1,5 +1,5 @@
 from weaviate.collections.classes.aggregate import Metrics
-from weaviate.collections.classes.filters import Filter
+from weaviate.collections.classes.filters import Filter, FilterReturn
 from weaviate.collections.classes.generative import GenerativeConfig
 from weaviate.collections.classes.grpc import (
     BM25OperatorFactory as BM25Operator,
@@ -22,6 +22,7 @@
 
 __all__ = [
     "Filter",
+    "FilterReturn",
     "GeoCoordinate",
     "GenerativeConfig",
     "GroupBy",

weaviate/collections/aggregations/base_executor.py

@@ -30,7 +30,7 @@
     _MetricsText,
 )
 from weaviate.collections.classes.config import ConsistencyLevel
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.collections.classes.grpc import Move
 from weaviate.collections.classes.types import GeoCoordinate
 from weaviate.collections.filters import _FilterToREST
@@ -326,13 +326,13 @@ def _add_groupby_to_builder(
     def _base(
         self,
         return_metrics: Optional[List[_Metrics]],
-        filters: Optional[_Filters],
+        filters: Optional[FilterReturn],
         total_count: bool,
     ) -> AggregateBuilder:
         _validate_input(
             [
                 _ValidateArgument([List[_Metrics], None], "return_metrics", return_metrics),
-                _ValidateArgument([_Filters, None], "filters", filters),
+                _ValidateArgument([FilterReturn, None], "filters", filters),
                 _ValidateArgument([bool], "total_count", total_count),
             ]
         )

weaviate/collections/aggregations/hybrid/async_.pyi

@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.collections.classes.grpc import BM25OperatorOptions
 from weaviate.connect.v4 import ConnectionAsync
 from weaviate.types import NUMBER
@@ -24,7 +24,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -41,7 +41,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -58,7 +58,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,

weaviate/collections/aggregations/hybrid/executor.py

@@ -7,7 +7,7 @@
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.collections.classes.grpc import BM25OperatorOptions
 from weaviate.collections.filters import _FilterToGRPC
 from weaviate.connect import executor
@@ -27,7 +27,7 @@ def hybrid(
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -45,7 +45,7 @@ def hybrid(
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -63,7 +63,7 @@ def hybrid(
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -80,7 +80,7 @@ def hybrid(
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,

weaviate/collections/aggregations/hybrid/sync.pyi

@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.collections.classes.grpc import BM25OperatorOptions
 from weaviate.connect.v4 import ConnectionSync
 from weaviate.types import NUMBER
@@ -24,7 +24,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -41,7 +41,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,
@@ -58,7 +58,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
         query_properties: Optional[List[str]] = None,
         object_limit: Optional[int] = None,
         bm25_operator: Optional[BM25OperatorOptions] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         max_vector_distance: Optional[float] = None,

weaviate/collections/aggregations/near_image/async_.pyi

@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.connect.v4 import ConnectionAsync
 from weaviate.types import BLOB_INPUT, NUMBER
 
@@ -21,7 +21,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -35,7 +35,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -49,7 +49,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,

weaviate/collections/aggregations/near_image/executor.py

@@ -7,7 +7,7 @@
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.collections.filters import _FilterToGRPC
 from weaviate.connect import executor
 from weaviate.connect.v4 import ConnectionType
@@ -25,7 +25,7 @@ def near_image(
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -40,7 +40,7 @@ def near_image(
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -55,7 +55,7 @@ def near_image(
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -69,7 +69,7 @@ def near_image(
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,

weaviate/collections/aggregations/near_image/sync.pyi

@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.connect.v4 import ConnectionSync
 from weaviate.types import BLOB_INPUT, NUMBER
 
@@ -21,7 +21,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -35,7 +35,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -49,7 +49,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,

weaviate/collections/aggregations/near_object/async_.pyi

@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
     GroupByAggregate,
     PropertiesMetrics,
 )
-from weaviate.collections.classes.filters import _Filters
+from weaviate.collections.classes.filters import FilterReturn
 from weaviate.connect.v4 import ConnectionAsync
 from weaviate.types import NUMBER, UUID
 
@@ -21,7 +21,7 @@ class _NearObjectAsync(_NearObjectExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Literal[None] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -35,7 +35,7 @@ class _NearObjectAsync(_NearObjectExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Union[str, GroupByAggregate],
         target_vector: Optional[str] = None,
         total_count: bool = True,
@@ -49,7 +49,7 @@ class _NearObjectAsync(_NearObjectExecutor[ConnectionAsync]):
         certainty: Optional[NUMBER] = None,
         distance: Optional[NUMBER] = None,
         object_limit: Optional[int] = None,
-        filters: Optional[_Filters] = None,
+        filters: Optional[FilterReturn] = None,
         group_by: Optional[Union[str, GroupByAggregate]] = None,
         target_vector: Optional[str] = None,
         total_count: bool = True,