Crate memvid_core

Crate memvid_core 

Source

Re-exports§

pub use enrichment_worker::EnrichmentWorkerConfig;
pub use enrichment_worker::EnrichmentWorkerStats;
pub use error::MemvidError;
pub use error::Result;
pub use extract::DocumentProcessor;
pub use extract::ExtractedDocument;
pub use extract::ProcessorConfig;
pub use footer::CommitFooter;
pub use io::time_index::TimeIndexEntry;
pub use io::time_index::append_track as time_index_append;
pub use io::time_index::calculate_checksum as time_index_checksum;
pub use io::time_index::read_track as time_index_read;
pub use io::wal::EmbeddedWal;
pub use io::wal::WalRecord;
pub use io::wal::WalStats;
pub use lex::LexIndex;
pub use lex::LexIndexArtifact;
pub use lex::LexIndexBuilder;
pub use lex::LexSearchHit;
pub use memvid::BlobReader;
pub use memvid::EnrichmentHandle;
pub use memvid::EnrichmentStats;
pub use memvid::LockSettings;
pub use memvid::Memvid;
pub use memvid::OpenReadOptions;
pub use memvid::SketchCandidate;
pub use memvid::SketchSearchOptions;
pub use memvid::SketchSearchStats;
pub use memvid::mutation::CommitMode;
pub use memvid::mutation::CommitOptions;
pub use memvid::start_enrichment_worker;
pub use memvid::start_enrichment_worker_with_embeddings;
pub use models::ModelManifest;
pub use models::ModelManifestEntry;
pub use models::ModelVerification;
pub use models::ModelVerificationStatus;
pub use models::ModelVerifyOptions;
pub use models::verify_model_dir;
pub use models::verify_models;
pub use reader::DocumentFormat;
pub use reader::DocumentReader;
pub use reader::PassthroughReader;
pub use reader::PdfReader;
pub use reader::ReaderDiagnostics;
pub use reader::ReaderHint;
pub use reader::ReaderOutput;
pub use reader::ReaderRegistry;
pub use signature::parse_ed25519_public_key_base64;
pub use signature::verify_model_manifest;
pub use signature::verify_ticket_signature;
pub use text::NormalizedText;
pub use text::normalize_text;
pub use text::truncate_at_grapheme_boundary;
pub use types::AskCitation;
pub use types::AskMode;
pub use types::AskRequest;
pub use types::AskResponse;
pub use types::AskRetriever;
pub use types::AskStats;
pub use types::AudioSegmentMetadata;
pub use types::AuditOptions;
pub use types::AuditReport;
pub use types::CanonicalEncoding;
pub use types::DOCTOR_PLAN_VERSION;
pub use types::DocAudioMetadata;
pub use types::DocExifMetadata;
pub use types::DocGpsMetadata;
pub use types::DocMetadata;
pub use types::DoctorActionDetail;
pub use types::DoctorActionKind;
pub use types::DoctorActionPlan;
pub use types::DoctorActionReport;
pub use types::DoctorActionStatus;
pub use types::DoctorFinding;
pub use types::DoctorFindingCode;
pub use types::DoctorMetrics;
pub use types::DoctorOptions;
pub use types::DoctorPhaseDuration;
pub use types::DoctorPhaseKind;
pub use types::DoctorPhasePlan;
pub use types::DoctorPhaseReport;
pub use types::DoctorPhaseStatus;
pub use types::DoctorPlan;
pub use types::DoctorReport;
pub use types::DoctorSeverity;
pub use types::DoctorStatus;
pub use types::EmbeddingIdentity;
pub use types::EmbeddingIdentityCount;
pub use types::EmbeddingIdentitySummary;
pub use types::Frame;
pub use types::FrameId;
pub use types::FrameRole;
pub use types::FrameStatus;
pub use types::Header;
pub use types::IndexManifests;
pub use types::LexIndexManifest;
pub use types::LexSegmentDescriptor;
pub use types::MEMVID_EMBEDDING_DIMENSION_KEY;
pub use types::MEMVID_EMBEDDING_MODEL_KEY;
pub use types::MEMVID_EMBEDDING_NORMALIZED_KEY;
pub use types::MEMVID_EMBEDDING_PROVIDER_KEY;
pub use types::MediaManifest;
pub use types::MemvidHandle;
pub use types::Open;
pub use types::PutOptions;
pub use types::PutOptionsBuilder;
pub use types::Sealed;
pub use types::SearchEngineKind;
pub use types::SearchHit;
pub use types::SearchHitMetadata;
pub use types::SearchParams;
pub use types::SearchRequest;
pub use types::SearchResponse;
pub use types::SegmentCatalog;
pub use types::SegmentCommon;
pub use types::SegmentCompression;
pub use types::SegmentMeta;
pub use types::SegmentSpan;
pub use types::SourceSpan;
pub use types::Stats;
pub use types::TextChunkManifest;
pub use types::TextChunkRange;
pub use types::Ticket;
pub use types::TicketRef;
pub use types::Tier;
pub use types::TimeIndexManifest;
pub use types::TimeSegmentDescriptor;
pub use types::TimelineEntry;
pub use types::TimelineQuery;
pub use types::TimelineQueryBuilder;
pub use types::Toc;
pub use types::VecEmbedder;
pub use types::VecIndexManifest;
pub use types::VecSegmentDescriptor;
pub use types::VectorCompression;
pub use types::VerificationCheck;
pub use types::VerificationReport;
pub use types::VerificationStatus;
pub use types::EngineStamp;
pub use types::EnrichmentManifest;
pub use types::EnrichmentRecord;
pub use types::MEMORIES_TRACK_MAGIC;
pub use types::MEMORIES_TRACK_VERSION;
pub use types::MemoriesStats;
pub use types::MemoriesTrack;
pub use types::MemoryCard;
pub use types::MemoryCardBuilder;
pub use types::MemoryCardBuilderError;
pub use types::MemoryCardId;
pub use types::MemoryKind;
pub use types::Polarity;
pub use types::SlotIndex;
pub use types::VersionRelation;
pub use types::EdgeDirection;
pub use types::EntityKind;
pub use types::FollowResult;
pub use types::LOGIC_MESH_MAGIC;
pub use types::LOGIC_MESH_VERSION;
pub use types::LinkType;
pub use types::LogicMesh;
pub use types::LogicMeshManifest;
pub use types::MeshEdge;
pub use types::MeshNode;
pub use types::DEFAULT_HAMMING_THRESHOLD;
pub use types::QuerySketch;
pub use types::SKETCH_TRACK_MAGIC;
pub use types::SKETCH_TRACK_VERSION;
pub use types::SketchEntry;
pub use types::SketchFlags;
pub use types::SketchTrack;
pub use types::SketchTrackHeader;
pub use types::SketchTrackManifest;
pub use types::SketchTrackStats;
pub use types::SketchVariant;
pub use types::build_term_filter;
pub use types::compute_simhash;
pub use types::compute_token_weights;
pub use types::generate_sketch;
pub use types::hash_token;
pub use types::hash_token_u32;
pub use types::read_sketch_track;
pub use types::term_filter_maybe_contains;
pub use types::tokenize_for_sketch;
pub use types::write_sketch_track;
pub use types::Cardinality;
pub use types::PredicateId;
pub use types::PredicateSchema;
pub use types::SchemaError;
pub use types::SchemaRegistry;
pub use types::ValueType;
pub use memvid::memory::SchemaSummaryEntry;
pub use enrich::EnrichmentContext;
pub use enrich::EnrichmentEngine;
pub use enrich::EnrichmentResult;
pub use enrich::RulesEngine;
pub use triplet::ExtractionMode;
pub use triplet::ExtractionStats;
pub use triplet::TripletExtractor;
pub use graph_search::GraphMatcher;
pub use graph_search::QueryPlanner;
pub use types::BatchEmbeddingResult;
pub use types::EmbeddingConfig;
pub use types::EmbeddingProvider;
pub use types::EmbeddingProviderKind;
pub use types::EmbeddingResult;
pub use types::reranker::Reranker;
pub use types::reranker::RerankerConfig;
pub use types::reranker::RerankerDocument;
pub use types::reranker::RerankerKind;
pub use types::reranker::RerankerResult;
pub use vec::VecIndex;
pub use vec::VecIndexArtifact;
pub use vec::VecSearchHit;
pub use vec_pq::CompressionStats;
pub use vec_pq::ProductQuantizer;
pub use vec_pq::QuantizedVecIndex;
pub use vec_pq::QuantizedVecIndexArtifact;
pub use vec_pq::QuantizedVecIndexBuilder;
pub use clip::CLIP_MODELS;
pub use clip::ClipConfig;
pub use clip::ClipDocument;
pub use clip::ClipEmbeddingProvider;
pub use clip::ClipError;
pub use clip::ClipIndex;
pub use clip::ClipIndexArtifact;
pub use clip::ClipIndexBuilder;
pub use clip::ClipIndexManifest;
pub use clip::ClipModelInfo;
pub use clip::ClipSearchHit;
pub use clip::ImageInfo;
pub use clip::MOBILECLIP_DIMS;
pub use clip::SIGLIP_DIMS;
pub use clip::default_model_info;
pub use clip::filter_junk_images;
pub use clip::get_model_info;
pub use whisper::TranscriptionResult;
pub use whisper::TranscriptionSegment;
pub use whisper::WHISPER_MODELS;
pub use whisper::WhisperConfig;
pub use whisper::WhisperError;
pub use whisper::WhisperModelInfo;
pub use whisper::default_whisper_model_info;
pub use whisper::get_whisper_model_info;
pub use structure::ChunkType;
pub use structure::ChunkingOptions;
pub use structure::ChunkingResult;
pub use structure::StructuralChunker;
pub use structure::StructuredChunk;
pub use structure::StructuredDocument;
pub use structure::TableChunkingStrategy;
pub use structure::chunk_structured;
pub use structure::detect_structure;
pub use types::adaptive::AdaptiveConfig;
pub use types::adaptive::AdaptiveResult;
pub use types::adaptive::AdaptiveStats;
pub use types::adaptive::CutoffStrategy;
pub use types::adaptive::find_adaptive_cutoff;
pub use types::adaptive::normalize_scores;
pub use replay::ActionType;
pub use replay::Checkpoint;
pub use replay::REPLAY_SEGMENT_MAGIC;
pub use replay::REPLAY_SEGMENT_VERSION;
pub use replay::ReplayAction;
pub use replay::ReplayManifest;
pub use replay::ReplaySession;
pub use replay::SessionSummary;
pub use replay::StateSnapshot;
pub use constants::*;

Modules§

clip
CLIP (Contrastive Language-Image Pre-training) visual embeddings module.
constants
enrich
Enrichment engine framework for extracting memory cards from frames.
enrichment_worker
Background enrichment worker for progressive ingestion.
error
extract
extract_budgeted
Time-budgeted text extraction for instant indexing.
footer
graph_search
Graph-aware search combining MemoryCards/Logic-Mesh with vector search.
io
Low-level IO primitives for interacting with .mv2 files.
lex
lockfile
memvid
Core Memvid type orchestrating .mv2 lifecycle and mutations.
models
pii
PII (Personally Identifiable Information) detection and masking
reader
Document reader traits and registry for unified format ingestion.
replay
Time-travel replay for agent sessions.
signature
structure
Structure-aware document processing for intelligent chunking.
table
Table extraction module for Memvid.
text
triplet
Automatic triplet extraction for structured knowledge storage.
types
Public types exposed by the memvid-core crate.
vec
vec_pq
Product Quantization (PQ) for vector compression
whisper
Whisper audio transcription with Candle inference.

Structs§

ExtractedEntity
Raw entity mention extracted from text
FileLock
File lock guard that can hold either a shared or exclusive OS lock.
FrameEntities
Result of extracting entities from a frame
NerModelInfo
NER model info for the models registry

Constants§

MEMVID_CORE_VERSION
The memvid-core crate version (matches Cargo.toml).
NER_MODEL_NAME
Model name for downloads and caching
NER_MODEL_SIZE_MB
Approximate model size in MB
NER_MODEL_URL
Model download URL (HuggingFace)
NER_TOKENIZER_URL
Tokenizer URL

Statics§

NER_MODELS
Available NER models registry

Functions§

default_ner_model_info
Get default NER model info
get_ner_model_info
Get NER model info by name
is_ner_model_installed
Check if NER model is installed
ner_model_path
Get the expected path for the NER model in the models directory
ner_tokenizer_path
Get the expected path for the NER tokenizer in the models directory