Skip to main content

IntentGraph

Struct IntentGraph 

Source
pub struct IntentGraph {
    pub v: u32,
    pub built_from_ts: u64,
    pub rev: u64,
    pub intents: Vec<Intent>,
    pub model: Option<String>,
    /* private fields */
}
Expand description

The usage-ranking read model — a set of query clusters with capability edges.

Built either in-process by the local learner or offline by Ratel Cloud; both emit the shape in protocol/v1. Attach one to a registry to add the usage arm to its ranking.

Fields§

§v: u32

Schema version. Always [GRAPH_VERSION] for a graph this build accepts.

§built_from_ts: u64

Epoch-millis of the newest event folded in. Provenance only — it says how current the graph is, and nothing reads it during ranking.

§rev: u64

Monotonic write counter, bumped once on every mutation (Self::observe, a centroid rebuild). Nothing reads it during ranking; it exists for the caller’s storage layer, which owns persistence (the graph is in-process only). Two uses: save-when-changed — persist only when rev differs from the last saved value; and stale-base detection — before overwriting a stored graph, compare its rev to the one you loaded, and if it advanced another writer got there first (single-writer is the supported model; this makes a clobber detectable, not merged). Carried in the wire form; an older graph without it loads as 0 and continues up.

§intents: Vec<Intent>

The clusters. Order is not significant.

§model: Option<String>

Fingerprint of the embedding model the centroids were built with, or None for a lexically-grown graph that has none.

Centroids are only comparable to a query embedded by the same model. This lets a consumer detect a model swap (GraphModelStatus) instead of cosine-ing across incompatible vector spaces. Stamped when the first centroid is grown, or by a producer (e.g. Ratel Cloud) that builds centroids offline.

Implementations§

Source§

impl IntentGraph

Source

pub fn from_json(json: &str) -> Result<Self, IntentGraphError>

Parse a graph from its JSON wire form.

§Errors

IntentGraphError::Malformed if the bytes are not the expected shape, or IntentGraphError::UnsupportedVersion if v is not 1.

Source

pub fn empty() -> Self

An empty graph at the current version — the starting state of a learner.

Source

pub fn len(&self) -> usize

Number of clusters.

Source

pub fn is_empty(&self) -> bool

Whether the graph holds no clusters — the cold-start state, in which it contributes no arm to any query.

Source

pub fn rev(&self) -> u64

The write counter — see Self::rev. Snapshot it after each save; a later value means unsaved learning, or another writer moved ahead of you.

Source

pub fn labeled(&self) -> Vec<Intent>

The clusters with their display fields materialized against the graph as it is now.

Labels are derived rather than stored for two reasons. c-TF-IDF ranks a term by how rare it is across the other clusters, so a value computed when a cluster was last written goes stale as soon as the graph grows. And computing them on write meant re-tokenizing every member of every cluster on every invocation — for strings ranking never reads.

The whole-corpus token index (per_cluster, global, avg) is built once here and shared by every cluster’s c-TF-IDF; building it inside each call made this quadratic in cluster count.

Trait Implementations§

Source§

impl Clone for IntentGraph

Source§

fn clone(&self) -> IntentGraph

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 IntentGraph

Source§

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

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

impl Default for IntentGraph

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for IntentGraph

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 PartialEq for IntentGraph

Source§

fn eq(&self, other: &IntentGraph) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for IntentGraph

Serializing materializes the derived display fields, so the wire form always carries labels computed against the graph being written — never a stale snapshot from whenever a cluster last happened to change.

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for IntentGraph

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> 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> 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> 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