Skip to main content

VectorStoreCollectionDefinition

Struct VectorStoreCollectionDefinition 

Source
pub struct VectorStoreCollectionDefinition { /* private fields */ }
Expand description

The shape of one vector-store collection: its fields, and the accessors a provider needs to build requests from them.

fields is private and every constructor validates, including deserialization: Self::key_field and friends are documented as infallible, and they can only honour that if an invalid definition cannot exist. A definition loaded from configuration goes through the same checks as one built in code, so a missing key field is a deserialization error rather than a panic at first use.

Implementations§

Source§

impl VectorStoreCollectionDefinition

Source

pub fn new( fields: Vec<VectorStoreField>, ) -> Result<VectorStoreCollectionDefinition, Error>

Build and validate a definition.

Validation is at construction rather than at first use because every failure it catches — no key, two keys, duplicate names, a vector field with no dimensions — produces a collection that cannot work at all, and a provider would otherwise surface it as an opaque error from the service on the first upsert. Mirrors upstream’s _validate.

Source

pub fn fields(&self) -> &[VectorStoreField]

The declared fields, in declaration order.

Read-only: mutating them could invalidate the definition, which the infallible accessors below rely on not happening. Build a new definition with Self::new instead.

Source

pub fn try_get_field(&self, name: &str) -> Option<&VectorStoreField>

The field declared under name, or None when the collection has no such field.

Lookup is by logical name, which is what a filters::Filter carries.

Source

pub fn storage_name_for(&self, name: &str) -> Option<String>

Map a logical field name onto the storage name a record is keyed by, for FilterExpression::matches.

Returns None for a field the collection does not declare, which matches reports as an error rather than a non-match.

Source

pub fn names(&self) -> Vec<&str>

Every field name, in declaration order.

Source

pub fn storage_names(&self) -> Vec<&str>

Every storage name, in declaration order.

Source

pub fn key_field(&self) -> &VectorStoreField

The key field. Infallible: Self::new rejects a definition without exactly one.

Source

pub fn key_field_storage_name(&self) -> &str

The key field’s storage name.

Source

pub fn vector_fields(&self) -> Vec<&VectorStoreField>

Every vector field.

Source

pub fn data_fields(&self) -> Vec<&VectorStoreField>

Every data field.

Source

pub fn try_get_vector_field( &self, name: Option<&str>, ) -> Option<&VectorStoreField>

Look up a vector field by name, or the only one when name is None.

Returns None when the name does not match a vector field, and also when name is None and the collection has several — there is no safe default to pick, and searching the wrong embedding returns confident nonsense rather than an error.

Source

pub fn get_names( &self, include_vector_fields: bool, include_key_field: bool, ) -> Vec<&str>

Field names, filtered. Mirrors upstream’s get_names.

Source

pub fn get_storage_names( &self, include_vector_fields: bool, include_key_field: bool, ) -> Vec<&str>

Storage names, filtered. Mirrors upstream’s get_storage_names.

Source

pub fn to_storage(&self, record: &Value) -> Result<Value, Error>

Rename a record’s fields from logical names to storage names.

Fields the definition does not declare are dropped rather than passed through, so a stray key cannot reach the store and be rejected (or, worse, silently persisted outside the schema).

Source

pub fn from_storage( &self, stored: &Value, include_vectors: bool, ) -> Result<Value, Error>

Rename a stored record’s fields back to logical names, optionally dropping vector fields (which are large and rarely wanted on read).

Trait Implementations§

Source§

impl Clone for VectorStoreCollectionDefinition

Source§

fn clone(&self) -> VectorStoreCollectionDefinition

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 VectorStoreCollectionDefinition

Source§

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

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

impl<'de> Deserialize<'de> for VectorStoreCollectionDefinition

Source§

fn deserialize<D>( deserializer: D, ) -> Result<VectorStoreCollectionDefinition, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

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

impl PartialEq for VectorStoreCollectionDefinition

Source§

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

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 VectorStoreCollectionDefinition

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