vox-kb-facets API Reference (generated)
vox-kb-facets
Section titled “vox-kb-facets”Crate: vox-kb-facets · Version: 0.6.0 · Target: Library (lib.rs)
L0 KB facet contract: facet types, eligibility rule, summary block, provenance validators, taxonomy and backlog (KB Phase 4).
Crate Overview
Section titled “Crate Overview”L0 KB facet contract (KB Phase 4, D-01).
Pure: no I/O and no hashing. Lint, indexer, MENS builder and the generated schema all read facets through this crate, so a doc cannot be eligible in one consumer and ineligible in another.
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
backlog | — |
frontmatter | — |
keys | — |
provenance | — |
summary | — |
taxonomy | — |
Structs
Section titled “Structs”| Struct | Description |
|---|---|
Source | One entry of sources[]; every field is optional so a gap is a lint error, not a parse error. |
Facets | Typed KB facets read from page frontmatter. Unknown frontmatter keys are ignored. |
| Enum | Description |
|---|---|
Authorship | Who wrote the page. |
Origin | How the page entered the KB. |
KbTier | Which collection the page belongs to: Vox docs or the general library. |
TrustTier | Trust level of the page; same wire strings as ContextTrustTier. |
Scope | Whether the page is about Vox internals or external subject matter. |
Sensitivity | Egress sensitivity; private pages must not leave the machine. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
parse_facets | Parse facets from a whole document. No --- fence at all or an empty block is Facets::default() (grandfathered, D-05). A fence that is opened but not recognised (unterminated, indented, preceded by a blank line) or holds an invalid facet value is an Err: callers must treat it as “not eligible”, never as “no facets” (CR-01). |
is_valid_attestation | True when human_attested_by names a person: non-blank and not a placeholder or AI name (case-insensitive, whole value). |
forced_training_ineligible | True when the page is forced training-ineligible: web-promoted or LLM-authored content with no valid human_attested_by ([is_valid_attestation]). |
effective_training_eligible | The one shared MENS eligibility rule (D-05, D-06): not forced-ineligible and the flag, which defaults to true. |
facet_json_schema | Draft-07 JSON Schema for [Facets] (the GUI type and the 04-03 golden read this). |