Enum MetadataFilter 

#[non_exhaustive]
pub enum MetadataFilter {
    Eq {
        field: String,
        value: Value,
    },
    Ne {
        field: String,
        value: Value,
    },
    Gt {
        field: String,
        value: Value,
    },
    Gte {
        field: String,
        value: Value,
    },
    Lt {
        field: String,
        value: Value,
    },
    Lte {
        field: String,
        value: Value,
    },
    In {
        field: String,
        values: Vec<Value>,
    },
    NotIn {
        field: String,
        values: Vec<Value>,
    },
    And(Vec<MetadataFilter>),
    Or(Vec<MetadataFilter>),
    Not(Box<MetadataFilter>),
}

Metadata filter for vector search. Applied as a pre-filter (Roaring bitmap) or post-filter depending on selectivity.

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.

Eq

Field equals a specific value.

Fields

field: String

value: Value

Ne

Field does not equal a specific value.

Fields

field: String

value: Value

Gt

Field is greater than a value (numeric/string).

Fields

field: String

value: Value

Gte

Field is greater than or equal to a value.

Fields

field: String

value: Value

Lt

Field is less than a value.

Fields

field: String

value: Value

Lte

Field is less than or equal to a value.

Fields

field: String

value: Value

In

Field value is in a set.

Fields

field: String

values: Vec<Value>

NotIn

Field value is not in a set.

Fields

field: String

values: Vec<Value>

And(Vec<MetadataFilter>)

Logical AND of multiple filters.

Or(Vec<MetadataFilter>)

Logical OR of multiple filters.

Not(Box<MetadataFilter>)

Logical NOT of a filter.

Implementations

impl MetadataFilter

pub fn eq(field: impl Into<String>, value: impl Into<Value>) -> MetadataFilter

Shorthand: field == value.

pub fn and(filters: Vec<MetadataFilter>) -> MetadataFilter

Shorthand: combine filters with AND.

pub fn or(filters: Vec<MetadataFilter>) -> MetadataFilter

Shorthand: combine filters with OR.

Trait Implementations

impl Clone for MetadataFilter

fn clone(&self) -> MetadataFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataFilter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataFilter

fn deserialize<__D>( __deserializer: __D, ) -> Result<MetadataFilter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetadataFilter

fn eq(&self, other: &MetadataFilter) -> 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 Serialize for MetadataFilter

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetadataFilter