Skip to main content

VectorConfig

Struct VectorConfig 

Source
pub struct VectorConfig {
    pub dimensions: usize,
    pub distance: Distance,
    pub m: Option<u32>,
    pub ef_construction: Option<u32>,
    pub ef_search: Option<u32>,
    pub lazy_embedding: bool,
    pub embedding_model: Option<String>,
    pub compression: Option<CompressionConfig>,
}
Expand description

Configuration for a vector collection, using a builder-style API that mirrors VectorConfig in the Python SDK.

Fields§

§dimensions: usize

Number of dimensions in each embedding.

§distance: Distance

Distance metric (default: Distance::Cosine).

§m: Option<u32>

HNSW M parameter – connections per node (default: library default).

§ef_construction: Option<u32>

HNSW ef_construction – build quality (default: library default).

§ef_search: Option<u32>

HNSW ef_search – query quality (default: library default).

§lazy_embedding: bool

Enable lazy embedding mode (store text, embed on demand).

§embedding_model: Option<String>

Model name to use for lazy embedding.

§compression: Option<CompressionConfig>

Optional vector compression settings.

Implementations§

Source§

impl VectorConfig

Source

pub fn new(dimensions: usize) -> Self

Create a minimal config with the given number of dimensions.

Source

pub fn with_distance(self, distance: Distance) -> Self

Set the distance metric.

Source

pub fn with_m(self, m: u32) -> Self

Set the HNSW M parameter.

Source

pub fn with_ef_construction(self, ef: u32) -> Self

Set the ef_construction parameter.

Set the ef_search parameter.

Source

pub fn with_lazy_embedding(self, model: impl Into<String>) -> Self

Enable lazy embedding using an embedding model name.

Source

pub fn with_compression(self, config: CompressionConfig) -> Self

Set a custom compression configuration.

Source

pub fn with_delta_compression(self) -> Self

Enable delta compression with default settings.

Source

pub fn with_quantized_compression(self) -> Self

Enable quantised-delta compression with default settings.

Source

pub fn to_json(&self) -> String

Serialise to JSON for passing to the native C API.

Trait Implementations§

Source§

impl Clone for VectorConfig

Source§

fn clone(&self) -> VectorConfig

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 VectorConfig

Source§

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

Formats the value using the given formatter. 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.