Skip to main content

VectorStoreField

Struct VectorStoreField 

Source
pub struct VectorStoreField {
    pub field_type: FieldType,
    pub name: String,
    pub storage_name: Option<String>,
    pub type_: Option<String>,
    pub is_indexed: Option<bool>,
    pub is_full_text_indexed: Option<bool>,
    pub dimensions: Option<usize>,
    pub index_kind: Option<IndexKind>,
    pub distance_function: Option<DistanceFunction>,
}
Expand description

One field in a vector-store collection.

Build with VectorStoreField::key, VectorStoreField::data or VectorStoreField::vector, then refine with the builder methods — mirroring upstream’s three __init__ overloads, but with the field-type-specific options only reachable on the variant that accepts them.

Fields§

§field_type: FieldType§name: String

The field’s name on the record.

§storage_name: Option<String>

The field’s name in the store, when it differs from Self::name.

§type_: Option<String>

Provider-specific type hint (e.g. "str", "int"), passed through to collection creation.

§is_indexed: Option<bool>

Whether the store should index this field for filtering.

§is_full_text_indexed: Option<bool>

Whether the store should index this field for full-text search.

§dimensions: Option<usize>

Vector fields only: the embedding’s dimensionality.

§index_kind: Option<IndexKind>

Vector fields only.

§distance_function: Option<DistanceFunction>

Vector fields only.

Implementations§

Source§

impl VectorStoreField

Source

pub fn key(name: impl Into<String>) -> VectorStoreField

The collection’s primary key field.

Source

pub fn data(name: impl Into<String>) -> VectorStoreField

An ordinary payload field.

Source

pub fn vector(name: impl Into<String>, dimensions: usize) -> VectorStoreField

An embedding field of dimensions dimensions.

Source

pub fn with_storage_name( self, storage_name: impl Into<String>, ) -> VectorStoreField

Store this field under a different name than the record uses.

Source

pub fn with_type(self, type_: impl Into<String>) -> VectorStoreField

Provider-specific type hint.

Source

pub fn indexed(self) -> VectorStoreField

Index this field for filtering.

Source

pub fn full_text_indexed(self) -> VectorStoreField

Index this field for full-text search.

Source

pub fn with_index_kind(self, kind: IndexKind) -> VectorStoreField

Vector fields only; ignored by providers on other field types.

Source

pub fn with_distance_function( self, function: DistanceFunction, ) -> VectorStoreField

Vector fields only; ignored by providers on other field types.

Source

pub fn effective_storage_name(&self) -> &str

The name this field is stored under: Self::storage_name when set, otherwise Self::name.

Trait Implementations§

Source§

impl Clone for VectorStoreField

Source§

fn clone(&self) -> VectorStoreField

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VectorStoreField

Source§

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

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

impl<'de> Deserialize<'de> for VectorStoreField

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for VectorStoreField

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for VectorStoreField

Source§

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. Read more
Source§

impl StructuralPartialEq for VectorStoreField

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more