Struct VectorParams

pub struct VectorParams {
    pub size: u64,
    pub distance: i32,
    pub hnsw_config: Option<HnswConfigDiff>,
    pub quantization_config: Option<QuantizationConfig>,
    pub on_disk: Option<bool>,
}

Fields

size: u64

Size of the vectors

distance: i32

Distance function used for comparing vectors

hnsw_config: Option<HnswConfigDiff>

Configuration of vector HNSW graph. If omitted - the collection configuration will be used

quantization_config: Option<QuantizationConfig>

Configuration of vector quantization config. If omitted - the collection configuration will be used

on_disk: Option<bool>

If true - serve vectors from disk. If set to false, the vectors will be loaded in RAM.

Implementations

impl VectorParams

pub fn distance(&self) -> Distance

Returns the enum value of distance, or the default if the field is set to an invalid enum value.

pub fn set_distance(&mut self, value: Distance)

Sets distance to the provided enum value.

pub fn on_disk(&self) -> bool

Returns the value of on_disk, or the default value if on_disk is unset.

Trait Implementations

impl Clone for VectorParams

fn clone(&self) -> VectorParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VectorParams

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

Formats the value using the given formatter.

impl Default for VectorParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for VectorParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for VectorParams

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