Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/core / / Rule
Interface: Rule
Defined in: packages/core/src/types/memory.ts:220
Procedural rule - a standing order activated when its condition matches.
Stable
Extends
Properties
| Property | Modifier | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|
agentId? | readonly | string | - | - | MemoryRecord.agentId | packages/core/src/types/memory.ts:105 |
condition? | readonly | string | - | - | - | packages/core/src/types/memory.ts:223 |
createdAt | readonly | string | - | - | MemoryRecord.createdAt | packages/core/src/types/memory.ts:108 |
deletedAt? | readonly | string | Soft-delete tombstone. Append-only stores set this instead of removing rows, so prior history is preserved per principle 8. | - | MemoryRecord.deletedAt | packages/core/src/types/memory.ts:114 |
id | readonly | string | - | - | MemoryRecord.id | packages/core/src/types/memory.ts:102 |
kind | readonly | "procedural" | - | MemoryRecord.kind | - | packages/core/src/types/memory.ts:221 |
owner? | readonly | MemoryOwner | Principal dimension (D3). 'agent' on induced procedures. See MemoryOwner. | - | - | packages/core/src/types/memory.ts:267 |
priority | readonly | number | - | - | - | packages/core/src/types/memory.ts:224 |
provenance? | readonly | MemoryProvenance | Trust-provenance tag (P1-4 / P2-2). Induced procedures are 'induction'; author-defined rules omit it (treated first-party). See MemoryProvenance. | - | - | packages/core/src/types/memory.ts:250 |
sensitivity | readonly | Sensitivity | - | - | MemoryRecord.sensitivity | packages/core/src/types/memory.ts:107 |
sessionId? | readonly | string | - | - | MemoryRecord.sessionId | packages/core/src/types/memory.ts:106 |
status? | readonly | MemoryStatus | Retrieval-trust state (P1-4 / P2-2). Induced procedures land 'quarantined' and are excluded from activation (they must not drive actions) until validated; author-defined rules omit it (treated 'active'). See MemoryStatus. | - | - | packages/core/src/types/memory.ts:257 |
steps? | readonly | readonly string[] | Ordered, value-abstracted step sequence of an induced workflow (P2-2) - e.g. ['search for {product}', 'add {quantity} to cart', 'check out']. Present only on procedures distilled from successful agent trajectories; author-defined rules omit it. | - | - | packages/core/src/types/memory.ts:231 |
successCount? | readonly | number | Demonstrated-success counter (MCON-2 part 4). Incremented by ProceduralMemory.recordOutcome(...) on each verified successful reuse; drives promotion-by-demonstrated-success for quarantined induced procedures once the configured threshold is reached. Absent ⇒ never counted (adapters without the column). | - | - | packages/core/src/types/memory.ts:265 |
successCriteria? | readonly | readonly string[] | Voyager-style verifiable success criteria stored alongside an induced procedure (P2-2) so a reuse can self-verify its outcome instead of trusting the procedure blindly. Author-defined rules omit it. | - | - | packages/core/src/types/memory.ts:244 |
tags? | readonly | readonly string[] | - | - | MemoryRecord.tags | packages/core/src/types/memory.ts:115 |
text | readonly | string | - | - | - | packages/core/src/types/memory.ts:222 |
updatedAt? | readonly | string | - | - | MemoryRecord.updatedAt | packages/core/src/types/memory.ts:109 |
userId | readonly | string | - | - | MemoryRecord.userId | packages/core/src/types/memory.ts:104 |
variables? | readonly | readonly string[] | Names of the variables abstracted from the trajectory's concrete values (P2-2) - the {product} / {quantity} placeholders that appear in Rule.steps. Lets a reused procedure be re-bound to fresh arguments instead of replaying one run's literals. | - | - | packages/core/src/types/memory.ts:238 |