Enum Key 

pub enum Key {
    Document,
    Embedding,
    Metadata,
    Score,
    MetadataField(String),
}

Variants

Document

Embedding

Metadata

Score

MetadataField(String)

Implementations

impl Key

pub fn field(name: impl Into<String>) -> Self

Create a Key for a metadata field

pub fn eq<T: Into<MetadataValue>>(self, value: T) -> Where

Equality: Key::field(“status”).eq(“active”)

pub fn ne<T: Into<MetadataValue>>(self, value: T) -> Where

Not equal: Key::field(“status”).ne(“deleted”)

pub fn gt<T: Into<MetadataValue>>(self, value: T) -> Where

Greater than: Key::field(“score”).gt(0.5)

pub fn gte<T: Into<MetadataValue>>(self, value: T) -> Where

Greater than or equal: Key::field(“score”).gte(0.5)

pub fn lt<T: Into<MetadataValue>>(self, value: T) -> Where

Less than: Key::field(“score”).lt(0.9)

pub fn lte<T: Into<MetadataValue>>(self, value: T) -> Where

Less than or equal: Key::field(“score”).lte(0.9)

pub fn is_in<I, T>(self, values: I) -> Where

where I: IntoIterator<Item = T>, Vec<T>: Into<MetadataSetValue>,

In set: Key::field(“year”).is_in(vec![2023, 2024, 2025]) Also accepts arrays, slices, and any iterator

pub fn not_in<I, T>(self, values: I) -> Where

where I: IntoIterator<Item = T>, Vec<T>: Into<MetadataSetValue>,

Not in set: Key::field(“status”).not_in(vec![“deleted”, “archived”]) Also accepts arrays, slices, and any iterator

pub fn contains<S: Into<String>>(self, text: S) -> Where

Contains text: Key::Document.contains(“search term”)

pub fn not_contains<S: Into<String>>(self, text: S) -> Where

Does not contain text: Key::Document.not_contains(“exclude term”)

pub fn regex<S: Into<String>>(self, pattern: S) -> Where

Regex match: Key::field(“email”).regex(r“^.*@example.com$“)

pub fn not_regex<S: Into<String>>(self, pattern: S) -> Where

Negative regex match: Key::field(“email”).not_regex(r“^.*@spam.com$“)

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&str> for Key

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Key

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Key

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

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Key

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Key

impl StructuralPartialEq for Key