pub struct CodecSidecar { /* private fields */ }Expand description
Per-collection encoded-vector storage keyed by surrogate id, paired with the trained codec. Encoded vectors live alongside (not inside) the HNSW index — HNSW keeps full-precision vectors for graph traversal; the sidecar is consulted only during base-layer rerank.
Implementations§
Source§impl CodecSidecar
impl CodecSidecar
pub fn new(codec: Arc<dyn RerankCodec>) -> Self
pub fn codec_name(&self) -> CodecName
Sourcepub fn encode_and_insert(
&mut self,
id: u32,
vector: &[f32],
) -> Result<(), RerankError>
pub fn encode_and_insert( &mut self, id: u32, vector: &[f32], ) -> Result<(), RerankError>
Encode a vector and insert it under id. Overwrites any existing entry.
pub fn remove(&mut self, id: u32)
pub fn get(&self, id: u32) -> Option<&[u8]>
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
Sourcepub fn to_bytes(&self) -> Result<Vec<u8>, RerankError>
pub fn to_bytes(&self) -> Result<Vec<u8>, RerankError>
Serialize the sidecar (codec state + all encoded vectors) to bytes.
Format: [NDCC (4 bytes)][version: u8 = 1][msgpack payload]
Sourcepub fn from_bytes(bytes: &[u8]) -> Result<Self, RerankError>
pub fn from_bytes(bytes: &[u8]) -> Result<Self, RerankError>
Deserialize a sidecar from bytes produced by Self::to_bytes.
pub fn prepare_query(&self, query: &[f32]) -> Result<PreparedQuery, RerankError>
Sourcepub fn distance_prepared(
&self,
prepared: &PreparedQuery,
id: u32,
) -> Result<Option<f32>, RerankError>
pub fn distance_prepared( &self, prepared: &PreparedQuery, id: u32, ) -> Result<Option<f32>, RerankError>
Compute distance from a prepared query to the encoded vector at id.
Returns Ok(None) when the id isn’t in the sidecar (lost / not yet
encoded); returns the distance otherwise.
Auto Trait Implementations§
impl !RefUnwindSafe for CodecSidecar
impl !UnwindSafe for CodecSidecar
impl Freeze for CodecSidecar
impl Send for CodecSidecar
impl Sync for CodecSidecar
impl Unpin for CodecSidecar
impl UnsafeUnpin for CodecSidecar
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.