Struct Filter 

pub struct Filter {
    pub equals: HashMap<String, Value>,
    pub in: HashMap<String, Vec<Value>>,
    pub gte: HashMap<String, f64>,
    pub lte: HashMap<String, f64>,
}

Metadata filter applied to similarity search.

All conditions on a filter combine with AND semantics. An empty filter matches everything (the same as no filter at all).

Fields

equals: HashMap<String, Value>

Metadata key/value pairs every result must match exactly. Compared with serde_json == after both sides are coerced to serde_json::Value.

in: HashMap<String, Vec<Value>>

Metadata keys whose values must appear in the listed set. Equivalent to metadata[key] in values.

gte: HashMap<String, f64>

Numeric metadata keys with >= lower bound.

lte: HashMap<String, f64>

Numeric metadata keys with <= upper bound.

Implementations

impl Filter

pub fn new() -> Self

Empty filter (matches everything).

pub fn equals(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Builder: require metadata[key] == value.

pub fn one_of<I, V>(self, key: impl Into<String>, values: I) -> Self

where I: IntoIterator<Item = V>, V: Into<Value>,

Builder: require metadata[key] to be one of values.

pub fn gte(self, key: impl Into<String>, n: f64) -> Self

Builder: require metadata[key] >= n (numeric).

pub fn lte(self, key: impl Into<String>, n: f64) -> Self

Builder: require metadata[key] <= n (numeric).

pub fn is_empty(&self) -> bool

True if no conditions are set.

pub fn matches(&self, metadata: &HashMap<String, Value>) -> bool

Whether metadata satisfies every condition on this filter.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Filter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Filter

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Filter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.