Skip to main content

ShippedEmbedding

Struct ShippedEmbedding 

Source
pub struct ShippedEmbedding {
    pub memory_id: String,
    pub model: String,
    pub dim: usize,
    pub vector: Vec<f32>,
}
Expand description

#1566 / #1579 B1 — embed-once-replicate-vector. A source-side embedding shipped alongside its memory row in the federation /sync/push payload (wire key crate::models::field_names::EMBEDDINGS).

§Wire contract

  • The array rides INSIDE the JSON body that sync::post_once serialises once and signs (X-Memory-Sig over the exact body bytes, nonce-bound per #922), so the vector’s TRANSIT integrity is covered by the same Ed25519 signature + replay protection as the memory rows themselves: a vector altered IN FLIGHT invalidates the signature.

    Trust boundary (#1584). The signature attests the SENDER and that the bytes were not altered in transit — it does NOT attest that the f32 values are a well-formed embedding, nor that the vector honestly embeds the shipped (title, content). The content↔vector honesty is an inherent limit of shipping sender-computed vectors (the receiver trusts the enrolled peer not to mislabel). The VALUE DOMAIN, however, is receiver-enforced: sanitize_shipped_vector rejects non-finite components and L2-normalizes the rest before storage, so a peer cannot poison cosine ranking with a NaN/±Inf or high-magnitude vector. (Non-finite components additionally cannot cross the JSON wire at all — serde serialises them to null and the strict Vec<f32> decoder rejects it with 400.)

  • Decode is TOLERANT of absence: the receiver’s SyncPushBody field defaults to an empty vec, so pushes from older peers (no embeddings key) and pushes to older peers (unknown fields are ignored — request structs are deliberately permissive per #1052) both interoperate. The fleet swaps as one, but the protocol must not hard-require the field.

§Receive contract

The receiver stores vector directly ONLY when dim matches its own configured embedder dimensionality (the same dim-safety property recall’s H7 CosineComparison::DimensionMismatch exists for). On mismatch — or when no vector was shipped — the row falls back to the deferred background-embed path; either way the receiver acks after commit WITHOUT a synchronous embed (~1s/row via ollama pre-#1566, which rode inside the sender’s quorum-ack window and drove the deadline_exceeded → DLQ cascade).

Fields§

§memory_id: String

Id of the memory row (in the same push) this vector belongs to.

§model: String

Human-readable id of the model that produced the vector (sender’s Embedder::model_description()). Observability only — the dim gate is the load-bearing safety check.

§dim: usize

Dimensionality the sender claims for vector. Receivers verify dim == vector.len() AND dim == local embedder dim before storing the vector directly.

§vector: Vec<f32>

The embedding vector itself.

Implementations§

Source§

impl ShippedEmbedding

Source

pub fn new(memory_id: String, model: String, vector: Vec<f32>) -> Self

Build a shipped embedding for memory_id from a freshly computed vector; dim is derived from the vector length so the two can never disagree on the sender side.

Trait Implementations§

Source§

impl Clone for ShippedEmbedding

Source§

fn clone(&self) -> ShippedEmbedding

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 ShippedEmbedding

Source§

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

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

impl<'de> Deserialize<'de> for ShippedEmbedding

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl Serialize for ShippedEmbedding

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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