Repository navigation
catalog: add KL4A (SOP/policy/regulation documents to OKF v0.2 bundles) - #19
Open
satyan2142 wants to merge 1 commit into
Open
satyan2142 wants to merge 1 commit into
satyan2142 wants to merge 1 commit into
Conversation
KL4A ingests SOP, policy and regulation documents (PDF, DOCX, plain text) and emits OKF v0.2 bundles. Filed under conversion alongside binder and convert-to-okf, since from the catalog's point of view it is a source-to-OKF converter. Validated with awesome-okf validate (33 entries), README regenerated with awesome-okf readme, pytest green (9 passed).
Albertchamberlain
requested changes
Oct 9, 2026
Albertchamberlain
left a comment
Owner
There was a problem hiding this comment.
The upstream KL4A repository, Apache-2.0 license, releases, and read-only MCP implementation are real, and the submitted English catalog row is structurally valid. Changes are required before merge:
- Only
README.mdwas regenerated. Awesome-OKF requires all localized READMEs to stay in sync; regenerate and commit EN/ZH/JA/KO (and RU if #18 is now in the base branch). - KL4A's
mineflow defaults to an Azure LLM provider. The current catalog text reads like a local document converter but does not disclose that SOP/policy/regulation document content may be sent to an external model unless an offline fixture/provider is explicitly selected. State the default cloud processing, credential requirement, data egress, and how to select offline mode. - “Every claim carries the exact source span” and “nothing is marked verified until a human approves it” are strong guarantees; link the implementation/tests that enforce them or soften the wording.
- For downloadable binaries, publish and recommend verification of checksums/signatures rather than relying on an unverified
latestartifact.
Run the full catalog, README-set, and pytest checks after rebasing on current main.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds KL4A to the catalog.
What it is: KL4A ingests SOP, policy and regulation documents - PDF, DOCX or plain text, prose written for a human reader rather than a structured corpus - and emits OKF v0.2 bundles. Every extracted claim carries the exact byte range of the source sentence it came from, and nothing is marked
verifieduntil a person approves it. Approvals, rejections and edits are retained as events in the bundle, each with a reviewer and a rationale.Why it belongs here: the existing
conversionentries convert structured or already-Markdown sources (bindertakes a plain-markdown corpus,convert-to-okftakes awesome lists, JSON and URL lists). KL4A covers the unstructured-document end of the same problem. I filed it underconversionrather than opening a newdocumentsection for a single entry, since from the catalog's point of view it is a source-to-OKF converter and belongs next to its peers.Apache-2.0. Ships a desktop app (Tauri, Windows/macOS/Linux) plus
sopkb-cliandsopkb-mcp, a read-only stdio MCP server, as single binaries with every release. A worked example bundle lives atexamples/glp1-healthcareif you want to read real output before installing anything.Checklist
kl4a,knowledge layer,cogniswitchValidation
One note in case it is useful rather than as part of this PR:
pip install -e ".[dev]"currently fails becausepyproject.tomlrequiresokf>=1.6.0,<2, and PyPI only hasokf0.1.0. Nothing undersrc/importsokf, so I installedpyyaml,typerandrichdirectly and the CLI and tests ran clean. Happy to open a separate issue if you would like it tracked.