Skip to main content

Schema validation pipeline for LLM-generated structured Markdown. CLI · Python API · REST API.

Project description

AI Knowledge Filler

Validation pipeline that prevents AI-generated files from reaching disk unless they pass schema checks

Tests Lint PyPI Python 3.10+ License: MIT Coverage


The Problem

Every time you use an LLM to generate structured knowledge files, the output drifts — wrong enum values, missing fields, dates in the wrong format, tags as strings instead of arrays. The files look fine until something downstream breaks: a search query returning nothing, a CI check failing, a pipeline corrupting.

The standard fix is post-hoc validation — check after writing, fix manually. That doesn't scale past a few dozen files.


How It Works

Prompt → LLM → Validation Engine → Error Normalizer → Retry Controller → Commit Gate → File

The LLM is the only non-deterministic component. Everything else is pure functions.

If output fails schema checks, it never touches disk — the Error Normalizer converts typed error codes into correction instructions and sends them back to the LLM for a retry.

If the same error fires twice on the same field, the pipeline aborts instead of looping — that pattern means your schema has a boundary problem, not the model.


Quick Start

pip install ai-knowledge-filler

export ANTHROPIC_API_KEY="sk-ant-..."  # or GOOGLE_API_KEY, OPENAI_API_KEY, GROQ_API_KEY

akf generate "Write a guide on Docker networking"
akf validate ./vault/

Works with Claude, GPT-4, Gemini, Ollama.


External Taxonomy Config

Your ontology lives in akf.yaml — not compiled into the tool:

# akf.yaml
schema_version: "1.0.0"
vault_path: "./vault"

enums:
  type: [concept, guide, reference, checklist, project, roadmap, template, audit]
  level: [beginner, intermediate, advanced]
  status: [draft, active, completed, archived]
  domain:
    - ai-system
    - api-design
    - devops
    - security
    - system-design

Change your taxonomy without touching code or redeploying:

akf init          # generates akf.yaml for your vault
akf validate ./   # validates all files against your config

Error Codes

Validation failures produce typed error codes, not free-form messages:

Code Field Meaning
E001 type / level / status Value not in allowed enum set
E002 any Required field missing
E003 created / updated Date not ISO 8601
E004 title / tags Type mismatch (e.g. tags: "security" instead of tags: [security])
E005 frontmatter General schema violation
E006 domain Value not in taxonomy
E007 created / updated created is later than updated

The Error Normalizer translates these codes into deterministic correction instructions for the retry:

E006 on field "domain" (received: "backend")
→ "The 'domain' field must be one of: [api-design, backend-engineering, devops, ...]
   You used 'backend' which is not in the taxonomy. Choose the closest match."

Retry as Signal

Retry pressure is not a failure metric.

When a domain value triggers elevated retries, the taxonomy has a boundary problem — not the model. The telemetry substrate (append-only JSONL) surfaces which enum values cause friction, so you can refine your ontology based on evidence rather than intuition.


Interfaces

CLI:

akf generate "Create a guide on API rate limiting"
akf generate "Create Docker security checklist" --model gemini
akf validate ./vault/
akf validate --file outputs/Guide.md
akf serve --port 8000        # REST API
akf serve --mcp              # MCP server (v0.6.x)

Python API:

from akf import Pipeline

pipeline = Pipeline(output="./vault/")
result = pipeline.generate("Create a guide on Docker networking")
results = pipeline.batch_generate(["Guide 1", "Guide 2", "Guide 3"])

REST API:

POST /v1/generate    →  validated file
POST /v1/validate    →  schema check result
POST /v1/batch       →  multiple files
GET  /v1/models      →  available providers

MCP (v0.6.x, in progress):

akf serve --mcp
# Exposes: akf_generate, akf_validate, akf_enrich, akf_batch

What Every Committed File Guarantees

  • Required fields present: title, type, domain, level, status, tags, created, updated
  • Valid enums: type, level, status from controlled sets
  • Domain from your configured taxonomy in akf.yaml
  • ISO 8601 dates with created ≤ updated
  • tags as array with ≥ 3 items, title as string — no type mismatches

No file reaches disk without passing all checks.


Example Output

Input:

Create a guide on API rate limiting

Output (vault/API_Rate_Limiting_Strategy.md):

---
title: "API Rate Limiting Strategy"
type: guide
domain: api-design
level: intermediate
status: active
version: v1.0
tags: [api, rate-limiting, performance, architecture]
related:
  - "[[API Design Principles]]"
  - "[[System Scalability Patterns]]"
created: 2026-03-06
updated: 2026-03-06
---

## Purpose
...

Architecture

akf/
  pipeline.py          # Pipeline — generate(), validate(), batch_generate()
  validator.py         # Validation Engine — binary VALID/INVALID, E001–E007
  validation_error.py  # ValidationError dataclass
  error_normalizer.py  # Translates errors → LLM retry instructions
  retry_controller.py  # Convergence protection — aborts on identical error hash
  commit_gate.py       # Atomic write — only VALID files reach disk
  telemetry.py         # Append-only JSONL event stream
  config.py            # Loads akf.yaml or bundled defaults
  server.py            # FastAPI REST API
  mcp_server.py        # MCP server (FastMCP)
  defaults/
    akf.yaml           # Default taxonomy

cli.py                 # Entry point
llm_providers.py       # Claude / Gemini / GPT-4 / Ollama

Model Support

Provider Key Notes
Claude ANTHROPIC_API_KEY Recommended for complex content
Gemini GOOGLE_API_KEY Fast, cost-effective
GPT-4 OPENAI_API_KEY General purpose
Groq GROQ_API_KEY Free tier, fast
Ollama Local, offline, private

Tests

pytest --cov=akf --cov-report=term-missing -v

560+ tests, 91% coverage, CI green on Python 3.10 / 3.11 / 3.12.


Installation

# PyPI
pip install ai-knowledge-filler

# With MCP support
pip install ai-knowledge-filler[mcp]

# From source
git clone https://github.com/petrnzrnk-creator/ai-knowledge-filler.git
cd ai-knowledge-filler
pip install -e .

Documentation


License

MIT — free for commercial and personal use.


PyPI: https://pypi.org/project/ai-knowledge-filler
Version: 0.6.1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_knowledge_filler-0.6.2.tar.gz (73.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_knowledge_filler-0.6.2-py3-none-any.whl (55.8 kB view details)

Uploaded Python 3

File details

Details for the file ai_knowledge_filler-0.6.2.tar.gz.

File metadata

  • Download URL: ai_knowledge_filler-0.6.2.tar.gz
  • Upload date:
  • Size: 73.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ai_knowledge_filler-0.6.2.tar.gz
Algorithm Hash digest
SHA256 8bdbdb5d1f4a68b06d4f57da518e4c1ccf8853ae907ca1bd34e527b9ca4008d8
MD5 1d48166ec6e21d33983e83a1321ff9e7
BLAKE2b-256 65bb014d69ca7a78dd8a513903098cf4c074c5007c797a46e2f417652bf64b8f

See more details on using hashes here.

File details

Details for the file ai_knowledge_filler-0.6.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_knowledge_filler-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b8a2d56350eff0341fdd3471b9c2528adb9efa388dae05c689be92792039a549
MD5 a39a9793628382f1eec31b3d745c0ff7
BLAKE2b-256 d75a4ca41e000659a2e8c4b820268ee3172bc1a9c374e494046bcddbd39856f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page