Vapora/docs/adrs/0013-knowledge-graph.html
Jesús Pérez 7110ffeea2
Some checks failed
Rust CI / Security Audit (push) Has been cancelled
Rust CI / Check + Test + Lint (nightly) (push) Has been cancelled
Rust CI / Check + Test + Lint (stable) (push) Has been cancelled
chore: extend doc: adr, tutorials, operations, etc
2026-01-12 03:32:47 +00:00

487 lines
21 KiB
HTML

<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>0013: Knowledge Graph - VAPORA Platform Documentation</title>
<!-- Custom HTML head -->
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<!-- Provide site root and default themes to javascript -->
<script>
const path_to_root = "../";
const default_light_theme = "light";
const default_dark_theme = "dark";
</script>
<!-- Start loading toc.js asap -->
<script src="../toc.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd></kbd> or <kbd></kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
let sidebar = null;
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">VAPORA Platform Documentation</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0013-knowledge-graph.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="adr-013-knowledge-graph-temporal-con-surrealdb"><a class="header" href="#adr-013-knowledge-graph-temporal-con-surrealdb">ADR-013: Knowledge Graph Temporal con SurrealDB</a></h1>
<p><strong>Status</strong>: Accepted | Implemented
<strong>Date</strong>: 2024-11-01
<strong>Deciders</strong>: Architecture Team
<strong>Technical Story</strong>: Enabling collective agent learning through temporal execution history</p>
<hr />
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
<p>Implementar <strong>Knowledge Graph temporal</strong> en SurrealDB con historia de ejecución, curvas de aprendizaje, y búsqueda de similaridad.</p>
<hr />
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
<ol>
<li><strong>Collective Learning</strong>: Agentes aprenden de experiencia compartida (no solo individual)</li>
<li><strong>Temporal History</strong>: Histórico de 30/90 días permite identificar tendencias</li>
<li><strong>Causal Relationships</strong>: Graph permite rastrear raíces de problemas y soluciones</li>
<li><strong>Similarity Search</strong>: Encontrar soluciones pasadas para tareas similares</li>
<li><strong>SurrealDB Native</strong>: Graph queries integradas en mismo DB que relacional</li>
</ol>
<hr />
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
<h3 id="-event-log-only-no-graph"><a class="header" href="#-event-log-only-no-graph">❌ Event Log Only (No Graph)</a></h3>
<ul>
<li><strong>Pros</strong>: Simple</li>
<li><strong>Cons</strong>: Sin relaciones causales, búsqueda ineficiente</li>
</ul>
<h3 id="-separate-graph-db-neo4j"><a class="header" href="#-separate-graph-db-neo4j">❌ Separate Graph DB (Neo4j)</a></h3>
<ul>
<li><strong>Pros</strong>: Optimizado para graph</li>
<li><strong>Cons</strong>: Duplicación de datos, sincronización complexity</li>
</ul>
<h3 id="-surrealdb-temporal-kg-chosen"><a class="header" href="#-surrealdb-temporal-kg-chosen">✅ SurrealDB Temporal KG (CHOSEN)</a></h3>
<ul>
<li>Unificado, temporal, graph queries integradas</li>
</ul>
<hr />
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
<p><strong>Pros</strong>:</p>
<ul>
<li>✅ Temporal data (30/90 day retention)</li>
<li>✅ Causal relationships traceable</li>
<li>✅ Similarity search for solution discovery</li>
<li>✅ Learning curves identify improvement trends</li>
<li>✅ Single database (no sync issues)</li>
</ul>
<p><strong>Cons</strong>:</p>
<ul>
<li>⚠️ Graph queries more complex than relational</li>
<li>⚠️ Storage overhead for full history</li>
<li>⚠️ Retention policy trade-off: longer history = more storage</li>
</ul>
<hr />
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
<p><strong>Temporal Data Model</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-knowledge-graph/src/models.rs
pub struct ExecutionRecord {
pub id: String,
pub agent_id: String,
pub task_id: String,
pub task_type: String,
pub success: bool,
pub quality_score: f32,
pub latency_ms: u32,
pub cost_cents: u32,
pub timestamp: DateTime&lt;Utc&gt;,
pub daily_window: String, // YYYY-MM-DD for aggregation
}
pub struct LearningCurve {
pub id: String,
pub agent_id: String,
pub task_type: String,
pub day: String, // YYYY-MM-DD
pub success_rate: f32,
pub avg_quality: f32,
pub trend: TrendDirection, // Improving, Stable, Declining
}
<span class="boring">}</span></code></pre></pre>
<p><strong>SurrealDB Schema</strong>:</p>
<pre><code class="language-surql">-- Define execution records table
DEFINE TABLE executions;
DEFINE FIELD agent_id ON TABLE executions TYPE string;
DEFINE FIELD task_id ON TABLE executions TYPE string;
DEFINE FIELD task_type ON TABLE executions TYPE string;
DEFINE FIELD success ON TABLE executions TYPE boolean;
DEFINE FIELD quality_score ON TABLE executions TYPE float;
DEFINE FIELD timestamp ON TABLE executions TYPE datetime;
DEFINE FIELD daily_window ON TABLE executions TYPE string;
-- Define temporal index for efficient time-range queries
DEFINE INDEX idx_execution_temporal ON TABLE executions
COLUMNS timestamp, daily_window;
-- Define learning curves table
DEFINE TABLE learning_curves;
DEFINE FIELD agent_id ON TABLE learning_curves TYPE string;
DEFINE FIELD task_type ON TABLE learning_curves TYPE string;
DEFINE FIELD day ON TABLE learning_curves TYPE string;
DEFINE FIELD success_rate ON TABLE learning_curves TYPE float;
DEFINE FIELD trend ON TABLE learning_curves TYPE string;
</code></pre>
<p><strong>Temporal Query (30-Day Learning Curve)</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// crates/vapora-knowledge-graph/src/learning.rs
pub async fn compute_learning_curve(
db: &amp;Surreal&lt;Ws&gt;,
agent_id: &amp;str,
task_type: &amp;str,
days: u32,
) -&gt; Result&lt;Vec&lt;LearningCurve&gt;&gt; {
let since = (Utc::now() - Duration::days(days as i64))
.format("%Y-%m-%d")
.to_string();
let query = format!(
r#"
SELECT
day,
count(id) as total_tasks,
count(id WHERE success = true) / count(id) as success_rate,
avg(quality_score) as avg_quality,
(avg(quality_score) - LAG(avg(quality_score)) OVER (ORDER BY day)) as trend
FROM executions
WHERE agent_id = {} AND task_type = {} AND daily_window &gt;= {}
GROUP BY daily_window
ORDER BY daily_window ASC
"#,
agent_id, task_type, since
);
db.query(query).await?
.take::&lt;Vec&lt;LearningCurve&gt;&gt;(0)?
.ok_or(Error::NotFound)
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Similarity Search (Find Past Solutions)</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub async fn find_similar_tasks(
db: &amp;Surreal&lt;Ws&gt;,
task: &amp;Task,
limit: u32,
) -&gt; Result&lt;Vec&lt;(ExecutionRecord, f32)&gt;&gt; {
// Compute embedding similarity for task description
let similarity_threshold = 0.85;
let query = r#"
SELECT
executions.*,
&lt;similarity_score&gt; as score
FROM executions
WHERE similarity_score &gt; {} AND success = true
ORDER BY similarity_score DESC
LIMIT {}
"#;
db.query(query)
.bind(("similarity_score", similarity_threshold))
.bind(("limit", limit))
.await?
.take::&lt;Vec&lt;(ExecutionRecord, f32)&gt;&gt;(0)?
.ok_or(Error::NotFound)
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Causal Graph (Problem Resolution)</strong>:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub async fn trace_solution_chain(
db: &amp;Surreal&lt;Ws&gt;,
problem_task_id: &amp;str,
) -&gt; Result&lt;Vec&lt;ExecutionRecord&gt;&gt; {
let query = format!(
r#"
SELECT
-&gt;(resolved_by)-&gt;executions AS solutions
FROM tasks
WHERE id = {}
"#,
problem_task_id
);
db.query(query)
.await?
.take::&lt;Vec&lt;ExecutionRecord&gt;&gt;(0)?
.ok_or(Error::NotFound)
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Key Files</strong>:</p>
<ul>
<li><code>/crates/vapora-knowledge-graph/src/learning.rs</code> (learning curve computation)</li>
<li><code>/crates/vapora-knowledge-graph/src/persistence.rs</code> (DB persistence)</li>
<li><code>/crates/vapora-knowledge-graph/src/models.rs</code> (temporal models)</li>
<li><code>/crates/vapora-backend/src/services/</code> (uses KG for task recommendations)</li>
</ul>
<hr />
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
<pre><code class="language-bash"># Test learning curve computation
cargo test -p vapora-knowledge-graph test_learning_curve_30day
# Test similarity search
cargo test -p vapora-knowledge-graph test_similarity_search
# Test causal graph traversal
cargo test -p vapora-knowledge-graph test_causal_chain
# Test retention policy (30-day window)
cargo test -p vapora-knowledge-graph test_retention_policy
# Integration test: full KG workflow
cargo test -p vapora-knowledge-graph test_full_kg_lifecycle
# Query performance test
cargo bench -p vapora-knowledge-graph bench_temporal_queries
</code></pre>
<p><strong>Expected Output</strong>:</p>
<ul>
<li>Learning curves computed correctly</li>
<li>Similarity search finds relevant past executions</li>
<li>Causal chains traceable</li>
<li>Retention policy removes old records</li>
<li>Temporal queries perform well (&lt;100ms)</li>
</ul>
<hr />
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
<h3 id="data-management"><a class="header" href="#data-management">Data Management</a></h3>
<ul>
<li>Storage grows ~1MB per 1000 executions (depends on detail level)</li>
<li>Retention policy: 30 days (users), 90 days (enterprise)</li>
<li>Archival strategy for historical analysis</li>
</ul>
<h3 id="agent-learning"><a class="header" href="#agent-learning">Agent Learning</a></h3>
<ul>
<li>Agents access KG to find similar past solutions</li>
<li>Learning curves inform agent selection (see ADR-014)</li>
<li>Improvement trends visible for monitoring</li>
</ul>
<h3 id="observability"><a class="header" href="#observability">Observability</a></h3>
<ul>
<li>Full audit trail of agent decisions</li>
<li>Trending analysis for capacity planning</li>
<li>Incident investigation via causal chains</li>
</ul>
<h3 id="scalability"><a class="header" href="#scalability">Scalability</a></h3>
<ul>
<li>Graph queries optimized with indexes</li>
<li>Temporal queries use daily windows (efficient partition)</li>
<li>Similarity search scales to millions of records</li>
</ul>
<hr />
<h2 id="references"><a class="header" href="#references">References</a></h2>
<ul>
<li><code>/crates/vapora-knowledge-graph/src/learning.rs</code> (implementation)</li>
<li><code>/crates/vapora-knowledge-graph/src/persistence.rs</code> (persistence layer)</li>
<li>ADR-004 (SurrealDB)</li>
<li>ADR-014 (Learning Profiles)</li>
<li>ADR-019 (Temporal Execution History)</li>
</ul>
<hr />
<p><strong>Related ADRs</strong>: ADR-004 (SurrealDB), ADR-014 (Learning Profiles), ADR-019 (Temporal History)</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../../adrs/0012-llm-routing-tiers.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../adrs/0014-learning-profiles.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../../adrs/0012-llm-routing-tiers.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../adrs/0014-learning-profiles.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>
<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>
<!-- Custom JS scripts -->
</div>
</body>
</html>