Struct VectorRecord 

pub struct VectorRecord { /* private fields */ }

A vector store record.

Implementations

impl VectorRecord

pub fn new(id: VectorId, embedding: Embedding) -> VectorRecord

Creates a vector record.

pub fn with_dimension( self, dimension: VectorDimension, ) -> Result<VectorRecord, InvalidDimensionError>

Sets and validates the expected dimension.

pub const fn with_similarity_metric( self, similarity_metric: SimilarityMetric, ) -> VectorRecord

Sets the similarity metric.

pub fn with_metadata(self, metadata: VectorMetadata) -> VectorRecord

Sets vector metadata.

pub const fn id(&self) -> &VectorId

Returns the record identifier.

pub const fn embedding(&self) -> &Embedding

Returns the embedding.

pub const fn dimension(&self) -> Option<VectorDimension>

Returns the validated dimension, if present.

pub const fn similarity_metric(&self) -> Option<SimilarityMetric>

Returns the similarity metric, if present.

pub const fn metadata(&self) -> &VectorMetadata

Returns vector metadata.

Trait Implementations

impl Clone for VectorRecord

fn clone(&self) -> VectorRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorRecord

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

Formats the value using the given formatter.

impl PartialEq for VectorRecord

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