Enum VectorFilter 

#[non_exhaustive]
pub enum VectorFilter {
    All,
    Eq {
        key: String,
        value: Value,
    },
    Lt {
        key: String,
        value: Value,
    },
    Lte {
        key: String,
        value: Value,
    },
    Gt {
        key: String,
        value: Value,
    },
    Gte {
        key: String,
        value: Value,
    },
    Range {
        key: String,
        min: Value,
        max: Value,
    },
    In {
        key: String,
        values: Vec<Value>,
    },
    Exists {
        key: String,
    },
    And(Vec<Self>),
    Or(Vec<Self>),
    Not(Box<Self>),
}

Predicate against Document::metadata used by VectorStore::search_filtered. Backends translate this into their native filter language (pgvector WHERE, qdrant Filter, lancedb where); backends that cannot honour a given variant fall back to filterless search and emit a LossyEncode-style warning at the operator layer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

All

Always passes — useful as identity inside And/Or chains.

Eq

metadata.<key> == value.

Fields

key: String

Metadata key path (dotted notation).

value: Value

Comparison value.

Lt

metadata.<key> < value. Numeric semantics; non-numeric operands produce an empty result set.

Fields

key: String

Metadata key path.

value: Value

Comparison value (numeric).

Lte

metadata.<key> <= value. Inclusive variant of Self::Lt.

Fields

key: String

Metadata key path.

value: Value

Comparison value (numeric).

Gt

metadata.<key> > value.

Fields

key: String

Metadata key path.

value: Value

Comparison value (numeric).

Gte

metadata.<key> >= value. Inclusive variant of Self::Gt.

Fields

key: String

Metadata key path.

value: Value

Comparison value (numeric).

Range

min <= metadata.<key> <= max. Closed interval — backends that natively support range queries can push this down as a single index probe instead of decomposing into And(Gte, Lte).

Fields

key: String

Metadata key path.

min: Value

Lower bound (inclusive). Numeric.

max: Value

Upper bound (inclusive). Numeric.

In

metadata.<key> is one of values. Empty values matches no documents — equivalent to a no-op filter that can be used to short-circuit zero-result queries without consulting the index.

Fields

key: String

Metadata key path.

values: Vec<Value>

Allowed values.

Exists

metadata.<key> is present (any value, including null). Distinguishes “field unset” from “field set to null”.

Fields

key: String

Metadata key path.

And(Vec<Self>)

All children must match.

Or(Vec<Self>)

At least one child must match.

Not(Box<Self>)

Negate the inner filter.

Trait Implementations

impl Clone for VectorFilter

fn clone(&self) -> VectorFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VectorFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VectorFilter

fn eq(&self, other: &VectorFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VectorFilter