Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
    pub query: QueryCapability,
    pub correlation: bool,
    pub graph: bool,
    pub embeddings_fingerprint: Option<String>,
    pub verify: bool,
    pub representations: Vec<Representation>,
    pub resolve: bool,
}
Expand description

What a provider can do, negotiated at handshake time.

Every field here is a capability a host can actually exercise. upsert and subscribe were removed in the pre-freeze sweep because neither had a wire method, a host API, a schema entry, or a conformance check — a provider could declare a capability no host on earth could use. See ADR 0004, and the design sketches under docs/sketches/ that keep both doors open for a 1.x additive minor.

Unknown fields are ignored on deserialization, so a provider still emitting the removed flags handshakes successfully — the removal breaks the Rust API, not the wire.

Fields§

§query: QueryCapability§correlation: bool

The provider echoes the id of a request on its reply, so a host may pipeline concurrent exchanges over one connection (SPEC.md §H4).

Negotiated explicitly rather than discovered by observation. A host that sent an id speculatively could not tell a provider that does not implement correlation from one that implements it incorrectly, which makes the guarantee uncheckable — and an uncheckable guarantee is the thing this protocol exists to avoid. A provider that does not declare it is queried in lock-step and stays fully conformant.

§graph: bool

The provider serves FrameKind::Graph frames and populates Relation edges. Gates the graph conformance checks (SPEC.md §G1–G3).

§embeddings_fingerprint: Option<String>

Identifies the embedding space this provider indexes, so a host never sends it a vector from a different model.

Format: <model-id>/<dimensions>[/<normalization>], e.g. bge-small-en-v1.5/384/l2. Matching is exact — see embedding_fingerprints_match and SPEC.md §E1.

§verify: bool

Whether this provider answers context/verify — pull-based revalidation of frames a host already holds (docs/context-reuse.md §4). Defaults to false, so a provider that says nothing is treated as not supporting it and the host falls back to re-querying.

§representations: Vec<Representation>

The frame representations this provider can return (build prompt §“Capability negotiation”). Empty ⇒ full only, the legacy default, so a provider that says nothing keeps working.

§resolve: bool

Whether this provider answers context/resolve for a frame’s content_ref. Compact/reference support implies resolve support (representations_consistent).

Implementations§

Source§

impl Capabilities

Source

pub fn offered_representations(&self) -> Vec<Representation>

The representations this provider actually offers, defaulting to [full] when it advertised none (the legacy contract).

Source

pub fn representations_consistent(&self) -> bool

Whether the advertised representations are honest: compact/reference both hand the host a content_ref to rehydrate, so a provider that cannot resolve must not advertise them. A provider offering only full is always consistent.

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

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 Capabilities

Source§

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

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

impl Default for Capabilities

Source§

fn default() -> Capabilities

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

impl<'de> Deserialize<'de> for Capabilities

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 Capabilities

Source§

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

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

impl StructuralPartialEq for Capabilities

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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