Expand description
The supercode ontology (docs/ONTOLOGY.md): the one model under sessions and the
orchestration world.
The supercode ontology (docs/ONTOLOGY.md): the one model under the
session spine and the orchestration world. Lower layers never import upper
ones — this module depends on nothing above it except the session layer’s
crate::session::OrchestrationNouns wire block, which a Binding
projects onto.
- identity —
HarnessId, the one list every registry keys on - surface —
SurfaceKey,Trigger,Recurrence,CrossSurface,WorkspaceRef - binding —
Binding, the one conversation record, decoded once per source - fidelity —
Fidelity, one vocabulary for what a codec gave up - residue —
Residue, retained source fields (distinct from measured loss) - secret —
SecretRef/Vault: credentials are named, never held - codec —
ArtifactFidelity,WorldCodec: the contract both halves obey
Modules§
- binding
- The one conversation record (
docs/ONTOLOGY.md§2.2): a conversation reached on a surface, routed to a profile, run by a worker, with a lifecycle. A Hermessessionsrow, an OpenClaw session key and an orchestratorbindingsrow each decode to it ONCE, here; the discovery row’s nouns are its projection (Binding::nouns). - codec
- The codec contract both pieces obey (
docs/ONTOLOGY.md§2.5): every artifact a codec reads or writes names theFidelityit reached and, only atFidelity::Semantic, the loss it accepted. The session half is thecrate::Sessionloaders and writers; the world half implementsWorldCodec. - fidelity
- Behavioral translation-fidelity measurement.
- identity
- Harness identity: the one list every registry, ledger and codec keys on.
- residue
- Retained residue: source fields the model does not interpret, kept
verbatim and re-emitted on the diagonal. Distinct from the MEASURED loss of
an export-and-reload (
crate::FidelityResidue); this is what a codec keeps, that is what a measurement counts. - secret
- Secret references. A credential is named, never held: the model carries
WHERE a value lives (
docs/ORCHESTRATOR-IR.md§1 rule 3), and a vault resolves it at the moment of use. - surface
- The conversation-on-a-surface nouns (ORCH-3 / ORCH-6): where a
conversation is reached, why it exists, which job it belongs to, where it
moved. They are the vocabulary a
crate::ontology::Bindingis made of and the wire block every discovery row carries.
Structs§
- Artifact
Fidelity - What one artifact reached on the way in or out.
- Binding
- The conversation record.
- Cross
Surface - ORCH-3: a conversation moved to another surface (Hermes
handoff_*). - Fidelity
Metric - Result of measuring one actual translation cell.
- Fidelity
Residue - Measured residue of one actual export/reload cell.
- Handoff
- A conversation moved (or moving) to another surface — Hermes
handoff_*. - Harness
Id - Extensible identifier for a coding harness.
- Hermes
Session Row - One Hermes
sessionsrow, the columns a binding is made of. Empty strings are read as absent by the decoder. - Orchestrator
Binding Row - One row of an orchestrator profile’s
bindingstable, as read. - Recurrence
- ORCH-3: the job a recurring session belongs to.
- Residue
- Unmodeled source fields, keyed by the source’s own field name.
- Surface
Key - ORCH-3: the conversation identity on a surface. Full tuple on a channel;
degenerate (all
None) on a terminal. - Worker
- The worker session a binding points at.
- Workspace
Ref - ORCH-6: the wire form of [
SessionMeta::workspace] — a typed workspace carried on a discovered or loaded row. The D2 precedence that produces it lives inworkspace()(ORCH-3’s contract); this only names the result.
Enums§
- EndReason
- Why a binding ended (
docs/ORCHESTRATOR-IR.md§2.5). - Fidelity
- How faithfully a reconstruction reproduces its source.
- Secret
Ref - Where a secret value lives. Wire form:
{"env": NAME}or{"dotenv": KEY}. - Trigger
- ORCH-3: why a session exists (the trigger noun;
docs/HERMES-IDEAL-SUPPORT-DESIGN.md§3). - Workspace
Kind - ORCH-3 / UNI-9: the typed workspace, derived — never stored.
Traits§
- Vault
- Resolves references at use; never part of a serialized model.
- World
Codec - A harness’s operational home compiled into a world value and back.
Functions§
- core_
messages - Canonical messages participating in cross-format fidelity scoring.
- hermes_
cron_ job_ id - Hermes cron fire session ids are minted as
cron_<job_id>_<YYYYMMDD_HHMMSS>(cron/scheduler.py); recover the job id. - hermes_
source_ for_ binding - The Hermes
sessions.sourceword for a binding (inverse ofhermes_trigger_for_source): a channel conversation’s source is its platform; the rest are the words Hermes’s own doors mint. - hermes_
trigger_ for_ source - Hermes
sessions.source→ trigger. Cron fires are taggedcron; the CLI, TUI and ACP adapter are human surfaces;api_serveris the HTTP API;webhookis inbound; every other value is a messaging platform. - measure_
fidelity - Measure an export/reload cell without applying a regression floor.
- messages_
equal - Compare semantic message fields shared by the supported harnesses.
- messages_
equal_ multimodal - Compare semantics plus multimodal parts and tool names.
- parse_
hermes_ session_ key - Parse a Hermes gateway session key
(
agent:<profile|main>:<platform>:<chat_type>[:<chat_id>][:<thread_id>][:<participant>]). Returns the surface and the profile namespace (Noneformain). - parse_
openclaw_ session_ key - Parse an OpenClaw gateway session key. Shapes (
docs/channels/channel-routing.md,docs/automation/cron-jobs.md,docs/cli/acp.mdupstream):agent:<id>:main,agent:<id>:<channel>:<group|channel>:<cid>[:thread|topic:<tid>],cron:<jobId>,hook:<name>:<id>,acp-bridge:<uuid>. - render_
hermes_ session_ key - Render a surface as Hermes’s
build_session_keyform, whichparse_hermes_session_keyreads back unchanged. - render_
openclaw_ session_ key - Render an OpenClaw gateway session key for a binding under an agent
(inverse of
parse_openclaw_session_key): a cron fire iscron:<jobId>, a conversation is the agent shape. - replay_
eligible - The replayable subsequence of a canonical transcript.
- replay_
excluded - Whether a source message was intentionally outside the replayable slice.