Files
roboco/roboco/services/optimal_brain/indexes/vault_notes.py
T
d03181ab48 feat(vault): Obsidian vault V2 — janitor, archival, weekly report, KB ingest, Bases + sync runbook (#482)
* feat(vault): V2 — create-seam + drift janitor, archival, weekly org-report, KB ingest, Bases views + sync runbook

Implements the vault V2 canonical spec end to end (the splice guard shipped
separately and is reused at KB-ingest time):

- materialize-on-create: TaskService.create writes each task's note best-effort
  from the moment it exists; the transition-touch stops no-oping on live work
- drift janitor (services/vault_janitor.py + hourly _vault_janitor_loop): daily
  changed-task re-projection, random drift sample, archival pass — restart-proof
  via RoboCo/_meta/.janitor_state.json, 200/cycle caps, per-item isolation,
  processed-only resume markers, self-repairing state file
- archival: vault_archive_days (30, 0=off) moves old terminal tasks' notes to
  RoboCo/Archive/<year>/Tasks/<project>/ — one write_task code path for janitor
  and rebuild, id8 lookup across Tasks/+Archive/, alias links keep moves safe
- weekly org-report: VaultWriter.write_org_report renders Reports/<ISO-week>.md
  from MetricsService/UsageService (numbers duplicated into frontmatter for
  trend queries), once per ISO week, with a best-effort CEO notification
- KB ingest: IndexType.VAULT_NOTES + VaultNotesIndexPlugin + _vault_kb_loop
  embed the CEO's RoboCo/Notes into the RAG corpus — injection guard as a hard
  gate (flagged notes quarantined with an idempotent callout), traversal- and
  symlink-contained at both config and engine layers, content-hash dedup,
  50-ingest/cycle cap, frontmatter stripped; reaches roboco_kb_search, the
  mentor default domain, claim-time briefings (kind vault_note), and the panel
  KB browser; no migration (chunks table auto-creates; migration 030's
  CHUNK_TABLES tuple appended per the chunks_playbooks precedent)
- Bases views (Task Board.base, Reports.base — schema verified against the
  Obsidian docs) + the Mac sync runbook vault asset
- config/flags/compose: vault_archive_days, vault_report_enabled (flags card),
  vault_kb_enabled (flags card; NAS compose arms it, registry ships it off),
  vault_kb_dirs (+ overlap/traversal validator), vault_kb_interval_seconds
- e2e smoke (tests/e2e_smoke/test_vault_v2.py): real create-seam, real janitor
  cycle incl. archival + state, real KB engine + real guard

* docs: vault V2 sweep — map, RAG corpus, CLAUDE.md

- docs/map/vault.md: V1+V2 — janitor/archival/report/KB data flows, new files,
  config, health posture
- docs/map/orchestrator.md + task-service.md: the two new loops, the create
  seam, the three janitor queries
- docs/rag/architecture/obsidian-vault.md: agent-facing what-changed (notes
  from creation, archive link-safety, CEO notes retrievable, weekly report)
- docs/rag/architecture/config-reference.md: the five new settings
- CLAUDE.md: vault paragraph covers V1+V2; flags-card list mentions the vault
  report/KB flags

---------

Co-authored-by: Renn F <rennf93@users.noreply.github.com>
2026-07-11 15:51:19 +02:00

71 lines
2.6 KiB
Python

"""
Vault Notes Index Plugin
Indexes human-authored Obsidian vault notes (the CEO's own writing under
``vault_kb_dirs``, default ``RoboCo/Notes``) so the fleet can retrieve them
alongside learnings/playbooks. Mirrors the PlaybooksIndexPlugin shape; the
embed + pgvector ingest/search machinery is inherited from BaseIndexPlugin.
Never covers Tasks/Journals/A2A/Agents (already DB-indexed as first-class
corpora) or the intake Inbox (config-load validation rejects the overlap) —
enforced by ``VaultKBEngine``'s dir allowlist, not here.
"""
from typing import Any
from roboco.models.optimal import IndexType, SearchResult
from roboco.services.optimal_brain.indexes.base import BaseIndexPlugin, IngestResult
class VaultNotesIndexPlugin(BaseIndexPlugin):
"""Index + search human-authored vault notes."""
@property
def index_type(self) -> IndexType:
return IndexType.VAULT_NOTES
def prepare_metadata(self, content: str, **kwargs: Any) -> dict[str, Any]:
"""Prepare metadata for a vault note (path is the stable identity)."""
del content # Unused - metadata comes from kwargs
return {
"type": "vault_note",
"source": "vault",
"path": str(kwargs.get("path", "")),
"title": str(kwargs.get("title", "")),
"content_hash": str(kwargs.get("content_hash", "")),
}
def build_source_uri(self, doc_id: str | None = None, **kwargs: Any) -> str | None:
"""Build the source URI for a vault note (``doc_id`` is its vault-relative
path), or None if missing."""
del kwargs # Unused - URI uses doc_id only
return f"vault://{doc_id}" if doc_id else None
async def index_note(
self, *, path: str, title: str, content: str, content_hash: str
) -> IngestResult:
"""Embed one vault note's body, keyed by its vault-relative path."""
return await self.ingest(
content=content,
doc_id=path,
path=path,
title=title,
content_hash=content_hash,
)
async def delete_note(self, path: str) -> None:
"""Remove a deleted/moved note's embedded chunks from the vector store.
Idempotent: the store's ``delete_by_source`` no-ops when no chunks
match the source URI.
"""
source = self.build_source_uri(doc_id=path)
if not source:
return
await self._require_store.delete_by_source(source)
async def search_notes(self, query: str, top_k: int = 10) -> list[SearchResult]:
"""Search vault notes."""
outcome = await self.search(query=query, top_k=top_k)
return outcome.results