Embabel Agent Documentation/com.embabel.agent.filter/PropertyFilter

PropertyFilter

Filter expression for property-based filtering on key-value maps.

A safe, composable expression tree that can be used for:

Metadata filtering: Applied to metadata maps
Property filtering: Applied to object property maps or typed entity fields
Guard conditions: LLM-generatable expressions for safe condition evaluation

Backends can translate this to native query syntax (Lucene field queries, Cypher WHERE clauses, etc.) and fall back to InMemoryPropertyFilter for post-filtering when native filtering isn't available.

Limitation: Nested Properties Not Supported

Filters operate on top-level properties only. Nested property paths like "address.city" or "metadata.source" are not supported. The filter key must match a direct key in the target map or a top-level property on the target object.

Kotlin users can use operator syntax for combining filters:

val filter = (eq("owner", "alice") and gte("score", 0.8)) or eq("role", "admin")
val excluded = !eq("status", "deleted")

Inheritors

Types

And

data class And(val filters: List<PropertyFilter>) : PropertyFilter

Logical AND: all filters must match

Companion

object Companion

Contains

data class Contains(val key: String, val value: String) : PropertyFilter

Contains substring: propertieskey.toString().contains(value)

ContainsIgnoreCase

data class ContainsIgnoreCase(val key: String, val value: String) : PropertyFilter

Contains substring (case-insensitive): propertieskey.toString().lowercase().contains(value.lowercase())

EndsWith

data class EndsWith(val key: String, val value: String) : PropertyFilter

Ends with suffix: propertieskey.toString().endsWith(value)

data class Eq(val key: String, val value: Any) : PropertyFilter

Equals: propertieskey == value

EqIgnoreCase

data class EqIgnoreCase(val key: String, val value: String) : PropertyFilter

Equals (case-insensitive): propertieskey.toString().lowercase() == value.lowercase()

data class Gt(val key: String, val value: Number) : PropertyFilter

Greater than: propertieskey value

Gte

data class Gte(val key: String, val value: Number) : PropertyFilter

Greater than or equal: propertieskey>= value

data class In(val key: String, val values: List<Any>) : PropertyFilter

In list: propertieskey in values

data class Like(val key: String, val pattern: String) : PropertyFilter

Regex pattern match: propertieskey.toString().matches(Regex(pattern))

data class Lt(val key: String, val value: Number) : PropertyFilter

Less than: propertieskey< value

Lte

data class Lte(val key: String, val value: Number) : PropertyFilter

Less than or equal: propertieskey<= value

data class Ne(val key: String, val value: Any) : PropertyFilter

Not equals: propertieskey != value

Nin

data class Nin(val key: String, val values: List<Any>) : PropertyFilter

Not in list: propertieskey not in values

Not

data class Not(val filter: PropertyFilter) : PropertyFilter

Logical NOT: filter must not match

data class Or(val filters: List<PropertyFilter>) : PropertyFilter

Logical OR: at least one filter must match

StartsWith

data class StartsWith(val key: String, val value: String) : PropertyFilter

Starts with prefix: propertieskey.toString().startsWith(value)

Functions

and

open infix fun and(other: PropertyFilter): PropertyFilter

Logical AND infix: filter1 and filter2

not

open operator fun not(): PropertyFilter

Logical NOT operator: !filter

open infix fun or(other: PropertyFilter): PropertyFilter

Logical OR infix: filter1 or filter2