Skip to main content

Crate kiromi_ai_memory

Crate kiromi_ai_memory 

Source
Expand description

kiromi-ai-memory — engine for the kiromi-ai-memory memory store.

This crate exposes the public API consumers (CLI, FFI, future server) wrap. See docs/superpowers/specs/ for the design spec.

Re-exports§

pub use crate::attribute::AttributeValue;
pub use crate::attribute::kind_str as attribute_kind_str;
pub use crate::builder::Builder;
pub use crate::capabilities::EmbedderCapabilities;
pub use crate::capabilities::MetadataCapabilities;
pub use crate::capabilities::Plugin as CapabilityPlugin;
pub use crate::capabilities::StorageCapabilities;
pub use crate::codec::Codec;
pub use crate::content::Content;
pub use crate::content::ContentHash;
pub use crate::content::ContentKind;
pub use crate::context::ContextBlock;
pub use crate::context::ContextDiff;
pub use crate::context::ContextKind;
pub use crate::context::ContextOpts;
pub use crate::context::ContextOrdering;
pub use crate::embedder::CALLER_PROVIDED_EMBEDDER_ID;
pub use crate::embedder::EmbedRole;
pub use crate::embedder::Embedder;
pub use crate::embedder::EmbedderRegistry;
pub use crate::error::Error;
pub use crate::error::Result;
pub use crate::event::DEFAULT_EVENT_CAPACITY;
pub use crate::event::MemoryEvent;
pub use crate::evolve::EvolutionApplied;
pub use crate::evolve::EvolutionOps;
pub use crate::evolve::EvolutionReport;
pub use crate::evolve::MemoryAttributeOp;
pub use crate::evolve::SummaryAttributeOp;
pub use crate::graph::EdgeKind;
pub use crate::graph::EdgeKindTag;
pub use crate::graph::Graph;
pub use crate::graph::GraphEdge;
pub use crate::graph::GraphNode;
pub use crate::graph::NodeRef;
pub use crate::graph::TraverseOpts;
pub use crate::handle::Memory;
pub use crate::handle::MemoryView;
pub use crate::link::Edge;
pub use crate::link::LinkKind;
pub use crate::memory::MemoryId;
pub use crate::memory::MemoryKind;
pub use crate::memory::MemoryRecord;
pub use crate::memory::MemoryRecordWire;
pub use crate::memory::MemoryRef;
pub use crate::metadata::MetadataStore;
pub use crate::metadata::PartitionInfo;
pub use crate::metadata::SnapshotRow;
pub use crate::metadata::SqliteMetadata;
pub use crate::migrate::MigrationOpts;
pub use crate::migrate::MigrationReport;
pub use crate::migrate::SchemeMapper;
pub use crate::ops::BackupReport;
pub use crate::ops::CheckpointReport;
pub use crate::ops::VacuumOpts;
pub use crate::ops::VacuumReport;
pub use crate::opts::AppendOpts;
pub use crate::opts::AttachSummaryOpts;
pub use crate::opts::DeleteOpts;
pub use crate::opts::LinksOpts;
pub use crate::opts::ListOpts;
pub use crate::opts::Page;
pub use crate::partition::PartitionPath;
pub use crate::partition::PartitionScheme;
pub use crate::partition::Partitions;
pub use crate::query::Query;
pub use crate::query::QueryMode;
pub use crate::query::SearchHit;
pub use crate::regen::GcOpts;
pub use crate::regen::GcReport;
pub use crate::regen::RegenReport;
pub use crate::regen::RegenSubjectOpts;
pub use crate::regen::ReindexReport;
pub use crate::reranker::Reranker;
pub use crate::snapshot::RestoreOpts;
pub use crate::snapshot::RestoreReport;
pub use crate::snapshot::SnapshotAttribute;
pub use crate::snapshot::SnapshotId;
pub use crate::snapshot::SnapshotManifest;
pub use crate::snapshot::SnapshotOpts;
pub use crate::snapshot::SnapshotRef;
pub use crate::storage::InMemoryBackend;
pub use crate::storage::LocalFsBackend;
pub use crate::storage::Storage;
pub use crate::summarizer::SummarizeOpts;
pub use crate::summarizer::Summarizer;
pub use crate::summarizer::SummarizerCapabilities;
pub use crate::summarizer::SummarizerRegistry;
pub use crate::summarizer::SummaryStyle;
pub use crate::summary::content::DataPointRef;
pub use crate::summary::content::PartitionRef;
pub use crate::summary::content::SummaryBlock;
pub use crate::summary::content::SummaryContent;
pub use crate::summary::content::SummaryInputRange;
pub use crate::summary::Scope;
pub use crate::summary::StaleKind;
pub use crate::summary::SummaryId;
pub use crate::summary::SummaryRecord;
pub use crate::summary::SummaryRef;
pub use crate::summary::SummarySubject;
pub use crate::tenant::TenantId;

Modules§

anchor
Plan 11: anchor / citation URI parser.
attribute
Plan 11: typed metadata attributes attached to memory rows.
audit
Audit-log op tags.
builder
Memory::builder() and the runtime open path.
canonical_keys
Canonical, opt-in attribute key conventions.
capabilities
Self-declared plugin capabilities (OpenDAL pattern).
codec
Codec plugin trait — interface stub for slice 1.
content
Memory content (Markdown / plain text) plus content-hash plumbing.
context
Plan 12 phase I — Memory::build_context(focus, opts).
embedder
Embedder plugin trait + registry.
error
Public error type. #[non_exhaustive] so adding variants is non-breaking.
event
Live observer stream. Sibling to the audit log: the audit log is the historical record (queryable via SQL); this is the push side (subscribe via Memory::subscribe).
evolve
Plan 16: atomic batch evolution of the memory catalog.
graph
Plan 10 multi-hop traversal types — NodeRef, EdgeKind, Graph, TraverseOpts. The actual Memory::traverse implementation lives on crate::Memory (see handle.rs).
handle
Public engine handle.
index
Per-leaf index surface — pluggable vector + lexical traits and the default sqlite-vec / FTS5 implementations.
link
Explicit / inferred links between memories.
memory
Memory identity, references, and read-side records.
metadata
Metadata store trait + helper structs. SQLite impl in sqlite submodule.
migrate
Plan 12 phase H — partition scheme evolution.
ops
Plan 18 step 14 — operational APIs for SQLite-backed stores.
opts
Option / option-builder structs for the public API.
partition
Partition scheme parsing, partition-path encoding, call-site Partitions builder.
query
Public Query for Memory::search.
regen
Plan 12: regeneration knobs and reports.
reranker
Reranker plugin trait — interface stub for slice 1.
search
Memory::search and Memory::related.
snapshot
Plan 12: point-in-time snapshots.
storage
Storage trait + helpers. Concrete impls live in submodules.
summarizer
Summarizer plugin trait + registry.
summary
Summary identity, references, and read-side records.
tenancy
Per-tenant single-writer mutex registry.
tenant
Tenant identity newtype with strict charset validation.
util
Misc utilities used across modules.

Constants§

VERSION
Crate version — written into audit log entries.