52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
|
# Echo6 Vault Tagger — Few-Shot Examples
|
|||
|
|
|
|||
|
|
These examples will be populated from real vault documents during the tagger implementation
|
|||
|
|
step (Step 5). Each example should show an input document snippet and the exact JSON output
|
|||
|
|
the tagger should produce, demonstrating correct vocabulary usage.
|
|||
|
|
|
|||
|
|
TODO: Add 3–5 real examples drawn from actual vault docs (runbook, reference, project, note).
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Template: Example Structure
|
|||
|
|
|
|||
|
|
### Input (document snippet)
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
---
|
|||
|
|
title: Headscale Setup
|
|||
|
|
type: runbook
|
|||
|
|
tags: [mesh, vpn]
|
|||
|
|
updated: 2025-03-10
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Headscale Setup
|
|||
|
|
|
|||
|
|
Steps to install and configure Headscale on the Contabo VPS...
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Expected JSON output
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"tags": ["mesh", "vpn"],
|
|||
|
|
"entities": ["contabo", "headscale"],
|
|||
|
|
"glossary_proposals": [],
|
|||
|
|
"type": "runbook",
|
|||
|
|
"confidence": 0.95
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Notes on this example
|
|||
|
|
|
|||
|
|
- `tags` uses only values from `topic_categories`
|
|||
|
|
- `entities` matches names present in `entity_lexicon` (contabo is a proxmox_vps; headscale is a known service)
|
|||
|
|
- `confidence` is high because type is explicitly set in frontmatter and tags are unambiguous
|
|||
|
|
- If the frontmatter had said `type: guide` (not in the allowed list), the tagger would infer `runbook` from the content and note the discrepancy
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
TODO: Add example 2 — reference doc (host description, multiple entities)
|
|||
|
|
TODO: Add example 3 — note/session doc (low entity density, inferred type)
|
|||
|
|
TODO: Add example 4 — ambiguous doc with glossary_proposals populated
|
|||
|
|
TODO: Add example 5 — doc where confidence drops below 0.6
|