vera-doc¶
vera-doc publishes the vera Python package. It owns the portable SQLite
format implementation, typed records, transactional CRUD, embeddings, search,
corpus queries, and rebuildable library indexes.
It intentionally does not parse PDFs, perform OCR, provide the CLI, expose MCP tools, or implement the desktop application.
Install¶
From PyPI:
From a repository checkout:
Python 3.10 or newer is required. The default hashing embedder works locally
without a model download or API key. Neural embeddings are available through
the optional ml extra.
Start here¶
from vera import ChunkRecord, VeraDocument
with VeraDocument.create("knowledge.vera") as document:
document.add([
ChunkRecord(
id="chunk-1",
text="The minimum pipe diameter is 12 inches.",
metadata={"source_filename": "manual.pdf", "page_start": 42},
)
])
with VeraDocument.open("knowledge.vera") as document:
results = document.search(text="minimum pipe size", top_k=5)
Documentation¶
- Concepts — archives, records, search modes, and indexes.
- Basic usage — convert, inspect, and search workflows.
- Search documents — semantic, keyword, and hybrid retrieval.
- Document libraries — corpus search and persistent indexes.
- Figures and regions — citation and viewer metadata.
- Validation and export — integrity checks and stored sources.
- Python API guide — complete CRUD and search examples.
- Runnable example.