Skip to main content

Module frame

Module frame 

Source
Expand description

ContextFrame — the unit of exchange between a CGP host and a provider. SPEC.md §6 fixes this exact shape; frames, never blobs, carry relevance, cost, and provenance so a budgeting, citing host can compose sources honestly.

§Frame representations (CGEP lifecycle, phase 2)

A frame states how it carries its content through Representation: full inlines the content (the legacy default), compact inlines a transformed rendering alongside a resolver handle, and reference carries no inline content at all — only a ContentRef and a canonical_content_hash so a host can rehydrate honestly and verifiably. representation absent means full, so pre-representation providers and stored frames deserialize unchanged.

Modules§

rel
The recommended relation vocabulary (SPEC.md §Graph).

Structs§

ContentRef
An opaque resolver handle for a compact/reference frame’s content.
ContextFrame
One context frame returned from context/query.
FrameEmbedding
The optional embedding carried by a frame. The vector itself is elidable — a host may want the fingerprint without the payload.
Provenance
One link in a frame’s provenance chain, ordered closest-to-source first.
Relation
A graph relation a frame participates in, surfaced with a human label — raw ids are never the primary identifier (SPEC.md §G1).
Transform
The transformation identity a compact frame applies to its source to produce the inline rendering, so a consumer knows what it is reading.

Enums§

ContentFidelity
The fidelity of a frame’s carried content relative to its canonical source. A missing value means exact for a legacy full frame.
FrameKind
What kind of thing a frame represents (SPEC.md §6).
InlineContentRequirement
Whether a frame’s point of use requires the content inline, or accepts a resolvable reference. Blocking constraints, guarded rules, ordered procedures, and executable contracts require inline content at their point of use; this keeps a reference choice from being confused with fidelity.
Representation
How a frame carries its content (CGEP lifecycle build prompt, §“ContextFrame representations”).