Expand description
Pure domain model types.
Structs§
- Audit
Event Record - Redacted durable audit event.
- Business
Alias - Business
Definition Fact - Business
Domain - Business
Domain Definition - Authored business domain definition.
- Business
Evidence - Provenance retained for every accepted authored business fact.
- Business
Glossary - Authored repository business glossary schema v1.
- Business
Knowledge Conflict - Business
Knowledge Projection - Storage projection before API metadata and repository scope are attached.
- Business
Knowledge Projection Input - Prepared projection input written by the repository index writer.
- Business
Knowledge Query Request - Repository and immutable-ref bound business knowledge request.
- Business
Knowledge Source - One route-authorized authored glossary loaded from an immutable repository snapshot.
- Business
Knowledge Status - Projection freshness and bounded cardinality summary.
- Business
Semantics - Declarative calculation semantics. Formula text is not executable in v1.
- Business
Technical Mapping - Business
Technical Mapping Definition - Authored edge from one business term to a technical target hint.
- Business
Term - Business
Term Definition - Authored business term and its declared technical mappings.
- Claim
Record - Claim fact extracted from or supported by evidence.
- Code
Call Record - Call relationship extracted from code.
- Code
Chunk Record - Versioned retrievable code chunk.
- Code
Dependency Record - Dependency declaration extracted from package manager manifest or lock files.
- Code
Extraction Metadata - Tree-sitter query metadata attached to extracted code facts.
- Code
Feature Flag Graph - Feature flag graph grouped by stable configuration source.
- Code
Feature Flag Record - Feature flag or runtime configuration relationship extracted from code.
- Code
Feature Flag Request - Feature-flag graph query over an indexed repository scope.
- Code
Feature Flag Usage - One code location where a feature flag is defined, read, or guards code.
- Code
File Diagnostic - File-level diagnostic produced by indexing.
- Code
File Fields - Input fields for one parsed repository file.
- Code
File Fingerprint - Previously indexed file hash used to skip unchanged incremental parses.
- Code
File Record - Parser output for one repository file.
- Code
Framework Edge Record - One indexed relationship between framework nodes or an unresolved target hint.
- Code
Framework Node Record - One indexed framework component, declaration, or template construct.
- Code
Graph Artifact - Code graph artifact tied to a shared retrieval result.
- Code
Graph Batch - Atomic code graph mutation batch.
- Code
Graph Code Excerpt - Compact code excerpt retained inside the context byte budget.
- Code
Graph Commit Receipt - Receipt returned after code graph facts commit.
- Code
Graph Context Budget - Budget consumed by one codegraph context orchestration.
- Code
Graph Context Pack - Internal context packing input grouped by structural role.
- Code
Graph Context Provenance - Context item provenance used by packed codegraph responses.
- Code
Graph Context Request - Agent-facing one-call code graph context request.
- Code
Graph Impact Hint - Structural risk hint around a seed symbol or file.
- Code
Impact Path Groups - Diff paths split by the effective repository selector.
- Code
Impact Request - Code impact analysis request over a Git diff.
- Code
Import Record - Import relationship extracted from code.
- Code
Incremental Summary Receipt - Bounded incremental-work metrics retained across post-delta finalization.
- Code
Index Batch - One bounded parse result committed under a checkpointed index session.
- Code
Index Checkpoint - Durable progress checkpoint for a repository indexing session.
- Code
Index Progress Summary - Coarse phase timing and counts reported by repository indexing.
- Code
Index Publication Fence - Attempt-scoped token required to publish code-index state.
- Code
Index Request - Code
Index Resource Budget - Resource budget used to partition repository indexing into bounded batches.
- Code
Index Session - Stable metadata for one resumable repository indexing session.
- Code
Index Snapshot - Parsed index changes ready to commit into storage.
- Code
Index Summary - Result of applying a code index snapshot.
- Code
Index Task Queue Status - Aggregated durable queue state for background code-index tasks.
- Code
Index Task Record - Durable background task for one code repository index request.
- Code
Monorepo Workspace - A detected monorepo workspace that groups multiple packages under a common root.
- Code
Parse Status Counts - Parse-status counts surfaced by graph diagnostics.
- Code
Path Tombstone - Rename/delete lineage marker retained after incremental updates.
- Code
Range - Inclusive source line range and half-open byte range in a repository file.
- Code
Reference Fields - Input fields for a syntax-level reference.
- Code
Reference Record - Versioned syntax-level reference or dependency edge candidate.
- Code
Repository Cross Edge - Cross-repository overlay edge derived after member snapshots are indexed.
- Code
Repository Excluded Path - Path excluded from indexing by preset, ignore file, or request scope.
- Code
Repository Language Preview - Language bucket in a repository scope preview.
- Code
Repository Largest File - Large file surfaced before a full repository index starts.
- Code
Repository Latency Sample - Representative query latency captured for an operations report.
- Code
Repository Registration - Code repository identity persisted after registration.
- Code
Repository Removal Summary - Counts and aliases removed when a registered repository is deleted.
- Code
Repository Report - Reusable repository operations report.
- Code
Repository Retention JobStatus - Observable progress for one durable whole-repository index retention job.
- Code
Repository Scope Preview - Non-mutating preview of the effective repository indexing scope.
- Code
Repository Selector - Repository selector accepted by code index and retrieval APIs.
- Code
Repository Set - Persisted repository-set metadata.
- Code
Repository SetAdd Member Request - Request to attach one indexed repository snapshot to a repository set.
- Code
Repository SetCreate Request - Repository-set creation request shared by API adapters.
- Code
Repository SetMember - Persisted repository-set membership pointing at a real repository snapshot.
- Code
Repository SetMember Status - Status for one repository-set member snapshot.
- Code
Repository SetOverlay Status - Overlay freshness and task-independent diagnostics.
- Code
Repository SetQuery Hit - Query hit with explicit repository-set provenance.
- Code
Repository SetQuery Request - Multi-repository query request.
- Code
Repository SetRefresh Summary - Summary returned after rebuilding a repository-set overlay.
- Code
Repository SetRefresh Task Record - Durable repository-set overlay refresh task record.
- Code
Repository SetRemove Member Request - Request to remove one repository snapshot from a repository set.
- Code
Repository SetStatus - Aggregated repository-set status.
- Code
Repository Status - Repository index status and diagnostics summary.
- Code
Repository Totals - Aggregated totals for repository indexes separate from graph-evidence code rows.
- Code
Retrieval Hit - Code retrieval hit with source location, layers, and freshness metadata.
- Code
Retrieval Request - Code repository retrieval request.
- Code
Route Record - Web framework route mapping extracted from source code.
- Code
Scope Retention Summary - Scope retention result after pruning old repository snapshots.
- Code
Scope Retirement JobStatus - Observable progress for one durable, restart-safe scope retirement job.
- Code
Symbol Generation Counts - Generated/handwritten split for symbols in one code index scope.
- Code
Symbol Record - Versioned syntax-level symbol definition.
- Code
Workspace Detection Config - Configuration controlling automated monorepo workspace detection.
- Code
Workspace Member - A single package member inside a monorepo workspace.
- Code
Workspace Package Mapping - Maps a workspace member’s package name to an indexed repository scope.
- Codebase
View Budget - View derivation budget and truncation metadata.
- Codebase
View Call - Call evidence row with optional resolved target path.
- Codebase
View Declared Business Domain - Authored domain row merged ahead of inferred route, flag, and path signals.
- Codebase
View Dependency - Dependency evidence row from manifests and lockfiles.
- Codebase
View Edge - Graph-derived view edge.
- Codebase
View Evidence - Evidence reference backing a node, edge, or section.
- Codebase
View File - File evidence row in a codebase view snapshot.
- Codebase
View Node - Graph-derived view node.
- Codebase
View Request - Request for a graph-derived repository understanding view.
- Codebase
View Section - Narrative section derived from graph facts and evidence.
- Codebase
View Snapshot - Bounded raw graph rows used to derive codebase views.
- Codebase
View Symbol - Symbol evidence row in a codebase view snapshot.
- Commit
Receipt - Receipt returned after graph facts and mutation log entries commit.
- Confidence
Score - Confidence score in basis points so it remains sortable and exact.
- Context
Entity - Entity projection retained with each context item.
- Context
Graph Fact - Structured relation, claim, or event that supports a retrieval hit.
- Context
Graph Path - Direct graph path evidence derived from a structured graph fact.
- Context
Graph Path Edge - One edge in a graph path returned through the context pack.
- Context
Pack Item - Context-pack item tied to a retrieval hit.
- Directory
Relation - Qualified relation target, such as
codespec:design. - Domain
Error - Domain-level validation failure.
- Event
Record - Event fact tied to entities and optional valid-time text.
- Evidence
Extraction Metadata - Metadata shared by text, image, OCR, caption, table, layout, and embedding evidence.
- Evidence
Record - Evidence accepted by the graph mutation pipeline.
- Evidence
Span - Source byte and line span for evidence-backed facts.
- Extraction
Diagnostic - Diagnostic emitted by an extractor without blocking other modalities.
- File
Content Chunk - Text chunk extracted from an authorized local file.
- File
Content Entry - Content read-model record produced by a bounded scan.
- File
Content Read Model Cursor - Scoped derived cursor state for one file-content read-model input.
- File
Content Search Hit - One file-content search hit with provenance and prompt-role isolation.
- File
Content Search Request - Bounded file-content query.
- File
Index Diagnostics - Aggregated file-index diagnostics.
- File
Index Entry - Indexed file-location record produced by a bounded scan.
- File
Index Root - Authorized root scanned by the local file indexer.
- File
Index Root Status - Root-level status surfaced to health and service diagnostics.
- File
Index Root Update - Full-root replacement produced by one scan pass.
- File
Index Scan Summary - Summary returned after one or more roots are indexed.
- File
Knowledge Fact Candidate - Deterministic candidate fact extracted from file content.
- File
Search Hit - One file-location search hit.
- File
Search Request - Bounded file-location query.
- Framework
Graph - Framework graph rows returned from one repository scope.
- Framework
Graph Request - Bounded framework graph query over one indexed repository scope.
- Fusion
Diagnostics - Diagnostics for reciprocal-rank fusion.
- Graph
Inspection - Aggregated graph status for diagnostics.
- Graph
Mutation Batch - A transactional graph mutation unit.
- Graph
Relation Record - Typed relation between graph entities.
- Graph
Version - Monotonic graph state version.
- Graph
Version Range - Graph-version validity range for facts.
- Health
Storage Snapshot - Read-only storage view used by service health without mutating indexes.
- Index
Cursor - Scoped cursor for a derived index read model.
- Index
Lag - Per-kind lag included in diagnostics snapshots.
- Index
Refresh Diagnostics - Queue, dead-letter, and stale-index diagnostics shared by APIs and storage.
- Index
Staleness Reason - Structured reason explaining why an index family or scoped cursor is stale.
- Index
Status - Versioned status for a derived index.
- Indexed
Repository Document - Indexed, snapshot-bound text used to derive portable repository relationships.
- Knowledge
Entity - A minimal entity model used by early graph-building code.
- Knowledge
Map - Assembled inline map used by domain workflows and API responses.
- Knowledge
MapChange - Optional source changes accepted by the update command.
- Knowledge
MapHistory Entry - Version history entry written after CLI mutations.
- Knowledge
MapRoute - Ordered source route for a topic.
- Knowledge
MapSource - Addressable knowledge source that remains authoritative outside the map.
- Knowledge
MapTopic - Human-readable topic bucket used by agents for routing.
- Layout
Region - Page-space rectangle for table and layout evidence.
- Ontology
Identity - Immutable ontology identity independent of a display label.
- Proposal
Conflict Record - Stored conflict associated with a proposal.
- Proposal
Provenance - Auditable model, prompt, and source lineage for a stored proposal.
- Proposal
Record - Stored proposal ready for CLI/Web review.
- Ranking
Signal - Per-retriever ranking signal preserved after fusion.
- Repository
Code Chunk Record - Searchable code chunk.
- Repository
Code File Record - File-level code index row.
- Repository
Code Range - Inclusive byte or line range for repository code index rows.
- Repository
Code Reference Record - Reference extracted from tree-sitter syntax and optionally resolved.
- Repository
Code Symbol Record - Symbol definition extracted from tree-sitter syntax.
- Repository
Graph Edge - Repository
Graph Neighborhood - Repository
Graph Neighborhood Request - Validated request for a bounded repository graph neighborhood.
- Repository
Graph Node - Repository
MapDirectory - Strongly typed directory governance entry persisted in a repository map.
- Repository
MapDirectory Change - Optional fields accepted by
map directory update. - Rerank
Diagnostics - Diagnostics for post-fusion reranking.
- Rerank
Mode Error - Invalid rerank backend mode supplied by runtime configuration.
- Rerank
Signal - Final rerank signal applied after hybrid retrieval fusion.
- Retrieval
Backend Status - Per-backend status preserved so callers can distinguish fallback from complete hybrid retrieval.
- Retrieval
Budget Used - Budget actually consumed by retrieval context packing.
- Retrieval
Hit - A context item returned by retrieval.
- Retrieved
Context Pack - A compact, auditable context pack for agent and UI adapters.
- Route
Handler Role - Single HTTP endpoint binding attached to a route-handler symbol.
- Service
Definition Plan - Service definition rendering without privileged execution.
- Service
Lifecycle Execution Report - Result of executing or dry-running a service lifecycle plan.
- Service
Lifecycle Step - One staged service lifecycle action.
- Service
Lifecycle Step Result - Execution result for a lifecycle step.
- Service
Operator Status - Persisted silent-update operator status.
- Service
Package Manifest Check - Package-manager release-manifest drift check described by the lifecycle plan.
- Service
Permission Requirement - Permission requirement attached to a generated service lifecycle plan.
- Software
Build Target - Build target, script, profile, or generator entry projected from indexed repository evidence.
- Software
Build Target Input - Constructor input for
SoftwareBuildTarget. - Software
Component - Projected dependency component from repository manifests and lockfiles.
- Software
Component Input - Constructor input for
SoftwareComponent. - Software
Dependency Usage - Import/include evidence that uses a declared dependency component.
- Software
Dependency Usage Input - Constructor input for
SoftwareDependencyUsage. - Software
Design Element - Design, architecture, module, component, interface, or capability evidence.
- Software
Design Element Input - Constructor input for
SoftwareDesignElement. - Software
File - Projected repository file node for the software global model.
- Software
File Input - Constructor input for
SoftwareFile. - Software
Global Projection - Projected software global facts for one repository scope.
- Software
Global Request - Repository-scoped software global model query.
- Software
Global Status - Freshness and count summary for the software global projection.
- Software
IacResource - Infrastructure, deployment, or service-operation resource projected from indexed IaC evidence.
- Software
IacResource Input - Constructor input for
SoftwareIacResource. - Software
Relationship - Cross-domain relationship between projected software files, topics, components, and usages.
- Software
Relationship Input - Constructor input for
SoftwareRelationship. - Software
SdkUsage - Projected SDK or external API usage from unresolved import/include evidence.
- Software
SdkUsage Input - Constructor input for
SoftwareSdkUsage. - Software
Topic - Topic extracted from repository documentation or the repository knowledge map.
- Software
Topic Input - Constructor input for
SoftwareTopic. - Source
Scope - Authorized source boundary for evidence and retrieval.
- Sqlite
Storage Diagnostics - SQLite-specific health data included in shared graph diagnostics.
- Storage
Health - Storage health surfaced to diagnostics.
- Traversal
Provenance Trace - Bounded explanation of the graph traversal and candidate path used for an answer.
- Traversal
Ranking Contribution - Per-source ranking contribution retained before final context truncation.
- Traversal
Trace Edge - Edge reached while building a retrieval context pack.
- Traversal
Trace Evidence - Evidence candidate reached during retrieval.
- Traversal
Trace Node - Node reached while building a retrieval context pack.
- Traversal
Trace Redaction - Authorization and budget redaction summary for a traversal trace.
- Worker
Status - Aggregated status for a worker family.
- Worker
Task Record - Persistent worker task used by service, CLI, Web, and recovery diagnostics.
Enums§
- Audit
Status - Persistent audit status shared by CLI/Web/service/agent surfaces.
- Business
Alias Kind - Business
Knowledge Query Kind - Requested business projection slice.
- Business
Knowledge Resolution - Term-name resolution state for a business query.
- Business
Mapping Relation - Business
Term Status - Lifecycle of one authored business term.
- Code
Graph Artifact Kind - Code artifact category returned through the general GraphRAG context pack.
- Code
Index Mode - Code index mode tied to Git snapshots or diffs.
- Code
Index Task State - Persistent lifecycle for background code repository index tasks.
- Code
Monorepo Workspace Format - Recognised monorepo workspace manifest formats.
- Code
Parse Status - Parser status for a repository file at a graph version.
- Code
Query Kind - Retrieval query kind for code graph and lexical search.
- Code
Reference Kind - Reference category extracted from tree-sitter captures.
- Code
Repository SetRefresh Task State - Durable state for a repository-set overlay refresh task.
- Code
Resolution State - Resolution certainty for syntax-level code references.
- Code
Retrieval Layer - Retrieval layer that contributed to a code hit.
- Code
Symbol Kind - Symbol definition category extracted from tree-sitter captures.
- Codebase
View Kind - Deterministic repository understanding view kind.
- Context
Graph Fact Kind - Structured graph fact kind referenced from a context item.
- Directory
Load Hint - When an agent should load content described by a directory entry.
- Directory
Relation Kind - Supported typed relationship between governed directories.
- Directory
Update Rule - How authored content in a governed directory is updated.
- Evidence
Modality - Evidence media unit tracked by multimodal ingestion and retrieval.
- Extraction
Status - Extraction outcome recorded when multimodal workers degrade or fail.
- Fact
Status - Lifecycle status for graph facts created from evidence or extraction.
- Framework
Edge Kind - Framework graph relationship category.
- Framework
Kind - Supported frontend framework families.
- Framework
Node Kind - Framework graph node category.
- Freshness
Policy - Freshness policy for hybrid retrieval.
- Index
Kind - Derived index families maintained from the graph mutation log.
- Index
Modality - Source modality covered by a derived index cursor.
- Index
State - Operational state of a derived index.
- Knowledge
MapSource Kind - Supported source category labels in the YAML contract.
- Ontology
Entity Kind - Typed ontology node identity. Untyped legacy graph entities keep their label-derived ids.
- Proposal
Conflict Severity - Conflict severity shown before manual approval.
- Proposal
Kind - Proposal fact family stored before user approval.
- Proposal
State - Proposal approval lifecycle.
- Repository
MapType - Repository navigation map selected by
relay-knowledge map --type. - Rerank
Mode - Rerank backend requested for the hybrid retrieval candidate set.
- Retrieval
Backend State - Availability state for optional retrieval backends.
- Retrieval
Mode - Retrieval path used to satisfy a query.
- Retriever
Source - Retrieval source that contributed to a fused context result.
- Service
Manager Action - Service manager action surfaced as a generated, user-executed plan.
- Service
Operator State - Installed background operator state.
- Software
Global Kind - Query kind for repository-scoped software global model facts.
- Staleness
Hint - Per-file staleness hint attached to retrieval hits at query time.
- Symbol
Role - Role annotation for a symbol beyond its syntactic kind.
- Technical
Target Kind - Traversal
Trace Node Kind - Stable node categories exposed in traversal provenance traces.
- Worker
Backend State - Runtime availability of an external worker backend.
- Worker
Kind - External or fallback worker family used by background productization tasks.
- Worker
Task State - Persistent task lifecycle for bounded worker queues.
Constants§
- BUSINESS_
GLOSSARY_ MAX_ BYTES - BUSINESS_
GLOSSARY_ MAX_ DOMAINS - BUSINESS_
GLOSSARY_ MAX_ TERMS - BUSINESS_
GLOSSARY_ SCHEMA_ VERSION - BUSINESS_
TERM_ MAX_ ALIASES - BUSINESS_
TERM_ MAX_ MAPPINGS - CODEGRAPH_
CONTEXT_ DEFAULT_ LIMIT - CODEGRAPH_
CONTEXT_ DEFAULT_ MAX_ BYTES - CODEGRAPH_
CONTEXT_ MAX_ BYTES - CODEGRAPH_
CONTEXT_ MAX_ LIMIT - CODEGRAPH_
CONTEXT_ MIN_ BYTES - RECIPROCAL_
RANK_ FUSION_ K - RRF constant used by Phase 1 hybrid retrieval.
- REPOSITORY_
GRAPH_ DEFAULT_ EDGE_ LIMIT - REPOSITORY_
GRAPH_ DEFAULT_ NODE_ LIMIT - REPOSITORY_
GRAPH_ MAX_ DEPTH - REPOSITORY_
GRAPH_ MAX_ EDGE_ LIMIT - REPOSITORY_
GRAPH_ MAX_ NODE_ LIMIT
Functions§
- clean_
git_ commit_ from_ snapshot_ identity - Returns the clean Git commit carried by a persisted snapshot identity.
- code_
snapshot_ scope_ id - Builds the stable source scope id for a Git snapshot partition.
- code_
snapshot_ scope_ id_ with_ workspace_ detection - Builds a scope identity that includes workspace-detection semantics when those semantics can add persisted workspace graph facts.
- code_
snapshot_ scope_ is_ fact_ versioned - code_
snapshot_ scope_ matches_ identity - Accepts every canonical supported workspace configuration while still rejecting scopes from older code-fact versions or unrelated identities.
- code_
snapshot_ scope_ workspace_ semantic - Returns the workspace semantic encoded by a valid scope identity.
Some(None)is the backward-compatible disabled identity; an enabled configuration, including mask zero, isSome(Some(mask)). - normalize_
actor - Normalizes a required actor identifier for lifecycle decisions.
- project_
okf_ neighborhood - Projects OKF v0.2 concepts from indexed Markdown without reading the live worktree.