Add new is_null property filter (#58)

* Update ignore

* Add new IsNullPropertyFilter filter response type

* Update tests with new filter

---------

Co-authored-by: Dan Jones <[email protected]>

Author: danmichaeljones

.gitignore

@@ -169,3 +169,6 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# MacOS
+.DS_Store

test/query_agent/test_query_model.py

@@ -135,6 +135,11 @@ def json(self) -> dict:
                             "longitude": 20.0,
                             "max_distance_meters": 30.0,
                         },
+                        {
+                            "filter_type": "is_null",
+                            "property_name": "prop_is_null",
+                            "is_null": True,
+                        },
                         {
                             "filter_type": "something_new",
                             "property_name": "strange_property",
@@ -219,6 +224,11 @@ def json(self) -> dict:
                             "longitude": 20.0,
                             "max_distance_meters": 30.0,
                         },
+                        {
+                            "filter_type": "is_null",
+                            "property_name": "prop_is_null",
+                            "is_null": True,
+                        },
                         {
                             "filter_type": "something_new",
                             "property_name": "strange_property",

test/test_imports.py

@@ -57,6 +57,7 @@ def test_class_exports():
         IntegerArrayPropertyFilter,
         IntegerPropertyAggregation,
         IntegerPropertyFilter,
+        IsNullPropertyFilter,
         NumericMetrics,
         Operations,
         OperationStep,
@@ -118,6 +119,7 @@ def test_class_exports():
         IntegerArrayPropertyFilter,
         IntegerPropertyAggregation,
         IntegerPropertyFilter,
+        IsNullPropertyFilter,
         GeoPropertyFilter,
         NumericMetrics,
         Operations,
@@ -198,6 +200,7 @@ def test_class_exports():
         "ProgressDetails",
         "ProgressMessage",
         "StreamedTokens",
+        "IsNullPropertyFilter",
     ]
 
     assert hasattr(

weaviate_agents/classes/__init__.py

@@ -23,6 +23,7 @@
     IntegerArrayPropertyFilter,
     IntegerPropertyAggregation,
     IntegerPropertyFilter,
+    IsNullPropertyFilter,
     NumericMetrics,
     ProgressDetails,
     ProgressMessage,
@@ -94,4 +95,5 @@
     "ProgressMessage",
     "QueryWithCollection",
     "StreamedTokens",
+    "IsNullPropertyFilter",
 ]

weaviate_agents/classes/query.py

@@ -14,6 +14,7 @@
     IntegerArrayPropertyFilter,
     IntegerPropertyAggregation,
     IntegerPropertyFilter,
+    IsNullPropertyFilter,
     NumericMetrics,
     ProgressDetails,
     ProgressMessage,
@@ -66,4 +67,5 @@
     "ProgressMessage",
     "QueryWithCollection",
     "StreamedTokens",
+    "IsNullPropertyFilter",
 ]

weaviate_agents/query/classes/__init__.py

@@ -16,6 +16,7 @@
     IntegerArrayPropertyFilter,
     IntegerPropertyAggregation,
     IntegerPropertyFilter,
+    IsNullPropertyFilter,
     NumericMetrics,
     ProgressDetails,
     ProgressMessage,
@@ -66,4 +67,5 @@
     "ProgressMessage",
     "QueryWithCollection",
     "StreamedTokens",
+    "IsNullPropertyFilter",
 ]

weaviate_agents/query/classes/response.py

@@ -31,6 +31,7 @@ class KnownFilterType(str, Enum):
     DATE = "date_range"
     DATE_ARRAY = "date_array"
     GEO = "geo"
+    IS_NULL = "is_null"
 
 
 class KnownPropertyFilterBase(BaseModel):
@@ -159,6 +160,16 @@ class GeoPropertyFilter(KnownPropertyFilterBase):
     max_distance_meters: float
 
 
+class IsNullPropertyFilter(KnownPropertyFilterBase):
+    """Filter by property null state."""
+
+    filter_type: Literal[KnownFilterType.IS_NULL] = Field(
+        repr=False, default=KnownFilterType.IS_NULL
+    )
+
+    is_null: bool
+
+
 class UnknownPropertyFilter(BaseModel):
     """Catch-all filter for unknown filter types, to preserve future back-compatibility."""
 
@@ -193,6 +204,7 @@ def model_post_init(self, context: Any) -> None:
     DatePropertyFilter,
     DateArrayPropertyFilter,
     GeoPropertyFilter,
+    IsNullPropertyFilter,
     UnknownPropertyFilter,
 ]