Contextfulv0.23.0

Docs / Specification

contract read · 20-read.md · 21-memory.md · guide · card

Reading and memory — card

Generated by contextful-spec state from the contract’s files and spec/terms/read.toml; not authored.

Operations

OperationCoversClausesProved
registerRegistered relations, query tools, templates, the embedded SQL engine and HTTP transport.430
guardSQL validation, allowed relations, operator statements and template arguments.150
respondResponse fields, cell encoding, row and byte limits, truncation and diagnostic metadata.240
queryThe operator’s raw statement verb on the command line: its arguments, the relations it registers, its row bound and its output.110
referenceResolution of one stored citation through the caller’s registered relation, including the authenticated distinction between an erased source and an absent version.50
lineageThe applied dataflow graph narrowed to the relations one caller’s session registers, whole or walked from one table.60
retrieveCandidate rows for ranked retrieval: query tokens, relevance thresholds, per-table queries, deduplication and snippets.380
rankCandidate ordering by vector and lexical scores, timeframe and reported confidence.170
cacheLocality of the bytes a read touches, reuse of a resolved session and its connections, and reuse of a result across requests.150
resolve-pinResolution of a named published-model build at read time, and the state each response echoes.90
embedEmbedding implementations, stored model identifiers, query-model checks, build identity and missing-backend errors.60
as-of-joinPoint-in-time ASOF JOIN statements and templates that match rows by their availability timestamps.30
horizonReads under horizon: default time bounds, rejected arguments, hidden metadata, network restrictions and selection of indexes, embedding models and builds.100
subscribeCommitted-run notifications, durable replay, resume positions, queue limits and the subscription CLI.130
declareMemory table schemas, required columns, trust tiers, scopes and relation types.60
synthesizeClaim extraction, entity resolution, consolidation, evidence, deduplication, audit records and coverage gaps.100
reviseClaim replacement within a validity interval, confidence decay, direct writes, timestamps, expiry, retention and promotion.150
recallRanked and keyed claim retrieval, read timestamps, tier ordering, scope and tombstone filters, and evidence checks.230
resolve-entityEntity matching, aliases, identity cards, location relationships, edges and ownership queries.170
settlePrediction registration, observations, required verdict citations and outcome label views.170
traverseGraph traversal from a seed entity, bounded by time, hop count and readable edges in the caller’s session.140

Error cases

ErrorWhenClause
FilePreviewNotATableA previewed path resolved to no table.read.register.file-preview-target
LedgerNotTenantScopedA tenant-scoped token named the request-ledger child relation.read.register.scoped-ledger
ServeDeclarationMissingThe network transport was started with no audience or no positive in-flight ceiling.read.register.serve-declaration
HttpCredentialMissingA network transport request carried no credential.read.register.credential-missing
StatementNotReadOnlyAdmitted text did not parse to exactly one read-only SELECT.read.guard.single-read-only-statement
TableFunctionRefusedA table function or a schema-qualified catalog reach appeared in caller text.read.guard.table-function
TemplateNamesForeignRelationA template named a non-store relation or collided with a built-in tool prefix.read.guard.template-relation-shape
TemplateArgumentRejectedA template argument was missing, unknown or mistyped.read.guard.template-binding
QueryParameterRejectedA query parameter was missing, unused, untyped or mistyped.read.guard.query-binding
ReadDurationExceededA statement reached its selected duration ceiling.read.respond.duration-ceiling
ReadResponseTooLargeA response envelope or first row exceeds its selected byte ceiling.read.respond.byte-ceiling
QueryNotOneStatementOperator text held other than exactly one statement.read.query.one-statement
QueryProjectAbsentA --project named no store on disk.read.query.project-store
RetrieveTableUnavailableA ranked read listed a table name outside the session’s relations.read.retrieve.table-list
FilterBudgetExceededA ranked read’s filter exceeded its value, condition or byte budget.read.retrieve.filter-budget-refusal
ReadPartUnavailableA part a statement touches did not download within its wait.read.cache.miss-wait
PinnedBuildUnavailableA pinned build identifier is unknown or collected.read.resolve-pin.unknown-build
RequiredFaceAbsentA client required a face this binary did not link.read.embed.required-face
ReadBackendAbsentA read tool was called on a binary without the embedded SQL engine.read.embed.absent-read-backend
ReadBoundExceedsHorizonA call’s available_as_of or since falls later than its credential’s horizon.read.horizon.exceeds-horizon
ReadNoBuildWithinHorizonA model table holds no build whose recorded horizon is at or before the credential’s.read.horizon.build-resolution
SubscriptionPositionUnavailableA subscription’s after position names no committed run of its table.read.subscribe.position-unavailable
SubscriptionUnderHorizonA tool-protocol subscription arrived under a credential carrying a horizon.read.subscribe.horizon-refusal
MemoryShapeColumnMissingA table naming a memory shape omits a canonical column.read.declare.canonical-column
MemoryUndeclaredRelationA candidate edge carries an undeclared relation type.read.declare.undeclared-relation
MemoryExtractExhaustedAn extract batch exhausted its attempts and was dead-lettered.read.synthesize.dead-letter
MemoryDirectWriteShapeRefusedA direct write targeted a memory shape other than claims.read.revise.direct-write
MemoryObservationOutOfOrderA claim was observed before a live contradicting claim of its line.read.revise.observed-order
MemoryCitationNotLiveA direct write cites a keyed row that is not its key’s live version.read.revise.citation-live
MemoryClaimScopeRefusedA served claim write names another actor or reading session.read.revise.served-scope
MemoryClaimBrowserRefusedA browser-origin request reached the served claim-write route.read.revise.browser-request
MemoryClaimMalformedA served claim write holds a malformed or client-scoped body.read.revise.malformed-request
MemoryClaimWriteRefusedA served claim write’s store effect refused.read.revise.served-fault
MemoryEvidenceUnresolvedA claim’s evidence does not resolve through the caller’s session.read.recall.evidence-unresolved
MemoryEvidenceOverflowA claim names more evidence entries than the gate bound.read.recall.evidence-gate-bound
MemoryRecallNotClaimsA keyed recall named a table declaring no memory_facts shape.read.recall.keyed-not-claims
MemoryEntityAmbiguousA mention resolves onto two identities with no separating key.read.resolve-entity.ambiguous-mention
MemoryEdgeEndpointUnresolvedA candidate edge endpoint resolves to no identity.read.resolve-entity.edge-endpoint
MemoryExplainNotEntitiesA knowledge card named a table declaring no memory_entities shape.read.resolve-entity.card-not-entities
MemoryEntityFieldEmptyAn entity upsert carried an id, kind, name or alias empty after trimming.read.resolve-entity.upsert-fields
MemoryEntityAliasConflictAn entity upsert names a name or alias another entity already carries.read.resolve-entity.alias-conflict
MemoryEntityTableTruncatedAn entity upsert’s session read of its table returned truncated.read.resolve-entity.upsert-whole-table
MemoryEntityAvailabilityDeclaredAn entity upsert targeted a table declaring available_time.read.resolve-entity.upsert-availability
OutcomeRegistrationInvalidA prediction registration breaks the one-form, one-source, comparator-iff-metric rule.read.settle.registration
OutcomeSourceMismatchAn observation’s verdict carries no source or a source other than the registration’s.read.settle.source-mismatch
OutcomeCitationMissingA judgment verdict carries no http or https settling citation.read.settle.settling-citation
OutcomeStatementTooLongA registration’s statement exceeds its byte bound.read.settle.statement-bound
OutcomeMetricReferenceInvalidA registration’s metric reference is malformed or names a series under a non-metric source.read.settle.metric-reference
OutcomePredictionUnregisteredAn observation names a prediction no stored registration the writer reads carries.read.settle.prediction-unregistered
OutcomeRegistrationConflictA registration reuses a stored prediction id with different fields.read.settle.registration-conflict
OutcomeAlreadySettledAn observation differs from a stored outcome that already carries a verdict.read.settle.outcome-settled
MemoryTraverseNotEdgesA traversal named a table that holds no memory edges.read.traverse.not-edges
MemoryTraverseRelationUnwalkableA traversal named a relation its declaration does not mark walkable.read.traverse.walkable
MemoryTraverseHopsExceededA traversal asked for more hops than the bound.read.traverse.hop-bound

Bounds

BoundValueBasisClause
read-bytes-per-token4 Bchosenread.register.size-estimate
read-http-retry-after1 schosenread.register.past-ceiling
read-http-request-body1 MiBchosenread.register.request-body
read-http-stop-drain20 schosenread.register.stop-drain
read-row-ceiling-overfetch1 rowschosenread.respond.row-ceiling
read-face-row-ceiling10000 rowschosenread.respond.face-ceiling
read-lineage-depth16 edgeschosenread.lineage.depth-bound
read-lineage-nodes1000 nodeschosenread.lineage.node-page
read-relevance-floor-narrow1 tokenschosenread.retrieve.relevance-floor
read-relevance-floor-split3 tokenschosenread.retrieve.relevance-floor
read-relevance-floor-wide2 tokenschosenread.retrieve.relevance-floor
read-token-length-floor2 charschosenread.retrieve.token-length-floor
read-content-token-cap12 tokenschosenread.retrieve.token-cap
read-plural-suffix-floor4 charschosenread.retrieve.plural-suffix-floor
read-candidate-window-factor8 timeschosenread.retrieve.candidate-window
read-candidate-window-floor200 rowschosenread.retrieve.candidate-window
read-filter-bytes16 KiBchosenread.retrieve.filter-budget
read-filter-conditions32 conditionschosenread.retrieve.filter-budget
read-filter-values256 entrieschosenread.retrieve.filter-budget
read-sidecar-probe-factor4 timeschosenread.retrieve.sidecar-oversampling
read-sidecar-probe-floor64 rowschosenread.retrieve.sidecar-oversampling
read-sidecar-restricted-factor4 timeschosenread.retrieve.sidecar-oversampling
read-filtered-exact-rows4096 rowschosenread.retrieve.filtered-exact-threshold
read-over-fetch-rounds4 roundschosenread.retrieve.adaptive-over-fetch
read-sidecar-node-mark4 Bchosenread.retrieve.sidecar-size-cap
read-sidecar-size-cap64 MiBchosenread.retrieve.sidecar-size-cap
read-fulltext-sealed-cap256 MiBchosenread.retrieve.fulltext-sealed-cap
read-fusion-lexical-weight40 percentchosenread.rank.fusion
read-fusion-vector-weight60 percentchosenread.rank.fusion
read-window-anchor-tolerance24 hchosenread.rank.window-anchor-tolerance
read-lexical-index-cache64 entrieschosenread.rank.lexical-index-cache
read-part-wait30 schosenread.cache.miss-wait
read-session-pool-entries16 entrieschosenread.cache.pool-entries
read-session-pool-connections4 connectionschosenread.cache.pool-connections
read-subscribe-queue1000 notificationschosenread.subscribe.overrun
memory-extract-attempts3 attemptschosenread.synthesize.extract-attempts
memory-prompt-bytes32 KiBchosenread.synthesize.prompt-bound
memory-row-chars16384 charschosenread.synthesize.row-cap
memory-evidence-references256 entrieschosenread.recall.evidence-references
memory-evidence-gate4096 entrieschosenread.recall.evidence-gate-bound
outcome-grace-window86400 schosenread.settle.grace-window
outcome-statement-bytes4096 Bchosenread.settle.statement-bound
memory-traverse-hops3 hopschosenread.traverse.hop-bound
memory-traverse-fan-out64 memory-edgeschosenread.traverse.fan-out
memory-traverse-frontier512 memory-edgeschosenread.traverse.frontier-cap

Types

Each struct or enum a {{type:<path>}} pointer names, with the keys serde reads and their doc comments.

contextful_core::memory::revise::Tier

The enum at crates/contextful-core/src/memory/revise.rs, named by read.revise.tier.

KeyDoc
researched
derived
curated

contextful_core::read::subscribe::Notification

The struct at crates/contextful-core/src/read/subscribe.rs, named by read.subscribe.notification.

KeyDoc
table
run_id
node_id
committed_at
frontier

Decisions

SectionCited by
A-read#agent-third-partyread.revise.direct-write
A-read#citation-keyed-tableread.recall.evidence-key, read.recall.evidence-no-value, read.recall.evidence-stale
A-read#claim-standing-derivedread.revise.tier, read.revise.supersede, read.revise.unscoped-collision, read.recall.confidence-label, read.recall.stale-revision
A-read#extraction-cache-keysdisclosure.erase.reader-frontier
A-read#filtered-vector-traversalread.retrieve.filtered-traversal, read.retrieve.filtered-exact-threshold
A-read#gleaning-declared-singleread.synthesize.cadence
A-read#join-matches-availabilitystore.available-time.vintage-rows, read.as-of-join.per-row-bound
A-read#memory-access-followsread.recall.evidence-unresolved, read.recall.evidence-references, read.recall.evidence-gate-bound, disclosure.erase.privilege
A-read#memory-confidence-retentionread.synthesize.confidence-calibration, read.revise.retention-default
A-read#memory-reads-exposeread.recall.usage-ledger, read.resolve-entity.graph-index, read.resolve-entity.ownership-answer
A-read#memory-vocabulary-schedulesread.declare.undeclared-relation, read.declare.reserved-relations
A-read#memory-writes-validateread.synthesize.dead-letter, read.resolve-entity.ambiguous-mention, read.resolve-entity.edge-endpoint, read.settle.registration, read.settle.source-mismatch, read.settle.settling-citation, read.settle.calibration-report
A-read#nearness-parent-closure
A-read#networked-read-transportread.register.network-transport, read.register.past-ceiling, read.register.per-request-admission, read.register.credential-missing, read.register.admission-refused, read.register.per-request-revocation, read.register.stateless-session, run.project.unauthenticated-upgrade
A-read#pooled-engine-reusesread.register.tool-set, read.register.concurrent-statements
A-read#read-surface-admitsread.register.describe-zone, read.register.file-preview-target, read.register.scoped-ledger, read.guard.single-read-only-statement, read.guard.relation-allowlist, read.guard.unregistered-relation, read.guard.table-function, read.guard.statement-provenance, read.guard.template-relation-shape, read.guard.template-binding, read.respond.paths-stay-inside, read.reference.admission, read.reference.index-visibility, surface.package.stdio-credential
A-read#reciprocal-rank-calibratesread.rank.calibration-gate
A-read#reranker-reorders-masked
A-read#restricted-sidecar-proberead.retrieve.filter-budget-refusal, read.retrieve.excluded-arm, read.retrieve.adaptive-over-fetch
A-read#result-reused-underread.reference.call, read.reference.erased-verdict, read.reference.frontier, read.cache.result-key, read.cache.cache-is-opt-in, read.cache.budget, read.cache.session-pool, read.cache.change-misses
A-read#served-claim-writeread.revise.served-write, read.revise.served-scope, read.revise.browser-request, read.revise.malformed-request, read.revise.served-dedup, read.revise.served-fault
A-read#sidecar-serves-paststore.index.filter-copies, read.horizon.rank-statistics
A-read#statement-owns-deadlineread.respond.duration-ceiling, read.respond.byte-ceiling, authority.grant.duration-ceiling, authority.grant.byte-ceiling
A-read#store-holds-nothingauthority.resist.credential-shaped-value
A-read#traversal-walks-enforcedread.traverse.walkable, read.traverse.hop-bound, read.traverse.fan-out, read.traverse.frontier-cap
A-read#zone-withheld-relationread.respond.restriction-block, authority.place.excluded-disclosed