PlanOpticon

1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="AI-powered video analysis and knowledge extraction">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://planopticon.dev/guide/knowledge-graphs/">
16
17
18
<link rel="prev" href="../cloud-sources/">
19
20
21
<link rel="next" href="../companion/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.4">
29
30
31
32
<title>Knowledge Graphs - PlanOpticon</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
59
60
<link rel="stylesheet" href="../../assets/css/custom.css">
61
62
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
63
64
65
66
67
68
</head>
69
70
71
72
73
74
75
76
77
78
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
79
80
81
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
82
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
83
<label class="md-overlay" for="__drawer"></label>
84
<div data-md-component="skip">
85
86
87
<a href="#knowledge-graphs" class="md-skip">
88
Skip to content
89
</a>
90
91
</div>
92
<div data-md-component="announce">
93
94
</div>
95
96
97
98
99
<header class="md-header" data-md-component="header">
100
<nav class="md-header__inner md-grid" aria-label="Header">
101
<a href="../.." title="PlanOpticon" class="md-header__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
102
103
<img src="../../assets/images/conflict-logo.svg" alt="logo">
104
105
</a>
106
<label class="md-header__button md-icon" for="__drawer">
107
108
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
109
</label>
110
<div class="md-header__title" data-md-component="header-title">
111
<div class="md-header__ellipsis">
112
<div class="md-header__topic">
113
<span class="md-ellipsis">
114
PlanOpticon
115
</span>
116
</div>
117
<div class="md-header__topic" data-md-component="header-topic">
118
<span class="md-ellipsis">
119
120
Knowledge Graphs
121
122
</span>
123
</div>
124
</div>
125
</div>
126
127
128
<form class="md-header__option" data-md-component="palette">
129
130
131
132
133
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
134
135
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
136
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
137
</label>
138
139
140
141
142
143
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
144
145
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
146
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
147
</label>
148
149
150
</form>
151
152
153
154
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
155
156
157
158
159
160
<label class="md-header__button md-icon" for="__search">
161
162
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
163
</label>
164
<div class="md-search" data-md-component="search" role="dialog">
165
<label class="md-search__overlay" for="__search"></label>
166
<div class="md-search__inner" role="search">
167
<form class="md-search__form" name="search">
168
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
169
<label class="md-search__icon md-icon" for="__search">
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
172
173
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
174
</label>
175
<nav class="md-search__options" aria-label="Search">
176
177
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
178
179
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
180
</button>
181
</nav>
182
183
<div class="md-search__suggest" data-md-component="search-suggest"></div>
184
185
</form>
186
<div class="md-search__output">
187
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
188
<div class="md-search-result" data-md-component="search-result">
189
<div class="md-search-result__meta">
190
Initializing search
191
</div>
192
<ol class="md-search-result__list" role="presentation"></ol>
193
</div>
194
</div>
195
</div>
196
</div>
197
</div>
198
199
200
201
<div class="md-header__source">
202
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
203
<div class="md-source__icon md-icon">
204
205
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
206
</div>
207
<div class="md-source__repository">
208
ConflictHQ/PlanOpticon
209
</div>
210
</a>
211
</div>
212
213
</nav>
214
215
</header>
216
217
<div class="md-container" data-md-component="container">
218
219
220
221
222
223
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
224
<div class="md-grid">
225
<ul class="md-tabs__list">
226
227
228
229
230
231
232
<li class="md-tabs__item">
233
<a href="../.." class="md-tabs__link">
234
235
236
237
238
239
Home
240
241
</a>
242
</li>
243
244
245
246
247
248
249
250
251
252
253
<li class="md-tabs__item">
254
<a href="../../getting-started/installation/" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<li class="md-tabs__item md-tabs__item--active">
276
<a href="../single-video/" class="md-tabs__link">
277
278
279
280
User Guide
281
282
</a>
283
</li>
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item">
294
<a href="../../use-cases/" class="md-tabs__link">
295
296
297
298
299
300
Use Cases
301
302
</a>
303
</li>
304
305
306
307
308
309
310
311
312
<li class="md-tabs__item">
313
<a href="../../cli-reference/" class="md-tabs__link">
314
315
316
317
318
319
CLI Reference
320
321
</a>
322
</li>
323
324
325
326
327
328
329
330
331
332
333
<li class="md-tabs__item">
334
<a href="../../architecture/overview/" class="md-tabs__link">
335
336
337
338
Architecture
339
340
</a>
341
</li>
342
343
344
345
346
347
348
349
350
351
352
353
<li class="md-tabs__item">
354
<a href="../../api/models/" class="md-tabs__link">
355
356
357
358
API Reference
359
360
</a>
361
</li>
362
363
364
365
366
367
368
369
370
371
<li class="md-tabs__item">
372
<a href="../../faq/" class="md-tabs__link">
373
374
375
376
377
378
FAQ & Troubleshooting
379
380
</a>
381
</li>
382
383
384
385
386
387
388
389
390
<li class="md-tabs__item">
391
<a href="../../contributing/" class="md-tabs__link">
392
393
394
395
396
397
Contributing
398
399
</a>
400
</li>
401
402
403
404
</ul>
405
</div>
406
</nav>
407
408
409
410
<main class="md-main" data-md-component="main">
411
<div class="md-main__inner md-grid">
412
413
414
415
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
416
<div class="md-sidebar__scrollwrap">
417
<div class="md-sidebar__inner">
418
419
420
421
422
423
424
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
425
<label class="md-nav__title" for="__drawer">
426
<a href="../.." title="PlanOpticon" class="md-nav__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
427
428
<img src="../../assets/images/conflict-logo.svg" alt="logo">
429
430
</a>
431
PlanOpticon
432
</label>
433
434
<div class="md-nav__source">
435
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
436
<div class="md-source__icon md-icon">
437
438
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
439
</div>
440
<div class="md-source__repository">
441
ConflictHQ/PlanOpticon
442
</div>
443
</a>
444
</div>
445
446
<ul class="md-nav__list" data-md-scrollfix>
447
448
449
450
451
452
453
454
<li class="md-nav__item">
455
<a href="../.." class="md-nav__link">
456
457
458
459
<span class="md-ellipsis">
460
461
462
Home
463
464
465
466
</span>
467
468
469
470
</a>
471
</li>
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
<li class="md-nav__item md-nav__item--nested">
492
493
494
495
496
497
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
498
499
500
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
501
502
503
504
<span class="md-ellipsis">
505
506
507
Getting Started
508
509
510
511
</span>
512
513
514
515
<span class="md-nav__icon md-icon"></span>
516
</label>
517
518
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
519
<label class="md-nav__title" for="__nav_2">
520
<span class="md-nav__icon md-icon"></span>
521
522
523
Getting Started
524
525
526
</label>
527
<ul class="md-nav__list" data-md-scrollfix>
528
529
530
531
532
533
534
535
<li class="md-nav__item">
536
<a href="../../getting-started/installation/" class="md-nav__link">
537
538
539
540
<span class="md-ellipsis">
541
542
543
Installation
544
545
546
547
</span>
548
549
550
551
</a>
552
</li>
553
554
555
556
557
558
559
560
561
562
563
<li class="md-nav__item">
564
<a href="../../getting-started/quickstart/" class="md-nav__link">
565
566
567
568
<span class="md-ellipsis">
569
570
571
Quick Start
572
573
574
575
</span>
576
577
578
579
</a>
580
</li>
581
582
583
584
585
586
587
588
589
590
591
<li class="md-nav__item">
592
<a href="../../getting-started/configuration/" class="md-nav__link">
593
594
595
596
<span class="md-ellipsis">
597
598
599
Configuration
600
601
602
603
</span>
604
605
606
607
</a>
608
</li>
609
610
611
612
613
</ul>
614
</nav>
615
616
</li>
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
642
643
644
645
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
646
647
648
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
649
650
651
652
<span class="md-ellipsis">
653
654
655
User Guide
656
657
658
659
</span>
660
661
662
663
<span class="md-nav__icon md-icon"></span>
664
</label>
665
666
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
667
<label class="md-nav__title" for="__nav_3">
668
<span class="md-nav__icon md-icon"></span>
669
670
671
User Guide
672
673
674
</label>
675
<ul class="md-nav__list" data-md-scrollfix>
676
677
678
679
680
681
682
683
<li class="md-nav__item">
684
<a href="../single-video/" class="md-nav__link">
685
686
687
688
<span class="md-ellipsis">
689
690
691
Single Video Analysis
692
693
694
695
</span>
696
697
698
699
</a>
700
</li>
701
702
703
704
705
706
707
708
709
710
711
<li class="md-nav__item">
712
<a href="../batch/" class="md-nav__link">
713
714
715
716
<span class="md-ellipsis">
717
718
719
Batch Processing
720
721
722
723
</span>
724
725
726
727
</a>
728
</li>
729
730
731
732
733
734
735
736
737
738
739
<li class="md-nav__item">
740
<a href="../document-ingestion/" class="md-nav__link">
741
742
743
744
<span class="md-ellipsis">
745
746
747
Document Ingestion
748
749
750
751
</span>
752
753
754
755
</a>
756
</li>
757
758
759
760
761
762
763
764
765
766
767
<li class="md-nav__item">
768
<a href="../cloud-sources/" class="md-nav__link">
769
770
771
772
<span class="md-ellipsis">
773
774
775
Cloud Sources
776
777
778
779
</span>
780
781
782
783
</a>
784
</li>
785
786
787
788
789
790
791
792
793
794
795
796
797
<li class="md-nav__item md-nav__item--active">
798
799
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
800
801
802
803
804
805
<label class="md-nav__link md-nav__link--active" for="__toc">
806
807
808
809
<span class="md-ellipsis">
810
811
812
Knowledge Graphs
813
814
815
816
</span>
817
818
819
820
<span class="md-nav__icon md-icon"></span>
821
</label>
822
823
<a href="./" class="md-nav__link md-nav__link--active">
824
825
826
827
<span class="md-ellipsis">
828
829
830
Knowledge Graphs
831
832
833
834
</span>
835
836
837
838
</a>
839
840
841
842
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
843
844
845
846
847
848
849
<label class="md-nav__title" for="__toc">
850
<span class="md-nav__icon md-icon"></span>
851
Table of contents
852
</label>
853
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
854
855
<li class="md-nav__item">
856
<a href="#storage" class="md-nav__link">
857
<span class="md-ellipsis">
858
859
Storage
860
861
</span>
862
</a>
863
864
<nav class="md-nav" aria-label="Storage">
865
<ul class="md-nav__list">
866
867
<li class="md-nav__item">
868
<a href="#database-schema" class="md-nav__link">
869
<span class="md-ellipsis">
870
871
Database Schema
872
873
</span>
874
</a>
875
876
</li>
877
878
<li class="md-nav__item">
879
<a href="#storage-backends" class="md-nav__link">
880
<span class="md-ellipsis">
881
882
Storage Backends
883
884
</span>
885
</a>
886
887
</li>
888
889
</ul>
890
</nav>
891
892
</li>
893
894
<li class="md-nav__item">
895
<a href="#entity-types" class="md-nav__link">
896
<span class="md-ellipsis">
897
898
Entity Types
899
900
</span>
901
</a>
902
903
<nav class="md-nav" aria-label="Entity Types">
904
<ul class="md-nav__list">
905
906
<li class="md-nav__item">
907
<a href="#planning-taxonomy" class="md-nav__link">
908
<span class="md-ellipsis">
909
910
Planning Taxonomy
911
912
</span>
913
</a>
914
915
</li>
916
917
</ul>
918
</nav>
919
920
</li>
921
922
<li class="md-nav__item">
923
<a href="#relationship-types" class="md-nav__link">
924
<span class="md-ellipsis">
925
926
Relationship Types
927
928
</span>
929
</a>
930
931
<nav class="md-nav" aria-label="Relationship Types">
932
<ul class="md-nav__list">
933
934
<li class="md-nav__item">
935
<a href="#typed-relationships" class="md-nav__link">
936
<span class="md-ellipsis">
937
938
Typed Relationships
939
940
</span>
941
</a>
942
943
</li>
944
945
<li class="md-nav__item">
946
<a href="#relationship-checks" class="md-nav__link">
947
<span class="md-ellipsis">
948
949
Relationship Checks
950
951
</span>
952
</a>
953
954
</li>
955
956
</ul>
957
</nav>
958
959
</li>
960
961
<li class="md-nav__item">
962
<a href="#building-a-knowledge-graph" class="md-nav__link">
963
<span class="md-ellipsis">
964
965
Building a Knowledge Graph
966
967
</span>
968
</a>
969
970
<nav class="md-nav" aria-label="Building a Knowledge Graph">
971
<ul class="md-nav__list">
972
973
<li class="md-nav__item">
974
<a href="#from-video-analysis" class="md-nav__link">
975
<span class="md-ellipsis">
976
977
From Video Analysis
978
979
</span>
980
</a>
981
982
</li>
983
984
<li class="md-nav__item">
985
<a href="#from-document-ingestion" class="md-nav__link">
986
<span class="md-ellipsis">
987
988
From Document Ingestion
989
990
</span>
991
</a>
992
993
</li>
994
995
<li class="md-nav__item">
996
<a href="#from-batch-processing" class="md-nav__link">
997
<span class="md-ellipsis">
998
999
From Batch Processing
1000
1001
</span>
1002
</a>
1003
1004
</li>
1005
1006
<li class="md-nav__item">
1007
<a href="#programmatic-construction" class="md-nav__link">
1008
<span class="md-ellipsis">
1009
1010
Programmatic Construction
1011
1012
</span>
1013
</a>
1014
1015
</li>
1016
1017
</ul>
1018
</nav>
1019
1020
</li>
1021
1022
<li class="md-nav__item">
1023
<a href="#merge-and-deduplication" class="md-nav__link">
1024
<span class="md-ellipsis">
1025
1026
Merge and Deduplication
1027
1028
</span>
1029
</a>
1030
1031
<nav class="md-nav" aria-label="Merge and Deduplication">
1032
<ul class="md-nav__list">
1033
1034
<li class="md-nav__item">
1035
<a href="#fuzzy-name-matching" class="md-nav__link">
1036
<span class="md-ellipsis">
1037
1038
Fuzzy Name Matching
1039
1040
</span>
1041
</a>
1042
1043
</li>
1044
1045
<li class="md-nav__item">
1046
<a href="#type-conflict-resolution" class="md-nav__link">
1047
<span class="md-ellipsis">
1048
1049
Type Conflict Resolution
1050
1051
</span>
1052
</a>
1053
1054
</li>
1055
1056
<li class="md-nav__item">
1057
<a href="#provenance-tracking" class="md-nav__link">
1058
<span class="md-ellipsis">
1059
1060
Provenance Tracking
1061
1062
</span>
1063
</a>
1064
1065
</li>
1066
1067
<li class="md-nav__item">
1068
<a href="#programmatic-merge" class="md-nav__link">
1069
<span class="md-ellipsis">
1070
1071
Programmatic Merge
1072
1073
</span>
1074
</a>
1075
1076
</li>
1077
1078
</ul>
1079
</nav>
1080
1081
</li>
1082
1083
<li class="md-nav__item">
1084
<a href="#querying" class="md-nav__link">
1085
<span class="md-ellipsis">
1086
1087
Querying
1088
1089
</span>
1090
</a>
1091
1092
<nav class="md-nav" aria-label="Querying">
1093
<ul class="md-nav__list">
1094
1095
<li class="md-nav__item">
1096
<a href="#direct-mode" class="md-nav__link">
1097
<span class="md-ellipsis">
1098
1099
Direct Mode
1100
1101
</span>
1102
</a>
1103
1104
<nav class="md-nav" aria-label="Direct Mode">
1105
<ul class="md-nav__list">
1106
1107
<li class="md-nav__item">
1108
<a href="#stats" class="md-nav__link">
1109
<span class="md-ellipsis">
1110
1111
Stats
1112
1113
</span>
1114
</a>
1115
1116
</li>
1117
1118
<li class="md-nav__item">
1119
<a href="#entities" class="md-nav__link">
1120
<span class="md-ellipsis">
1121
1122
Entities
1123
1124
</span>
1125
</a>
1126
1127
</li>
1128
1129
<li class="md-nav__item">
1130
<a href="#neighbors" class="md-nav__link">
1131
<span class="md-ellipsis">
1132
1133
Neighbors
1134
1135
</span>
1136
</a>
1137
1138
</li>
1139
1140
<li class="md-nav__item">
1141
<a href="#relationships" class="md-nav__link">
1142
<span class="md-ellipsis">
1143
1144
Relationships
1145
1146
</span>
1147
</a>
1148
1149
</li>
1150
1151
<li class="md-nav__item">
1152
<a href="#sources" class="md-nav__link">
1153
<span class="md-ellipsis">
1154
1155
Sources
1156
1157
</span>
1158
</a>
1159
1160
</li>
1161
1162
<li class="md-nav__item">
1163
<a href="#provenance" class="md-nav__link">
1164
<span class="md-ellipsis">
1165
1166
Provenance
1167
1168
</span>
1169
</a>
1170
1171
</li>
1172
1173
<li class="md-nav__item">
1174
<a href="#raw-sql" class="md-nav__link">
1175
<span class="md-ellipsis">
1176
1177
Raw SQL
1178
1179
</span>
1180
</a>
1181
1182
</li>
1183
1184
</ul>
1185
</nav>
1186
1187
</li>
1188
1189
<li class="md-nav__item">
1190
<a href="#agentic-mode" class="md-nav__link">
1191
<span class="md-ellipsis">
1192
1193
Agentic Mode
1194
1195
</span>
1196
</a>
1197
1198
</li>
1199
1200
</ul>
1201
</nav>
1202
1203
</li>
1204
1205
<li class="md-nav__item">
1206
<a href="#graph-query-engine-python-api" class="md-nav__link">
1207
<span class="md-ellipsis">
1208
1209
Graph Query Engine Python API
1210
1211
</span>
1212
</a>
1213
1214
<nav class="md-nav" aria-label="Graph Query Engine Python API">
1215
<ul class="md-nav__list">
1216
1217
<li class="md-nav__item">
1218
<a href="#initialization" class="md-nav__link">
1219
<span class="md-ellipsis">
1220
1221
Initialization
1222
1223
</span>
1224
</a>
1225
1226
</li>
1227
1228
<li class="md-nav__item">
1229
<a href="#queryresult" class="md-nav__link">
1230
<span class="md-ellipsis">
1231
1232
QueryResult
1233
1234
</span>
1235
</a>
1236
1237
</li>
1238
1239
</ul>
1240
</nav>
1241
1242
</li>
1243
1244
<li class="md-nav__item">
1245
<a href="#the-self-contained-html-viewer" class="md-nav__link">
1246
<span class="md-ellipsis">
1247
1248
The Self-Contained HTML Viewer
1249
1250
</span>
1251
</a>
1252
1253
</li>
1254
1255
<li class="md-nav__item">
1256
<a href="#kg-management-commands" class="md-nav__link">
1257
<span class="md-ellipsis">
1258
1259
KG Management Commands
1260
1261
</span>
1262
</a>
1263
1264
<nav class="md-nav" aria-label="KG Management Commands">
1265
<ul class="md-nav__list">
1266
1267
<li class="md-nav__item">
1268
<a href="#kg-convert" class="md-nav__link">
1269
<span class="md-ellipsis">
1270
1271
kg convert
1272
1273
</span>
1274
</a>
1275
1276
</li>
1277
1278
<li class="md-nav__item">
1279
<a href="#kg-sync" class="md-nav__link">
1280
<span class="md-ellipsis">
1281
1282
kg sync
1283
1284
</span>
1285
</a>
1286
1287
</li>
1288
1289
<li class="md-nav__item">
1290
<a href="#kg-inspect" class="md-nav__link">
1291
<span class="md-ellipsis">
1292
1293
kg inspect
1294
1295
</span>
1296
</a>
1297
1298
</li>
1299
1300
<li class="md-nav__item">
1301
<a href="#kg-classify" class="md-nav__link">
1302
<span class="md-ellipsis">
1303
1304
kg classify
1305
1306
</span>
1307
</a>
1308
1309
</li>
1310
1311
<li class="md-nav__item">
1312
<a href="#kg-from-exchange" class="md-nav__link">
1313
<span class="md-ellipsis">
1314
1315
kg from-exchange
1316
1317
</span>
1318
</a>
1319
1320
</li>
1321
1322
</ul>
1323
</nav>
1324
1325
</li>
1326
1327
<li class="md-nav__item">
1328
<a href="#output-formats" class="md-nav__link">
1329
<span class="md-ellipsis">
1330
1331
Output Formats
1332
1333
</span>
1334
</a>
1335
1336
<nav class="md-nav" aria-label="Output Formats">
1337
<ul class="md-nav__list">
1338
1339
<li class="md-nav__item">
1340
<a href="#text-default" class="md-nav__link">
1341
<span class="md-ellipsis">
1342
1343
Text (default)
1344
1345
</span>
1346
</a>
1347
1348
</li>
1349
1350
<li class="md-nav__item">
1351
<a href="#json" class="md-nav__link">
1352
<span class="md-ellipsis">
1353
1354
JSON
1355
1356
</span>
1357
</a>
1358
1359
</li>
1360
1361
<li class="md-nav__item">
1362
<a href="#mermaid" class="md-nav__link">
1363
<span class="md-ellipsis">
1364
1365
Mermaid
1366
1367
</span>
1368
</a>
1369
1370
</li>
1371
1372
</ul>
1373
</nav>
1374
1375
</li>
1376
1377
<li class="md-nav__item">
1378
<a href="#auto-discovery" class="md-nav__link">
1379
<span class="md-ellipsis">
1380
1381
Auto-Discovery
1382
1383
</span>
1384
</a>
1385
1386
</li>
1387
1388
</ul>
1389
1390
</nav>
1391
1392
</li>
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
<li class="md-nav__item">
1404
<a href="../companion/" class="md-nav__link">
1405
1406
1407
1408
<span class="md-ellipsis">
1409
1410
1411
Interactive Companion
1412
1413
1414
1415
</span>
1416
1417
1418
1419
</a>
1420
</li>
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
<li class="md-nav__item">
1432
<a href="../planning-agent/" class="md-nav__link">
1433
1434
1435
1436
<span class="md-ellipsis">
1437
1438
1439
Planning Agent
1440
1441
1442
1443
</span>
1444
1445
1446
1447
</a>
1448
</li>
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
<li class="md-nav__item">
1460
<a href="../authentication/" class="md-nav__link">
1461
1462
1463
1464
<span class="md-ellipsis">
1465
1466
1467
Authentication
1468
1469
1470
1471
</span>
1472
1473
1474
1475
</a>
1476
</li>
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
<li class="md-nav__item">
1488
<a href="../export/" class="md-nav__link">
1489
1490
1491
1492
<span class="md-ellipsis">
1493
1494
1495
Export & Documents
1496
1497
1498
1499
</span>
1500
1501
1502
1503
</a>
1504
</li>
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
<li class="md-nav__item">
1516
<a href="../output-formats/" class="md-nav__link">
1517
1518
1519
1520
<span class="md-ellipsis">
1521
1522
1523
Output Formats
1524
1525
1526
1527
</span>
1528
1529
1530
1531
</a>
1532
</li>
1533
1534
1535
1536
1537
</ul>
1538
</nav>
1539
1540
</li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
<li class="md-nav__item">
1551
<a href="../../use-cases/" class="md-nav__link">
1552
1553
1554
1555
<span class="md-ellipsis">
1556
1557
1558
Use Cases
1559
1560
1561
1562
</span>
1563
1564
1565
1566
</a>
1567
</li>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
<li class="md-nav__item">
1578
<a href="../../cli-reference/" class="md-nav__link">
1579
1580
1581
1582
<span class="md-ellipsis">
1583
1584
1585
CLI Reference
1586
1587
1588
1589
</span>
1590
1591
1592
1593
</a>
1594
</li>
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
<li class="md-nav__item md-nav__item--nested">
1615
1616
1617
1618
1619
1620
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
1621
1622
1623
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1624
1625
1626
1627
<span class="md-ellipsis">
1628
1629
1630
Architecture
1631
1632
1633
1634
</span>
1635
1636
1637
1638
<span class="md-nav__icon md-icon"></span>
1639
</label>
1640
1641
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1642
<label class="md-nav__title" for="__nav_6">
1643
<span class="md-nav__icon md-icon"></span>
1644
1645
1646
Architecture
1647
1648
1649
</label>
1650
<ul class="md-nav__list" data-md-scrollfix>
1651
1652
1653
1654
1655
1656
1657
1658
<li class="md-nav__item">
1659
<a href="../../architecture/overview/" class="md-nav__link">
1660
1661
1662
1663
<span class="md-ellipsis">
1664
1665
1666
Overview
1667
1668
1669
1670
</span>
1671
1672
1673
1674
</a>
1675
</li>
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
<li class="md-nav__item">
1687
<a href="../../architecture/providers/" class="md-nav__link">
1688
1689
1690
1691
<span class="md-ellipsis">
1692
1693
1694
Provider System
1695
1696
1697
1698
</span>
1699
1700
1701
1702
</a>
1703
</li>
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
<li class="md-nav__item">
1715
<a href="../../architecture/pipeline/" class="md-nav__link">
1716
1717
1718
1719
<span class="md-ellipsis">
1720
1721
1722
Processing Pipeline
1723
1724
1725
1726
</span>
1727
1728
1729
1730
</a>
1731
</li>
1732
1733
1734
1735
1736
</ul>
1737
</nav>
1738
1739
</li>
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
<li class="md-nav__item md-nav__item--nested">
1760
1761
1762
1763
1764
1765
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
1766
1767
1768
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
1769
1770
1771
1772
<span class="md-ellipsis">
1773
1774
1775
API Reference
1776
1777
1778
1779
</span>
1780
1781
1782
1783
<span class="md-nav__icon md-icon"></span>
1784
</label>
1785
1786
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1787
<label class="md-nav__title" for="__nav_7">
1788
<span class="md-nav__icon md-icon"></span>
1789
1790
1791
API Reference
1792
1793
1794
</label>
1795
<ul class="md-nav__list" data-md-scrollfix>
1796
1797
1798
1799
1800
1801
1802
1803
<li class="md-nav__item">
1804
<a href="../../api/models/" class="md-nav__link">
1805
1806
1807
1808
<span class="md-ellipsis">
1809
1810
1811
Models
1812
1813
1814
1815
</span>
1816
1817
1818
1819
</a>
1820
</li>
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
<li class="md-nav__item">
1832
<a href="../../api/providers/" class="md-nav__link">
1833
1834
1835
1836
<span class="md-ellipsis">
1837
1838
1839
Providers
1840
1841
1842
1843
</span>
1844
1845
1846
1847
</a>
1848
</li>
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
<li class="md-nav__item">
1860
<a href="../../api/analyzers/" class="md-nav__link">
1861
1862
1863
1864
<span class="md-ellipsis">
1865
1866
1867
Analyzers
1868
1869
1870
1871
</span>
1872
1873
1874
1875
</a>
1876
</li>
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
<li class="md-nav__item">
1888
<a href="../../api/agent/" class="md-nav__link">
1889
1890
1891
1892
<span class="md-ellipsis">
1893
1894
1895
Agent & Skills
1896
1897
1898
1899
</span>
1900
1901
1902
1903
</a>
1904
</li>
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
<li class="md-nav__item">
1916
<a href="../../api/sources/" class="md-nav__link">
1917
1918
1919
1920
<span class="md-ellipsis">
1921
1922
1923
Sources
1924
1925
1926
1927
</span>
1928
1929
1930
1931
</a>
1932
</li>
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
<li class="md-nav__item">
1944
<a href="../../api/auth/" class="md-nav__link">
1945
1946
1947
1948
<span class="md-ellipsis">
1949
1950
1951
Authentication
1952
1953
1954
1955
</span>
1956
1957
1958
1959
</a>
1960
</li>
1961
1962
1963
1964
1965
</ul>
1966
</nav>
1967
1968
</li>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
<li class="md-nav__item">
1979
<a href="../../faq/" class="md-nav__link">
1980
1981
1982
1983
<span class="md-ellipsis">
1984
1985
1986
FAQ & Troubleshooting
1987
1988
1989
1990
</span>
1991
1992
1993
1994
</a>
1995
</li>
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
<li class="md-nav__item">
2006
<a href="../../contributing/" class="md-nav__link">
2007
2008
2009
2010
<span class="md-ellipsis">
2011
2012
2013
Contributing
2014
2015
2016
2017
</span>
2018
2019
2020
2021
</a>
2022
</li>
2023
2024
2025
2026
</ul>
2027
</nav>
2028
</div>
2029
</div>
2030
</div>
2031
2032
2033
2034
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2035
<div class="md-sidebar__scrollwrap">
2036
<div class="md-sidebar__inner">
2037
2038
2039
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2040
2041
2042
2043
2044
2045
2046
<label class="md-nav__title" for="__toc">
2047
<span class="md-nav__icon md-icon"></span>
2048
Table of contents
2049
</label>
2050
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2051
2052
<li class="md-nav__item">
2053
<a href="#storage" class="md-nav__link">
2054
<span class="md-ellipsis">
2055
2056
Storage
2057
2058
</span>
2059
</a>
2060
2061
<nav class="md-nav" aria-label="Storage">
2062
<ul class="md-nav__list">
2063
2064
<li class="md-nav__item">
2065
<a href="#database-schema" class="md-nav__link">
2066
<span class="md-ellipsis">
2067
2068
Database Schema
2069
2070
</span>
2071
</a>
2072
2073
</li>
2074
2075
<li class="md-nav__item">
2076
<a href="#storage-backends" class="md-nav__link">
2077
<span class="md-ellipsis">
2078
2079
Storage Backends
2080
2081
</span>
2082
</a>
2083
2084
</li>
2085
2086
</ul>
2087
</nav>
2088
2089
</li>
2090
2091
<li class="md-nav__item">
2092
<a href="#entity-types" class="md-nav__link">
2093
<span class="md-ellipsis">
2094
2095
Entity Types
2096
2097
</span>
2098
</a>
2099
2100
<nav class="md-nav" aria-label="Entity Types">
2101
<ul class="md-nav__list">
2102
2103
<li class="md-nav__item">
2104
<a href="#planning-taxonomy" class="md-nav__link">
2105
<span class="md-ellipsis">
2106
2107
Planning Taxonomy
2108
2109
</span>
2110
</a>
2111
2112
</li>
2113
2114
</ul>
2115
</nav>
2116
2117
</li>
2118
2119
<li class="md-nav__item">
2120
<a href="#relationship-types" class="md-nav__link">
2121
<span class="md-ellipsis">
2122
2123
Relationship Types
2124
2125
</span>
2126
</a>
2127
2128
<nav class="md-nav" aria-label="Relationship Types">
2129
<ul class="md-nav__list">
2130
2131
<li class="md-nav__item">
2132
<a href="#typed-relationships" class="md-nav__link">
2133
<span class="md-ellipsis">
2134
2135
Typed Relationships
2136
2137
</span>
2138
</a>
2139
2140
</li>
2141
2142
<li class="md-nav__item">
2143
<a href="#relationship-checks" class="md-nav__link">
2144
<span class="md-ellipsis">
2145
2146
Relationship Checks
2147
2148
</span>
2149
</a>
2150
2151
</li>
2152
2153
</ul>
2154
</nav>
2155
2156
</li>
2157
2158
<li class="md-nav__item">
2159
<a href="#building-a-knowledge-graph" class="md-nav__link">
2160
<span class="md-ellipsis">
2161
2162
Building a Knowledge Graph
2163
2164
</span>
2165
</a>
2166
2167
<nav class="md-nav" aria-label="Building a Knowledge Graph">
2168
<ul class="md-nav__list">
2169
2170
<li class="md-nav__item">
2171
<a href="#from-video-analysis" class="md-nav__link">
2172
<span class="md-ellipsis">
2173
2174
From Video Analysis
2175
2176
</span>
2177
</a>
2178
2179
</li>
2180
2181
<li class="md-nav__item">
2182
<a href="#from-document-ingestion" class="md-nav__link">
2183
<span class="md-ellipsis">
2184
2185
From Document Ingestion
2186
2187
</span>
2188
</a>
2189
2190
</li>
2191
2192
<li class="md-nav__item">
2193
<a href="#from-batch-processing" class="md-nav__link">
2194
<span class="md-ellipsis">
2195
2196
From Batch Processing
2197
2198
</span>
2199
</a>
2200
2201
</li>
2202
2203
<li class="md-nav__item">
2204
<a href="#programmatic-construction" class="md-nav__link">
2205
<span class="md-ellipsis">
2206
2207
Programmatic Construction
2208
2209
</span>
2210
</a>
2211
2212
</li>
2213
2214
</ul>
2215
</nav>
2216
2217
</li>
2218
2219
<li class="md-nav__item">
2220
<a href="#merge-and-deduplication" class="md-nav__link">
2221
<span class="md-ellipsis">
2222
2223
Merge and Deduplication
2224
2225
</span>
2226
</a>
2227
2228
<nav class="md-nav" aria-label="Merge and Deduplication">
2229
<ul class="md-nav__list">
2230
2231
<li class="md-nav__item">
2232
<a href="#fuzzy-name-matching" class="md-nav__link">
2233
<span class="md-ellipsis">
2234
2235
Fuzzy Name Matching
2236
2237
</span>
2238
</a>
2239
2240
</li>
2241
2242
<li class="md-nav__item">
2243
<a href="#type-conflict-resolution" class="md-nav__link">
2244
<span class="md-ellipsis">
2245
2246
Type Conflict Resolution
2247
2248
</span>
2249
</a>
2250
2251
</li>
2252
2253
<li class="md-nav__item">
2254
<a href="#provenance-tracking" class="md-nav__link">
2255
<span class="md-ellipsis">
2256
2257
Provenance Tracking
2258
2259
</span>
2260
</a>
2261
2262
</li>
2263
2264
<li class="md-nav__item">
2265
<a href="#programmatic-merge" class="md-nav__link">
2266
<span class="md-ellipsis">
2267
2268
Programmatic Merge
2269
2270
</span>
2271
</a>
2272
2273
</li>
2274
2275
</ul>
2276
</nav>
2277
2278
</li>
2279
2280
<li class="md-nav__item">
2281
<a href="#querying" class="md-nav__link">
2282
<span class="md-ellipsis">
2283
2284
Querying
2285
2286
</span>
2287
</a>
2288
2289
<nav class="md-nav" aria-label="Querying">
2290
<ul class="md-nav__list">
2291
2292
<li class="md-nav__item">
2293
<a href="#direct-mode" class="md-nav__link">
2294
<span class="md-ellipsis">
2295
2296
Direct Mode
2297
2298
</span>
2299
</a>
2300
2301
<nav class="md-nav" aria-label="Direct Mode">
2302
<ul class="md-nav__list">
2303
2304
<li class="md-nav__item">
2305
<a href="#stats" class="md-nav__link">
2306
<span class="md-ellipsis">
2307
2308
Stats
2309
2310
</span>
2311
</a>
2312
2313
</li>
2314
2315
<li class="md-nav__item">
2316
<a href="#entities" class="md-nav__link">
2317
<span class="md-ellipsis">
2318
2319
Entities
2320
2321
</span>
2322
</a>
2323
2324
</li>
2325
2326
<li class="md-nav__item">
2327
<a href="#neighbors" class="md-nav__link">
2328
<span class="md-ellipsis">
2329
2330
Neighbors
2331
2332
</span>
2333
</a>
2334
2335
</li>
2336
2337
<li class="md-nav__item">
2338
<a href="#relationships" class="md-nav__link">
2339
<span class="md-ellipsis">
2340
2341
Relationships
2342
2343
</span>
2344
</a>
2345
2346
</li>
2347
2348
<li class="md-nav__item">
2349
<a href="#sources" class="md-nav__link">
2350
<span class="md-ellipsis">
2351
2352
Sources
2353
2354
</span>
2355
</a>
2356
2357
</li>
2358
2359
<li class="md-nav__item">
2360
<a href="#provenance" class="md-nav__link">
2361
<span class="md-ellipsis">
2362
2363
Provenance
2364
2365
</span>
2366
</a>
2367
2368
</li>
2369
2370
<li class="md-nav__item">
2371
<a href="#raw-sql" class="md-nav__link">
2372
<span class="md-ellipsis">
2373
2374
Raw SQL
2375
2376
</span>
2377
</a>
2378
2379
</li>
2380
2381
</ul>
2382
</nav>
2383
2384
</li>
2385
2386
<li class="md-nav__item">
2387
<a href="#agentic-mode" class="md-nav__link">
2388
<span class="md-ellipsis">
2389
2390
Agentic Mode
2391
2392
</span>
2393
</a>
2394
2395
</li>
2396
2397
</ul>
2398
</nav>
2399
2400
</li>
2401
2402
<li class="md-nav__item">
2403
<a href="#graph-query-engine-python-api" class="md-nav__link">
2404
<span class="md-ellipsis">
2405
2406
Graph Query Engine Python API
2407
2408
</span>
2409
</a>
2410
2411
<nav class="md-nav" aria-label="Graph Query Engine Python API">
2412
<ul class="md-nav__list">
2413
2414
<li class="md-nav__item">
2415
<a href="#initialization" class="md-nav__link">
2416
<span class="md-ellipsis">
2417
2418
Initialization
2419
2420
</span>
2421
</a>
2422
2423
</li>
2424
2425
<li class="md-nav__item">
2426
<a href="#queryresult" class="md-nav__link">
2427
<span class="md-ellipsis">
2428
2429
QueryResult
2430
2431
</span>
2432
</a>
2433
2434
</li>
2435
2436
</ul>
2437
</nav>
2438
2439
</li>
2440
2441
<li class="md-nav__item">
2442
<a href="#the-self-contained-html-viewer" class="md-nav__link">
2443
<span class="md-ellipsis">
2444
2445
The Self-Contained HTML Viewer
2446
2447
</span>
2448
</a>
2449
2450
</li>
2451
2452
<li class="md-nav__item">
2453
<a href="#kg-management-commands" class="md-nav__link">
2454
<span class="md-ellipsis">
2455
2456
KG Management Commands
2457
2458
</span>
2459
</a>
2460
2461
<nav class="md-nav" aria-label="KG Management Commands">
2462
<ul class="md-nav__list">
2463
2464
<li class="md-nav__item">
2465
<a href="#kg-convert" class="md-nav__link">
2466
<span class="md-ellipsis">
2467
2468
kg convert
2469
2470
</span>
2471
</a>
2472
2473
</li>
2474
2475
<li class="md-nav__item">
2476
<a href="#kg-sync" class="md-nav__link">
2477
<span class="md-ellipsis">
2478
2479
kg sync
2480
2481
</span>
2482
</a>
2483
2484
</li>
2485
2486
<li class="md-nav__item">
2487
<a href="#kg-inspect" class="md-nav__link">
2488
<span class="md-ellipsis">
2489
2490
kg inspect
2491
2492
</span>
2493
</a>
2494
2495
</li>
2496
2497
<li class="md-nav__item">
2498
<a href="#kg-classify" class="md-nav__link">
2499
<span class="md-ellipsis">
2500
2501
kg classify
2502
2503
</span>
2504
</a>
2505
2506
</li>
2507
2508
<li class="md-nav__item">
2509
<a href="#kg-from-exchange" class="md-nav__link">
2510
<span class="md-ellipsis">
2511
2512
kg from-exchange
2513
2514
</span>
2515
</a>
2516
2517
</li>
2518
2519
</ul>
2520
</nav>
2521
2522
</li>
2523
2524
<li class="md-nav__item">
2525
<a href="#output-formats" class="md-nav__link">
2526
<span class="md-ellipsis">
2527
2528
Output Formats
2529
2530
</span>
2531
</a>
2532
2533
<nav class="md-nav" aria-label="Output Formats">
2534
<ul class="md-nav__list">
2535
2536
<li class="md-nav__item">
2537
<a href="#text-default" class="md-nav__link">
2538
<span class="md-ellipsis">
2539
2540
Text (default)
2541
2542
</span>
2543
</a>
2544
2545
</li>
2546
2547
<li class="md-nav__item">
2548
<a href="#json" class="md-nav__link">
2549
<span class="md-ellipsis">
2550
2551
JSON
2552
2553
</span>
2554
</a>
2555
2556
</li>
2557
2558
<li class="md-nav__item">
2559
<a href="#mermaid" class="md-nav__link">
2560
<span class="md-ellipsis">
2561
2562
Mermaid
2563
2564
</span>
2565
</a>
2566
2567
</li>
2568
2569
</ul>
2570
</nav>
2571
2572
</li>
2573
2574
<li class="md-nav__item">
2575
<a href="#auto-discovery" class="md-nav__link">
2576
<span class="md-ellipsis">
2577
2578
Auto-Discovery
2579
2580
</span>
2581
</a>
2582
2583
</li>
2584
2585
</ul>
2586
2587
</nav>
2588
</div>
2589
</div>
2590
</div>
2591
2592
2593
2594
<div class="md-content" data-md-component="content">
2595
2596
<article class="md-content__inner md-typeset">
2597
2598
2599
2600
2601
2602
2603
2604
2605
<h1 id="knowledge-graphs">Knowledge Graphs<a class="headerlink" href="#knowledge-graphs" title="Permanent link">&para;</a></h1>
2606
<p>PlanOpticon builds structured knowledge graphs from video analyses, document ingestion, and other content sources. A knowledge graph captures <strong>entities</strong> (people, technologies, concepts, organizations) and the <strong>relationships</strong> between them, providing a queryable representation of everything discussed or presented in your source material.</p>
2607
<hr />
2608
<h2 id="storage">Storage<a class="headerlink" href="#storage" title="Permanent link">&para;</a></h2>
2609
<p>Knowledge graphs are stored as SQLite databases (<code>knowledge_graph.db</code>) using Python's built-in <code>sqlite3</code> module. This means:</p>
2610
<ul>
2611
<li><strong>Zero external dependencies.</strong> No database server to install or manage.</li>
2612
<li><strong>Single-file portability.</strong> Copy the <code>.db</code> file to share a knowledge graph.</li>
2613
<li><strong>WAL mode.</strong> SQLite Write-Ahead Logging is enabled for concurrent read performance.</li>
2614
<li><strong>JSON fallback.</strong> Knowledge graphs can also be saved as <code>knowledge_graph.json</code> for interoperability, though SQLite is preferred for performance and querying.</li>
2615
</ul>
2616
<h3 id="database-schema">Database Schema<a class="headerlink" href="#database-schema" title="Permanent link">&para;</a></h3>
2617
<p>The SQLite store uses the following tables:</p>
2618
<table>
2619
<thead>
2620
<tr>
2621
<th>Table</th>
2622
<th>Purpose</th>
2623
</tr>
2624
</thead>
2625
<tbody>
2626
<tr>
2627
<td><code>entities</code></td>
2628
<td>Core entity records with name, type, descriptions, source, and arbitrary properties</td>
2629
</tr>
2630
<tr>
2631
<td><code>occurrences</code></td>
2632
<td>Where and when each entity was mentioned (source, timestamp, text snippet)</td>
2633
</tr>
2634
<tr>
2635
<td><code>relationships</code></td>
2636
<td>Directed edges between entities with type, content source, timestamp, and properties</td>
2637
</tr>
2638
<tr>
2639
<td><code>sources</code></td>
2640
<td>Registered content sources with provenance metadata (source type, title, path, URL, MIME type, ingestion timestamp)</td>
2641
</tr>
2642
<tr>
2643
<td><code>source_locations</code></td>
2644
<td>Links between sources and specific entities/relationships, with location details (timestamp, page, section, line range, text snippet)</td>
2645
</tr>
2646
</tbody>
2647
</table>
2648
<p>All entity lookups are case-insensitive (indexed on <code>name_lower</code>). Entities and relationships are indexed on their source and target fields for efficient traversal.</p>
2649
<h3 id="storage-backends">Storage Backends<a class="headerlink" href="#storage-backends" title="Permanent link">&para;</a></h3>
2650
<p>PlanOpticon supports two storage backends, selected automatically:</p>
2651
<table>
2652
<thead>
2653
<tr>
2654
<th>Backend</th>
2655
<th>When Used</th>
2656
<th>Persistence</th>
2657
</tr>
2658
</thead>
2659
<tbody>
2660
<tr>
2661
<td><code>SQLiteStore</code></td>
2662
<td>When a <code>db_path</code> is provided</td>
2663
<td>Persistent on disk</td>
2664
</tr>
2665
<tr>
2666
<td><code>InMemoryStore</code></td>
2667
<td>When no path is given, or as fallback</td>
2668
<td>In-memory only</td>
2669
</tr>
2670
</tbody>
2671
</table>
2672
<p>Both backends implement the same <code>GraphStore</code> abstract interface, so all query and manipulation code works identically regardless of backend.</p>
2673
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.graph_store</span><span class="w"> </span><span class="kn">import</span> <span class="n">create_store</span>
2674
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>
2675
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="c1"># Persistent SQLite store</span>
2676
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">store</span> <span class="o">=</span> <span class="n">create_store</span><span class="p">(</span><span class="s2">&quot;/path/to/knowledge_graph.db&quot;</span><span class="p">)</span>
2677
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
2678
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="c1"># In-memory store (for temporary operations)</span>
2679
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">store</span> <span class="o">=</span> <span class="n">create_store</span><span class="p">()</span>
2680
</code></pre></div>
2681
<hr />
2682
<h2 id="entity-types">Entity Types<a class="headerlink" href="#entity-types" title="Permanent link">&para;</a></h2>
2683
<p>Entities extracted from content are assigned one of the following base types:</p>
2684
<table>
2685
<thead>
2686
<tr>
2687
<th>Type</th>
2688
<th>Description</th>
2689
<th>Specificity Rank</th>
2690
</tr>
2691
</thead>
2692
<tbody>
2693
<tr>
2694
<td><code>person</code></td>
2695
<td>People mentioned or participating</td>
2696
<td>3 (highest)</td>
2697
</tr>
2698
<tr>
2699
<td><code>technology</code></td>
2700
<td>Tools, languages, frameworks, platforms</td>
2701
<td>3</td>
2702
</tr>
2703
<tr>
2704
<td><code>organization</code></td>
2705
<td>Companies, teams, departments</td>
2706
<td>2</td>
2707
</tr>
2708
<tr>
2709
<td><code>time</code></td>
2710
<td>Dates, deadlines, time references</td>
2711
<td>1</td>
2712
</tr>
2713
<tr>
2714
<td><code>diagram</code></td>
2715
<td>Visual diagrams extracted from video frames</td>
2716
<td>1</td>
2717
</tr>
2718
<tr>
2719
<td><code>concept</code></td>
2720
<td>General concepts, topics, ideas (default)</td>
2721
<td>0 (lowest)</td>
2722
</tr>
2723
</tbody>
2724
</table>
2725
<p>The specificity rank is used during merge operations: when two entities are matched as duplicates, the more specific type wins (e.g., <code>technology</code> overrides <code>concept</code>).</p>
2726
<h3 id="planning-taxonomy">Planning Taxonomy<a class="headerlink" href="#planning-taxonomy" title="Permanent link">&para;</a></h3>
2727
<p>Beyond the base entity types, PlanOpticon includes a planning taxonomy for classifying entities into project-planning categories. The <code>TaxonomyClassifier</code> maps extracted entities into these types:</p>
2728
<table>
2729
<thead>
2730
<tr>
2731
<th>Planning Type</th>
2732
<th>Keywords Matched</th>
2733
</tr>
2734
</thead>
2735
<tbody>
2736
<tr>
2737
<td><code>goal</code></td>
2738
<td>goal, objective, aim, target outcome</td>
2739
</tr>
2740
<tr>
2741
<td><code>requirement</code></td>
2742
<td>must, should, requirement, need, required</td>
2743
</tr>
2744
<tr>
2745
<td><code>constraint</code></td>
2746
<td>constraint, limitation, restrict, cannot, must not</td>
2747
</tr>
2748
<tr>
2749
<td><code>decision</code></td>
2750
<td>decided, decision, chose, selected, agreed</td>
2751
</tr>
2752
<tr>
2753
<td><code>risk</code></td>
2754
<td>risk, concern, worry, danger, threat</td>
2755
</tr>
2756
<tr>
2757
<td><code>assumption</code></td>
2758
<td>assume, assumption, expecting, presume</td>
2759
</tr>
2760
<tr>
2761
<td><code>dependency</code></td>
2762
<td>depends, dependency, relies on, prerequisite, blocked</td>
2763
</tr>
2764
<tr>
2765
<td><code>milestone</code></td>
2766
<td>milestone, deadline, deliverable, release, launch</td>
2767
</tr>
2768
<tr>
2769
<td><code>task</code></td>
2770
<td>task, todo, action item, work item, implement</td>
2771
</tr>
2772
<tr>
2773
<td><code>feature</code></td>
2774
<td>feature, capability, functionality</td>
2775
</tr>
2776
</tbody>
2777
</table>
2778
<p>Classification works in two stages:</p>
2779
<ol>
2780
<li><strong>Heuristic classification.</strong> Entity descriptions are scanned for the keywords listed above. First match wins.</li>
2781
<li><strong>LLM refinement.</strong> If an LLM provider is available, entities are sent to the LLM for more nuanced classification with priority assignment (<code>high</code>, <code>medium</code>, <code>low</code>). LLM results override heuristic results on conflicts.</li>
2782
</ol>
2783
<p>Classified entities are used by planning agent skills (project_plan, prd, roadmap, task_breakdown) to produce targeted, context-aware artifacts.</p>
2784
<hr />
2785
<h2 id="relationship-types">Relationship Types<a class="headerlink" href="#relationship-types" title="Permanent link">&para;</a></h2>
2786
<p>Relationships are directed edges between entities. The <code>type</code> field is a free-text string determined by the LLM during extraction. Common relationship types include:</p>
2787
<ul>
2788
<li><code>related_to</code> (default)</li>
2789
<li><code>works_with</code></li>
2790
<li><code>uses</code></li>
2791
<li><code>depends_on</code></li>
2792
<li><code>proposed</code></li>
2793
<li><code>discussed_by</code></li>
2794
<li><code>employed_by</code></li>
2795
<li><code>collaborates_with</code></li>
2796
<li><code>expert_in</code></li>
2797
</ul>
2798
<h3 id="typed-relationships">Typed Relationships<a class="headerlink" href="#typed-relationships" title="Permanent link">&para;</a></h3>
2799
<p>The <code>add_typed_relationship()</code> method creates edges with custom labels and optional properties, enabling richer graph semantics:</p>
2800
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">store</span><span class="o">.</span><span class="n">add_typed_relationship</span><span class="p">(</span>
2801
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a> <span class="n">source</span><span class="o">=</span><span class="s2">&quot;Authentication Service&quot;</span><span class="p">,</span>
2802
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a> <span class="n">target</span><span class="o">=</span><span class="s2">&quot;PostgreSQL&quot;</span><span class="p">,</span>
2803
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> <span class="n">edge_label</span><span class="o">=</span><span class="s2">&quot;USES_SYSTEM&quot;</span><span class="p">,</span>
2804
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a> <span class="n">properties</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;purpose&quot;</span><span class="p">:</span> <span class="s2">&quot;user credential storage&quot;</span><span class="p">,</span> <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;15&quot;</span><span class="p">},</span>
2805
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="p">)</span>
2806
</code></pre></div>
2807
<h3 id="relationship-checks">Relationship Checks<a class="headerlink" href="#relationship-checks" title="Permanent link">&para;</a></h3>
2808
<p>You can check whether a relationship exists between two entities:</p>
2809
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Check for any relationship</span>
2810
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="n">store</span><span class="o">.</span><span class="n">has_relationship</span><span class="p">(</span><span class="s2">&quot;Alice&quot;</span><span class="p">,</span> <span class="s2">&quot;Kubernetes&quot;</span><span class="p">)</span>
2811
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
2812
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># Check for a specific relationship type</span>
2813
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="n">store</span><span class="o">.</span><span class="n">has_relationship</span><span class="p">(</span><span class="s2">&quot;Alice&quot;</span><span class="p">,</span> <span class="s2">&quot;Kubernetes&quot;</span><span class="p">,</span> <span class="n">edge_label</span><span class="o">=</span><span class="s2">&quot;expert_in&quot;</span><span class="p">)</span>
2814
</code></pre></div>
2815
<hr />
2816
<h2 id="building-a-knowledge-graph">Building a Knowledge Graph<a class="headerlink" href="#building-a-knowledge-graph" title="Permanent link">&para;</a></h2>
2817
<h3 id="from-video-analysis">From Video Analysis<a class="headerlink" href="#from-video-analysis" title="Permanent link">&para;</a></h3>
2818
<p>The primary path for building a knowledge graph is through video analysis. When you run <code>planopticon analyze</code>, the pipeline extracts entities and relationships from:</p>
2819
<ul>
2820
<li><strong>Transcript segments</strong> -- batched in groups of 10 for efficient API usage, with speaker identification</li>
2821
<li><strong>Diagram content</strong> -- text extracted from visual diagrams detected in video frames</li>
2822
</ul>
2823
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>meeting.mp4<span class="w"> </span>-o<span class="w"> </span>results/
2824
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="c1"># Creates results/knowledge_graph.db</span>
2825
</code></pre></div>
2826
<h3 id="from-document-ingestion">From Document Ingestion<a class="headerlink" href="#from-document-ingestion" title="Permanent link">&para;</a></h3>
2827
<p>Documents (Markdown, PDF, DOCX) can be ingested directly into a knowledge graph:</p>
2828
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Ingest a single file</span>
2829
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span>-i<span class="w"> </span>requirements.pdf<span class="w"> </span>-o<span class="w"> </span>results/
2830
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
2831
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1"># Ingest a directory recursively</span>
2832
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span>-i<span class="w"> </span>docs/<span class="w"> </span>-o<span class="w"> </span>results/<span class="w"> </span>--recursive
2833
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>
2834
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="c1"># Ingest into an existing knowledge graph</span>
2835
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>planopticon<span class="w"> </span>ingest<span class="w"> </span>-i<span class="w"> </span>notes.md<span class="w"> </span>--db<span class="w"> </span>results/knowledge_graph.db
2836
</code></pre></div>
2837
<h3 id="from-batch-processing">From Batch Processing<a class="headerlink" href="#from-batch-processing" title="Permanent link">&para;</a></h3>
2838
<p>Multiple videos can be processed in batch mode, with all results merged into a single knowledge graph:</p>
2839
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>planopticon<span class="w"> </span>batch<span class="w"> </span>-i<span class="w"> </span>videos/<span class="w"> </span>-o<span class="w"> </span>results/
2840
</code></pre></div>
2841
<h3 id="programmatic-construction">Programmatic Construction<a class="headerlink" href="#programmatic-construction" title="Permanent link">&para;</a></h3>
2842
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.knowledge_graph</span><span class="w"> </span><span class="kn">import</span> <span class="n">KnowledgeGraph</span>
2843
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>
2844
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="c1"># Create a new knowledge graph with LLM extraction</span>
2845
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.providers.manager</span><span class="w"> </span><span class="kn">import</span> <span class="n">ProviderManager</span>
2846
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="n">pm</span> <span class="o">=</span> <span class="n">ProviderManager</span><span class="p">()</span>
2847
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="n">kg</span> <span class="o">=</span> <span class="n">KnowledgeGraph</span><span class="p">(</span><span class="n">provider_manager</span><span class="o">=</span><span class="n">pm</span><span class="p">,</span> <span class="n">db_path</span><span class="o">=</span><span class="s2">&quot;knowledge_graph.db&quot;</span><span class="p">)</span>
2848
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a>
2849
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="c1"># Add content (entities and relationships are extracted by LLM)</span>
2850
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="n">kg</span><span class="o">.</span><span class="n">add_content</span><span class="p">(</span>
2851
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a> <span class="n">text</span><span class="o">=</span><span class="s2">&quot;Alice proposed using Kubernetes for container orchestration.&quot;</span><span class="p">,</span>
2852
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a> <span class="n">source</span><span class="o">=</span><span class="s2">&quot;meeting_notes&quot;</span><span class="p">,</span>
2853
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a> <span class="n">timestamp</span><span class="o">=</span><span class="mf">120.5</span><span class="p">,</span>
2854
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a><span class="p">)</span>
2855
<a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a>
2856
<a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a><span class="c1"># Process a full transcript</span>
2857
<a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a><span class="n">kg</span><span class="o">.</span><span class="n">process_transcript</span><span class="p">(</span><span class="n">transcript_data</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
2858
<a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a>
2859
<a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a><span class="c1"># Process diagram results</span>
2860
<a id="__codelineno-6-19" name="__codelineno-6-19" href="#__codelineno-6-19"></a><span class="n">kg</span><span class="o">.</span><span class="n">process_diagrams</span><span class="p">(</span><span class="n">diagram_results</span><span class="p">)</span>
2861
<a id="__codelineno-6-20" name="__codelineno-6-20" href="#__codelineno-6-20"></a>
2862
<a id="__codelineno-6-21" name="__codelineno-6-21" href="#__codelineno-6-21"></a><span class="c1"># Save</span>
2863
<a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="n">kg</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s2">&quot;knowledge_graph.db&quot;</span><span class="p">)</span>
2864
</code></pre></div>
2865
<hr />
2866
<h2 id="merge-and-deduplication">Merge and Deduplication<a class="headerlink" href="#merge-and-deduplication" title="Permanent link">&para;</a></h2>
2867
<p>When combining knowledge graphs from multiple sources, PlanOpticon performs intelligent merge with deduplication.</p>
2868
<h3 id="fuzzy-name-matching">Fuzzy Name Matching<a class="headerlink" href="#fuzzy-name-matching" title="Permanent link">&para;</a></h3>
2869
<p>Entity names are compared using Python's <code>SequenceMatcher</code> with a threshold of 0.85. This means "Kubernetes" and "kubernetes" are matched exactly (case-insensitive), while "React.js" and "ReactJS" may be matched as duplicates if their similarity ratio meets the threshold.</p>
2870
<h3 id="type-conflict-resolution">Type Conflict Resolution<a class="headerlink" href="#type-conflict-resolution" title="Permanent link">&para;</a></h3>
2871
<p>When two entities match but have different types, the more specific type wins based on the specificity ranking:</p>
2872
<table>
2873
<thead>
2874
<tr>
2875
<th>Scenario</th>
2876
<th>Result</th>
2877
</tr>
2878
</thead>
2879
<tbody>
2880
<tr>
2881
<td><code>concept</code> vs <code>technology</code></td>
2882
<td><code>technology</code> wins (rank 3 &gt; rank 0)</td>
2883
</tr>
2884
<tr>
2885
<td><code>person</code> vs <code>concept</code></td>
2886
<td><code>person</code> wins (rank 3 &gt; rank 0)</td>
2887
</tr>
2888
<tr>
2889
<td><code>organization</code> vs <code>concept</code></td>
2890
<td><code>organization</code> wins (rank 2 &gt; rank 0)</td>
2891
</tr>
2892
<tr>
2893
<td><code>person</code> vs <code>technology</code></td>
2894
<td>Keeps whichever was first (equal rank)</td>
2895
</tr>
2896
</tbody>
2897
</table>
2898
<h3 id="provenance-tracking">Provenance Tracking<a class="headerlink" href="#provenance-tracking" title="Permanent link">&para;</a></h3>
2899
<p>Merged entities receive a <code>merged_from:&lt;original_name&gt;</code> description entry, preserving the audit trail of which entities were unified.</p>
2900
<h3 id="programmatic-merge">Programmatic Merge<a class="headerlink" href="#programmatic-merge" title="Permanent link">&para;</a></h3>
2901
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.knowledge_graph</span><span class="w"> </span><span class="kn">import</span> <span class="n">KnowledgeGraph</span>
2902
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>
2903
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="c1"># Load two knowledge graphs</span>
2904
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="n">kg1</span> <span class="o">=</span> <span class="n">KnowledgeGraph</span><span class="p">(</span><span class="n">db_path</span><span class="o">=</span><span class="s2">&quot;project_a.db&quot;</span><span class="p">)</span>
2905
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="n">kg2</span> <span class="o">=</span> <span class="n">KnowledgeGraph</span><span class="p">(</span><span class="n">db_path</span><span class="o">=</span><span class="s2">&quot;project_b.db&quot;</span><span class="p">)</span>
2906
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a>
2907
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="c1"># Merge kg2 into kg1</span>
2908
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="n">kg1</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">kg2</span><span class="p">)</span>
2909
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>
2910
<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="c1"># Save the merged result</span>
2911
<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="n">kg1</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s2">&quot;merged.db&quot;</span><span class="p">)</span>
2912
</code></pre></div>
2913
<p>The merge operation also copies all registered sources and occurrences, so provenance information is preserved across merges.</p>
2914
<hr />
2915
<h2 id="querying">Querying<a class="headerlink" href="#querying" title="Permanent link">&para;</a></h2>
2916
<p>PlanOpticon provides two query modes: direct mode (no LLM required) and agentic mode (LLM-powered natural language).</p>
2917
<h3 id="direct-mode">Direct Mode<a class="headerlink" href="#direct-mode" title="Permanent link">&para;</a></h3>
2918
<p>Direct mode queries are fast, deterministic, and require no API key. They are the right choice for structured lookups.</p>
2919
<h4 id="stats">Stats<a class="headerlink" href="#stats" title="Permanent link">&para;</a></h4>
2920
<p>Return entity count, relationship count, and entity type breakdown:</p>
2921
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>planopticon<span class="w"> </span>query
2922
</code></pre></div>
2923
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">stats</span><span class="p">()</span>
2924
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="c1"># QueryResult with data: {</span>
2925
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="c1"># &quot;entity_count&quot;: 42,</span>
2926
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="c1"># &quot;relationship_count&quot;: 87,</span>
2927
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="c1"># &quot;entity_types&quot;: {&quot;technology&quot;: 15, &quot;person&quot;: 12, ...}</span>
2928
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="c1"># }</span>
2929
</code></pre></div>
2930
<h4 id="entities">Entities<a class="headerlink" href="#entities" title="Permanent link">&para;</a></h4>
2931
<p>Filter entities by name substring and/or type:</p>
2932
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;entities --type technology&quot;</span>
2933
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;entities --name python&quot;</span>
2934
</code></pre></div>
2935
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">entities</span><span class="p">(</span><span class="n">entity_type</span><span class="o">=</span><span class="s2">&quot;technology&quot;</span><span class="p">)</span>
2936
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="n">engine</span><span class="o">.</span><span class="n">entities</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;python&quot;</span><span class="p">)</span>
2937
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="n">engine</span><span class="o">.</span><span class="n">entities</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;auth&quot;</span><span class="p">,</span> <span class="n">entity_type</span><span class="o">=</span><span class="s2">&quot;concept&quot;</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
2938
</code></pre></div>
2939
<p>All filtering is case-insensitive. Results are capped at 50 by default (configurable via <code>limit</code>).</p>
2940
<h4 id="neighbors">Neighbors<a class="headerlink" href="#neighbors" title="Permanent link">&para;</a></h4>
2941
<p>Get an entity and all directly connected nodes and relationships:</p>
2942
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;neighbors Alice&quot;</span>
2943
</code></pre></div>
2944
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">neighbors</span><span class="p">(</span><span class="s2">&quot;Alice&quot;</span><span class="p">,</span> <span class="n">depth</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
2945
</code></pre></div>
2946
<p>The <code>depth</code> parameter controls how many hops to traverse (default 1). The result includes both entity objects and relationship objects.</p>
2947
<h4 id="relationships">Relationships<a class="headerlink" href="#relationships" title="Permanent link">&para;</a></h4>
2948
<p>Filter relationships by source, target, and/or type:</p>
2949
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;relationships --source Alice&quot;</span>
2950
</code></pre></div>
2951
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">relationships</span><span class="p">(</span><span class="n">source</span><span class="o">=</span><span class="s2">&quot;Alice&quot;</span><span class="p">)</span>
2952
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="n">engine</span><span class="o">.</span><span class="n">relationships</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="s2">&quot;Kubernetes&quot;</span><span class="p">,</span> <span class="n">rel_type</span><span class="o">=</span><span class="s2">&quot;uses&quot;</span><span class="p">)</span>
2953
</code></pre></div>
2954
<h4 id="sources">Sources<a class="headerlink" href="#sources" title="Permanent link">&para;</a></h4>
2955
<p>List all registered content sources:</p>
2956
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">sources</span><span class="p">()</span>
2957
</code></pre></div>
2958
<h4 id="provenance">Provenance<a class="headerlink" href="#provenance" title="Permanent link">&para;</a></h4>
2959
<p>Get all source locations for a specific entity, showing exactly where it was mentioned:</p>
2960
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">provenance</span><span class="p">(</span><span class="s2">&quot;Kubernetes&quot;</span><span class="p">)</span>
2961
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="c1"># Returns source locations with timestamps, pages, sections, and text snippets</span>
2962
</code></pre></div>
2963
<h4 id="raw-sql">Raw SQL<a class="headerlink" href="#raw-sql" title="Permanent link">&para;</a></h4>
2964
<p>Execute arbitrary SQL against the SQLite backend (SQLite stores only):</p>
2965
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="n">engine</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s2">&quot;SELECT name, type FROM entities WHERE type = &#39;technology&#39; ORDER BY name&quot;</span><span class="p">)</span>
2966
</code></pre></div>
2967
<h3 id="agentic-mode">Agentic Mode<a class="headerlink" href="#agentic-mode" title="Permanent link">&para;</a></h3>
2968
<p>Agentic mode accepts natural-language questions and uses the LLM to plan and execute queries. It requires a configured LLM provider.</p>
2969
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;What technologies were discussed?&quot;</span>
2970
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;Who are the key people mentioned?&quot;</span>
2971
<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;What depends on the authentication service?&quot;</span>
2972
</code></pre></div>
2973
<p>The agentic query pipeline:</p>
2974
<ol>
2975
<li><strong>Plan.</strong> The LLM receives graph stats and available actions (entities, relationships, neighbors, stats). It selects exactly one action and its parameters.</li>
2976
<li><strong>Execute.</strong> The chosen action is run through the direct-mode engine.</li>
2977
<li><strong>Synthesize.</strong> The LLM receives the raw query results and the original question, then produces a concise natural-language answer.</li>
2978
</ol>
2979
<p>This design ensures the LLM never generates arbitrary code -- it only selects from a fixed set of known query actions.</p>
2980
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1"># Requires an API key</span>
2981
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>planopticon<span class="w"> </span>query<span class="w"> </span><span class="s2">&quot;What technologies were discussed?&quot;</span><span class="w"> </span>-p<span class="w"> </span>openai
2982
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>
2983
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="c1"># Use the interactive REPL for multiple queries</span>
2984
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a>planopticon<span class="w"> </span>query<span class="w"> </span>-I
2985
</code></pre></div>
2986
<hr />
2987
<h2 id="graph-query-engine-python-api">Graph Query Engine Python API<a class="headerlink" href="#graph-query-engine-python-api" title="Permanent link">&para;</a></h2>
2988
<p>The <code>GraphQueryEngine</code> class provides the programmatic interface for all query operations.</p>
2989
<h3 id="initialization">Initialization<a class="headerlink" href="#initialization" title="Permanent link">&para;</a></h3>
2990
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.graph_query</span><span class="w"> </span><span class="kn">import</span> <span class="n">GraphQueryEngine</span>
2991
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.graph_discovery</span><span class="w"> </span><span class="kn">import</span> <span class="n">find_nearest_graph</span>
2992
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>
2993
<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="c1"># From a .db file</span>
2994
<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="n">path</span> <span class="o">=</span> <span class="n">find_nearest_graph</span><span class="p">()</span>
2995
<a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="n">engine</span> <span class="o">=</span> <span class="n">GraphQueryEngine</span><span class="o">.</span><span class="n">from_db_path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
2996
<a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a>
2997
<a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="c1"># From a .json file</span>
2998
<a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="n">engine</span> <span class="o">=</span> <span class="n">GraphQueryEngine</span><span class="o">.</span><span class="n">from_json_path</span><span class="p">(</span><span class="s2">&quot;knowledge_graph.json&quot;</span><span class="p">)</span>
2999
<a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a>
3000
<a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="c1"># With an LLM provider for agentic mode</span>
3001
<a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.providers.manager</span><span class="w"> </span><span class="kn">import</span> <span class="n">ProviderManager</span>
3002
<a id="__codelineno-21-13" name="__codelineno-21-13" href="#__codelineno-21-13"></a><span class="n">pm</span> <span class="o">=</span> <span class="n">ProviderManager</span><span class="p">()</span>
3003
<a id="__codelineno-21-14" name="__codelineno-21-14" href="#__codelineno-21-14"></a><span class="n">engine</span> <span class="o">=</span> <span class="n">GraphQueryEngine</span><span class="o">.</span><span class="n">from_db_path</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">provider_manager</span><span class="o">=</span><span class="n">pm</span><span class="p">)</span>
3004
</code></pre></div>
3005
<h3 id="queryresult">QueryResult<a class="headerlink" href="#queryresult" title="Permanent link">&para;</a></h3>
3006
<p>All query methods return a <code>QueryResult</code> dataclass with multiple output formats:</p>
3007
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="n">result</span> <span class="o">=</span> <span class="n">engine</span><span class="o">.</span><span class="n">stats</span><span class="p">()</span>
3008
<a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a>
3009
<a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a><span class="c1"># Human-readable text</span>
3010
<a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a><span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">to_text</span><span class="p">())</span>
3011
<a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>
3012
<a id="__codelineno-22-6" name="__codelineno-22-6" href="#__codelineno-22-6"></a><span class="c1"># JSON string</span>
3013
<a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a><span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">to_json</span><span class="p">())</span>
3014
<a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a>
3015
<a id="__codelineno-22-9" name="__codelineno-22-9" href="#__codelineno-22-9"></a><span class="c1"># Mermaid diagram (for graph results)</span>
3016
<a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a><span class="n">result</span> <span class="o">=</span> <span class="n">engine</span><span class="o">.</span><span class="n">neighbors</span><span class="p">(</span><span class="s2">&quot;Alice&quot;</span><span class="p">)</span>
3017
<a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a><span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">to_mermaid</span><span class="p">())</span>
3018
</code></pre></div>
3019
<p>The <code>QueryResult</code> contains:</p>
3020
<table>
3021
<thead>
3022
<tr>
3023
<th>Field</th>
3024
<th>Type</th>
3025
<th>Description</th>
3026
</tr>
3027
</thead>
3028
<tbody>
3029
<tr>
3030
<td><code>data</code></td>
3031
<td>Any</td>
3032
<td>The raw result data (dict, list, or scalar)</td>
3033
</tr>
3034
<tr>
3035
<td><code>query_type</code></td>
3036
<td>str</td>
3037
<td><code>"filter"</code> for direct mode, <code>"agentic"</code> for LLM mode, <code>"sql"</code> for raw SQL</td>
3038
</tr>
3039
<tr>
3040
<td><code>raw_query</code></td>
3041
<td>str</td>
3042
<td>String representation of the executed query</td>
3043
</tr>
3044
<tr>
3045
<td><code>explanation</code></td>
3046
<td>str</td>
3047
<td>Human-readable explanation or LLM-synthesized answer</td>
3048
</tr>
3049
</tbody>
3050
</table>
3051
<hr />
3052
<h2 id="the-self-contained-html-viewer">The Self-Contained HTML Viewer<a class="headerlink" href="#the-self-contained-html-viewer" title="Permanent link">&para;</a></h2>
3053
<p>PlanOpticon includes a zero-dependency HTML knowledge graph viewer at <code>knowledge-base/viewer.html</code>. This file is fully self-contained -- it inlines D3.js and requires no build step, no server, and no internet connection.</p>
3054
<p>To use it, open <code>viewer.html</code> in a browser. It will load and visualize a <code>knowledge_graph.json</code> file (place it in the same directory, or use the file picker in the viewer).</p>
3055
<p>The viewer provides:</p>
3056
<ul>
3057
<li>Interactive force-directed graph layout</li>
3058
<li>Zoom and pan navigation</li>
3059
<li>Entity nodes colored by type</li>
3060
<li>Relationship edges with labels</li>
3061
<li>Click-to-focus on individual entities</li>
3062
<li>Entity detail panel showing descriptions and connections</li>
3063
</ul>
3064
<p>This covers approximately 80% of graph exploration needs with zero infrastructure.</p>
3065
<hr />
3066
<h2 id="kg-management-commands">KG Management Commands<a class="headerlink" href="#kg-management-commands" title="Permanent link">&para;</a></h2>
3067
<p>The <code>planopticon kg</code> command group provides utilities for managing knowledge graph files.</p>
3068
<h3 id="kg-convert">kg convert<a class="headerlink" href="#kg-convert" title="Permanent link">&para;</a></h3>
3069
<p>Convert a knowledge graph between SQLite and JSON formats:</p>
3070
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="c1"># SQLite to JSON</span>
3071
<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>convert<span class="w"> </span>results/knowledge_graph.db<span class="w"> </span>output.json
3072
<a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a>
3073
<a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a><span class="c1"># JSON to SQLite</span>
3074
<a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>convert<span class="w"> </span>knowledge_graph.json<span class="w"> </span>knowledge_graph.db
3075
</code></pre></div>
3076
<p>The output format is inferred from the destination file extension. Source and destination must be different formats.</p>
3077
<h3 id="kg-sync">kg sync<a class="headerlink" href="#kg-sync" title="Permanent link">&para;</a></h3>
3078
<p>Synchronize a <code>.db</code> and <code>.json</code> knowledge graph, updating the stale one:</p>
3079
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="c1"># Auto-detect which is newer and sync</span>
3080
<a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>sync<span class="w"> </span>results/knowledge_graph.db
3081
<a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a>
3082
<a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a><span class="c1"># Explicit JSON path</span>
3083
<a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>sync<span class="w"> </span>knowledge_graph.db<span class="w"> </span>knowledge_graph.json
3084
<a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a>
3085
<a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a><span class="c1"># Force a specific direction</span>
3086
<a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>sync<span class="w"> </span>knowledge_graph.db<span class="w"> </span>knowledge_graph.json<span class="w"> </span>--direction<span class="w"> </span>db-to-json
3087
<a id="__codelineno-24-9" name="__codelineno-24-9" href="#__codelineno-24-9"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>sync<span class="w"> </span>knowledge_graph.db<span class="w"> </span>knowledge_graph.json<span class="w"> </span>--direction<span class="w"> </span>json-to-db
3088
</code></pre></div>
3089
<p>If <code>JSON_PATH</code> is omitted, the <code>.json</code> path is derived from the <code>.db</code> path (same name, different extension). In <code>auto</code> mode (the default), the newer file is used as the source.</p>
3090
<h3 id="kg-inspect">kg inspect<a class="headerlink" href="#kg-inspect" title="Permanent link">&para;</a></h3>
3091
<p>Show summary statistics for a knowledge graph file:</p>
3092
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>inspect<span class="w"> </span>results/knowledge_graph.db
3093
</code></pre></div>
3094
<p>Output:</p>
3095
<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a>File: results/knowledge_graph.db
3096
<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a>Store: sqlite
3097
<a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a>Entities: 42
3098
<a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a>Relationships: 87
3099
<a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a>Entity types:
3100
<a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a> technology: 15
3101
<a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a> person: 12
3102
<a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a> concept: 10
3103
<a id="__codelineno-26-9" name="__codelineno-26-9" href="#__codelineno-26-9"></a> organization: 5
3104
</code></pre></div>
3105
<p>Works with both <code>.db</code> and <code>.json</code> files.</p>
3106
<h3 id="kg-classify">kg classify<a class="headerlink" href="#kg-classify" title="Permanent link">&para;</a></h3>
3107
<p>Classify knowledge graph entities into planning taxonomy types:</p>
3108
<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="c1"># Heuristic + LLM classification</span>
3109
<a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>classify<span class="w"> </span>results/knowledge_graph.db
3110
<a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>
3111
<a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a><span class="c1"># Heuristic only (no API key needed)</span>
3112
<a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>classify<span class="w"> </span>results/knowledge_graph.db<span class="w"> </span>-p<span class="w"> </span>none
3113
<a id="__codelineno-27-6" name="__codelineno-27-6" href="#__codelineno-27-6"></a>
3114
<a id="__codelineno-27-7" name="__codelineno-27-7" href="#__codelineno-27-7"></a><span class="c1"># JSON output</span>
3115
<a id="__codelineno-27-8" name="__codelineno-27-8" href="#__codelineno-27-8"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>classify<span class="w"> </span>results/knowledge_graph.db<span class="w"> </span>--format<span class="w"> </span>json
3116
</code></pre></div>
3117
<p>Text output groups entities by planning type:</p>
3118
<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a>GOALS (3)
3119
<a id="__codelineno-28-2" name="__codelineno-28-2" href="#__codelineno-28-2"></a> - Improve system reliability [high]
3120
<a id="__codelineno-28-3" name="__codelineno-28-3" href="#__codelineno-28-3"></a> Must achieve 99.9% uptime
3121
<a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a> - Reduce deployment time [medium]
3122
<a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a> Automate the deployment pipeline
3123
<a id="__codelineno-28-6" name="__codelineno-28-6" href="#__codelineno-28-6"></a>
3124
<a id="__codelineno-28-7" name="__codelineno-28-7" href="#__codelineno-28-7"></a>RISKS (2)
3125
<a id="__codelineno-28-8" name="__codelineno-28-8" href="#__codelineno-28-8"></a> - Data migration complexity [high]
3126
<a id="__codelineno-28-9" name="__codelineno-28-9" href="#__codelineno-28-9"></a> Legacy schema incompatibilities
3127
<a id="__codelineno-28-10" name="__codelineno-28-10" href="#__codelineno-28-10"></a> ...
3128
<a id="__codelineno-28-11" name="__codelineno-28-11" href="#__codelineno-28-11"></a>
3129
<a id="__codelineno-28-12" name="__codelineno-28-12" href="#__codelineno-28-12"></a>TASKS (5)
3130
<a id="__codelineno-28-13" name="__codelineno-28-13" href="#__codelineno-28-13"></a> - Implement OAuth2 flow
3131
<a id="__codelineno-28-14" name="__codelineno-28-14" href="#__codelineno-28-14"></a> Set up authentication service
3132
<a id="__codelineno-28-15" name="__codelineno-28-15" href="#__codelineno-28-15"></a> ...
3133
</code></pre></div>
3134
<p>JSON output returns an array of <code>PlanningEntity</code> objects with <code>name</code>, <code>planning_type</code>, <code>priority</code>, <code>description</code>, and <code>source_entities</code> fields.</p>
3135
<h3 id="kg-from-exchange">kg from-exchange<a class="headerlink" href="#kg-from-exchange" title="Permanent link">&para;</a></h3>
3136
<p>Import a PlanOpticonExchange JSON file into a knowledge graph database:</p>
3137
<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a><span class="c1"># Import to default location (./knowledge_graph.db)</span>
3138
<a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>from-exchange<span class="w"> </span>exchange.json
3139
<a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a>
3140
<a id="__codelineno-29-4" name="__codelineno-29-4" href="#__codelineno-29-4"></a><span class="c1"># Import to a specific path</span>
3141
<a id="__codelineno-29-5" name="__codelineno-29-5" href="#__codelineno-29-5"></a>planopticon<span class="w"> </span>kg<span class="w"> </span>from-exchange<span class="w"> </span>exchange.json<span class="w"> </span>-o<span class="w"> </span>project.db
3142
</code></pre></div>
3143
<p>The PlanOpticonExchange format is a standardized interchange format that includes entities, relationships, and source records.</p>
3144
<hr />
3145
<h2 id="output-formats">Output Formats<a class="headerlink" href="#output-formats" title="Permanent link">&para;</a></h2>
3146
<p>Query results can be output in three formats:</p>
3147
<h3 id="text-default">Text (default)<a class="headerlink" href="#text-default" title="Permanent link">&para;</a></h3>
3148
<p>Human-readable format with entity types in brackets, relationship arrows, and indented details:</p>
3149
<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a>Found 15 entities
3150
<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a> [technology] Python -- General-purpose programming language
3151
<a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a> [person] Alice -- Lead engineer on the project
3152
<a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a> [concept] Microservices -- Architectural pattern discussed
3153
</code></pre></div>
3154
<h3 id="json">JSON<a class="headerlink" href="#json" title="Permanent link">&para;</a></h3>
3155
<p>Full structured output including query metadata:</p>
3156
<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span>--format<span class="w"> </span>json<span class="w"> </span>stats
3157
</code></pre></div>
3158
<div class="highlight"><pre><span></span><code><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a><span class="p">{</span>
3159
<a id="__codelineno-32-2" name="__codelineno-32-2" href="#__codelineno-32-2"></a><span class="w"> </span><span class="nt">&quot;query_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;filter&quot;</span><span class="p">,</span>
3160
<a id="__codelineno-32-3" name="__codelineno-32-3" href="#__codelineno-32-3"></a><span class="w"> </span><span class="nt">&quot;raw_query&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;stats()&quot;</span><span class="p">,</span>
3161
<a id="__codelineno-32-4" name="__codelineno-32-4" href="#__codelineno-32-4"></a><span class="w"> </span><span class="nt">&quot;explanation&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Knowledge graph statistics&quot;</span><span class="p">,</span>
3162
<a id="__codelineno-32-5" name="__codelineno-32-5" href="#__codelineno-32-5"></a><span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3163
<a id="__codelineno-32-6" name="__codelineno-32-6" href="#__codelineno-32-6"></a><span class="w"> </span><span class="nt">&quot;entity_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span>
3164
<a id="__codelineno-32-7" name="__codelineno-32-7" href="#__codelineno-32-7"></a><span class="w"> </span><span class="nt">&quot;relationship_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">87</span><span class="p">,</span>
3165
<a id="__codelineno-32-8" name="__codelineno-32-8" href="#__codelineno-32-8"></a><span class="w"> </span><span class="nt">&quot;entity_types&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3166
<a id="__codelineno-32-9" name="__codelineno-32-9" href="#__codelineno-32-9"></a><span class="w"> </span><span class="nt">&quot;technology&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span><span class="p">,</span>
3167
<a id="__codelineno-32-10" name="__codelineno-32-10" href="#__codelineno-32-10"></a><span class="w"> </span><span class="nt">&quot;person&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span>
3168
<a id="__codelineno-32-11" name="__codelineno-32-11" href="#__codelineno-32-11"></a><span class="w"> </span><span class="p">}</span>
3169
<a id="__codelineno-32-12" name="__codelineno-32-12" href="#__codelineno-32-12"></a><span class="w"> </span><span class="p">}</span>
3170
<a id="__codelineno-32-13" name="__codelineno-32-13" href="#__codelineno-32-13"></a><span class="p">}</span>
3171
</code></pre></div>
3172
<h3 id="mermaid">Mermaid<a class="headerlink" href="#mermaid" title="Permanent link">&para;</a></h3>
3173
<p>Graph results rendered as Mermaid diagram syntax, ready for embedding in markdown:</p>
3174
<div class="highlight"><pre><span></span><code><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a>planopticon<span class="w"> </span>query<span class="w"> </span>--format<span class="w"> </span>mermaid<span class="w"> </span><span class="s2">&quot;neighbors Alice&quot;</span>
3175
</code></pre></div>
3176
<div class="highlight"><pre><span></span><code><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a>graph LR
3177
<a id="__codelineno-34-2" name="__codelineno-34-2" href="#__codelineno-34-2"></a> Alice[&quot;Alice&quot;]:::person
3178
<a id="__codelineno-34-3" name="__codelineno-34-3" href="#__codelineno-34-3"></a> Python[&quot;Python&quot;]:::technology
3179
<a id="__codelineno-34-4" name="__codelineno-34-4" href="#__codelineno-34-4"></a> Kubernetes[&quot;Kubernetes&quot;]:::technology
3180
<a id="__codelineno-34-5" name="__codelineno-34-5" href="#__codelineno-34-5"></a> Alice -- &quot;expert_in&quot; --&gt; Kubernetes
3181
<a id="__codelineno-34-6" name="__codelineno-34-6" href="#__codelineno-34-6"></a> Alice -- &quot;works_with&quot; --&gt; Python
3182
<a id="__codelineno-34-7" name="__codelineno-34-7" href="#__codelineno-34-7"></a> classDef person fill:#f9d5e5,stroke:#333
3183
<a id="__codelineno-34-8" name="__codelineno-34-8" href="#__codelineno-34-8"></a> classDef concept fill:#eeeeee,stroke:#333
3184
<a id="__codelineno-34-9" name="__codelineno-34-9" href="#__codelineno-34-9"></a> classDef technology fill:#d5e5f9,stroke:#333
3185
<a id="__codelineno-34-10" name="__codelineno-34-10" href="#__codelineno-34-10"></a> classDef organization fill:#f9e5d5,stroke:#333
3186
</code></pre></div>
3187
<p>The <code>KnowledgeGraph.generate_mermaid()</code> method also produces full-graph Mermaid diagrams, capped at the top 30 most-connected nodes by default.</p>
3188
<hr />
3189
<h2 id="auto-discovery">Auto-Discovery<a class="headerlink" href="#auto-discovery" title="Permanent link">&para;</a></h2>
3190
<p>PlanOpticon automatically locates knowledge graph files using the <code>find_nearest_graph()</code> function. The search order is:</p>
3191
<ol>
3192
<li><strong>Current directory</strong> -- check for <code>knowledge_graph.db</code> and <code>knowledge_graph.json</code></li>
3193
<li><strong>Common subdirectories</strong> -- <code>results/</code>, <code>output/</code>, <code>knowledge-base/</code></li>
3194
<li><strong>Recursive downward walk</strong> -- up to 4 levels deep, skipping hidden directories</li>
3195
<li><strong>Parent directory walk</strong> -- upward through the directory tree, checking each level and its common subdirectories</li>
3196
</ol>
3197
<p>Within each search phase, <code>.db</code> files are preferred over <code>.json</code> files. Results are sorted by proximity (closest first).</p>
3198
<div class="highlight"><pre><span></span><code><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.integrators.graph_discovery</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
3199
<a id="__codelineno-35-2" name="__codelineno-35-2" href="#__codelineno-35-2"></a> <span class="n">find_nearest_graph</span><span class="p">,</span>
3200
<a id="__codelineno-35-3" name="__codelineno-35-3" href="#__codelineno-35-3"></a> <span class="n">find_knowledge_graphs</span><span class="p">,</span>
3201
<a id="__codelineno-35-4" name="__codelineno-35-4" href="#__codelineno-35-4"></a> <span class="n">describe_graph</span><span class="p">,</span>
3202
<a id="__codelineno-35-5" name="__codelineno-35-5" href="#__codelineno-35-5"></a><span class="p">)</span>
3203
<a id="__codelineno-35-6" name="__codelineno-35-6" href="#__codelineno-35-6"></a>
3204
<a id="__codelineno-35-7" name="__codelineno-35-7" href="#__codelineno-35-7"></a><span class="c1"># Find the single closest knowledge graph</span>
3205
<a id="__codelineno-35-8" name="__codelineno-35-8" href="#__codelineno-35-8"></a><span class="n">path</span> <span class="o">=</span> <span class="n">find_nearest_graph</span><span class="p">()</span>
3206
<a id="__codelineno-35-9" name="__codelineno-35-9" href="#__codelineno-35-9"></a>
3207
<a id="__codelineno-35-10" name="__codelineno-35-10" href="#__codelineno-35-10"></a><span class="c1"># Find all knowledge graphs, sorted by proximity</span>
3208
<a id="__codelineno-35-11" name="__codelineno-35-11" href="#__codelineno-35-11"></a><span class="n">paths</span> <span class="o">=</span> <span class="n">find_knowledge_graphs</span><span class="p">()</span>
3209
<a id="__codelineno-35-12" name="__codelineno-35-12" href="#__codelineno-35-12"></a>
3210
<a id="__codelineno-35-13" name="__codelineno-35-13" href="#__codelineno-35-13"></a><span class="c1"># Find graphs starting from a specific directory</span>
3211
<a id="__codelineno-35-14" name="__codelineno-35-14" href="#__codelineno-35-14"></a><span class="n">paths</span> <span class="o">=</span> <span class="n">find_knowledge_graphs</span><span class="p">(</span><span class="n">start_dir</span><span class="o">=</span><span class="s2">&quot;/path/to/project&quot;</span><span class="p">)</span>
3212
<a id="__codelineno-35-15" name="__codelineno-35-15" href="#__codelineno-35-15"></a>
3213
<a id="__codelineno-35-16" name="__codelineno-35-16" href="#__codelineno-35-16"></a><span class="c1"># Disable upward walking</span>
3214
<a id="__codelineno-35-17" name="__codelineno-35-17" href="#__codelineno-35-17"></a><span class="n">paths</span> <span class="o">=</span> <span class="n">find_knowledge_graphs</span><span class="p">(</span><span class="n">walk_up</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3215
<a id="__codelineno-35-18" name="__codelineno-35-18" href="#__codelineno-35-18"></a>
3216
<a id="__codelineno-35-19" name="__codelineno-35-19" href="#__codelineno-35-19"></a><span class="c1"># Get summary stats without loading the full graph</span>
3217
<a id="__codelineno-35-20" name="__codelineno-35-20" href="#__codelineno-35-20"></a><span class="n">info</span> <span class="o">=</span> <span class="n">describe_graph</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
3218
<a id="__codelineno-35-21" name="__codelineno-35-21" href="#__codelineno-35-21"></a><span class="c1"># {&quot;entity_count&quot;: 42, &quot;relationship_count&quot;: 87,</span>
3219
<a id="__codelineno-35-22" name="__codelineno-35-22" href="#__codelineno-35-22"></a><span class="c1"># &quot;entity_types&quot;: {...}, &quot;store_type&quot;: &quot;sqlite&quot;}</span>
3220
</code></pre></div>
3221
<p>Auto-discovery is used by the Companion REPL, the <code>planopticon query</code> command, and the planning agent when no explicit <code>--kb</code> path is provided.</p>
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
</article>
3236
</div>
3237
3238
3239
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
3240
3241
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
3242
</div>
3243
3244
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
3245
3246
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
3247
Back to top
3248
</button>
3249
3250
</main>
3251
3252
<footer class="md-footer">
3253
3254
<div class="md-footer-meta md-typeset">
3255
<div class="md-footer-meta__inner md-grid">
3256
<div class="md-copyright">
3257
3258
<div class="md-copyright__highlight">
3259
Copyright &copy; 2026 CONFLICT LLC
3260
</div>
3261
3262
3263
Made with
3264
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3265
Material for MkDocs
3266
</a>
3267
3268
</div>
3269
3270
3271
<div class="md-social">
3272
3273
3274
3275
3276
3277
3278
3279
3280
<a href="https://github.com/ConflictHQ/PlanOpticon" target="_blank" rel="noopener" title="github.com" class="md-social__link">
3281
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
3282
</a>
3283
3284
</div>
3285
3286
</div>
3287
</div>
3288
</footer>
3289
3290
</div>
3291
<div class="md-dialog" data-md-component="dialog">
3292
<div class="md-dialog__inner md-typeset"></div>
3293
</div>
3294
3295
3296
3297
3298
3299
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
3300
3301
3302
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
3303
3304
3305
</body>
3306
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button