Skip to main content

MetadataFilter

Struct MetadataFilter 

Source
pub struct MetadataFilter {
    pub field: String,
    pub condition: String,
    pub value: Value,
}
Expand description

A filter on a metadata field, used in [Client::vector_search_filtered].

Supported conditions match the Python SDK: eq, ne, gt, gte, lt, lte, in, not_in, contains, starts_with, ends_with.

Fields§

§field: String

The metadata field name to filter on.

§condition: String

The condition type (e.g. "eq", "gt", "in").

§value: Value

The comparison value as a JSON value.

Implementations§

Source§

impl MetadataFilter

Source

pub fn new( field: impl Into<String>, condition: impl Into<String>, value: Value, ) -> Self

Create a new metadata filter.

Source

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

Equality filter shorthand.

Source

pub fn gt(field: impl Into<String>, value: Value) -> Self

Greater-than filter shorthand.

Source

pub fn lt(field: impl Into<String>, value: Value) -> Self

Less-than filter shorthand.

Source

pub fn to_json(&self) -> String

Serialise to a JSON string for passing to the C API.

Trait Implementations§

Source§

impl Clone for MetadataFilter

Source§

fn clone(&self) -> MetadataFilter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetadataFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for MetadataFilter

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.