Documentation

Schema

Schema overview

A CKF package is a single object with a metadata header plus 22 typed top-level sections. Sections are numbered 1..22 in the canonical serialization, ending with source_traceability (#22).

Top-level type

ts
interface CkfPackage {
  metadata: CkfMetadata;
  core_intent: CoreIntent;
  domain_map: DomainMap;
  entities: Entity[];
  concepts: Concept[];
  principles: Principle[];
  heuristics: Heuristic[];
  decision_rules: DecisionRule[];
  procedures: Procedure[];
  patterns: Pattern[];
  anti_patterns: AntiPattern[];
  causal_chains: CausalChain[];
  contextual_triggers: ContextualTrigger[];
  if_then_rules: IfThenRule[];
  exceptions: Exception[];
  mental_models: MentalModel[];
  playbooks: Playbook[];
  qa_pairs: QAPair[];
  retrieval_chunks: RetrievalChunk[];
  atomic_units: AtomicUnit[];
  agent_instructions: AgentInstructions;
  knowledge_limits: KnowledgeLimits;
  source_traceability: SourceTraceItem[];
}

All sections

#SectionTypeGroupReference
metadataobjectPackage headerView
1core_intentobjectMetadataView
2domain_mapobjectMetadataView
3entitiesEntity[]KnowledgeView
4conceptsConcept[]KnowledgeView
5principlesPrinciple[]RulesView
6heuristicsHeuristic[]RulesView
7decision_rulesDecisionRule[]RulesView
8proceduresProcedure[]ProceduresView
9patternsPattern[]ProceduresView
10anti_patternsAntiPattern[]ProceduresView
11causal_chainsCausalChain[]Reasoning
12contextual_triggersContextualTrigger[]Reasoning
13if_then_rulesIfThenRule[]RulesView
14exceptionsException[]RulesView
15mental_modelsMentalModel[]Reasoning
16playbooksPlaybook[]ProceduresView
17qa_pairsQAPair[]RetrievalView
18retrieval_chunksRetrievalChunk[]RetrievalView
19atomic_unitsAtomicUnit[]RetrievalView
20agent_instructionsobjectRetrievalView
21knowledge_limitsobjectRetrievalView
22source_traceabilitySourceTraceItem[]TraceabilityView

CKF v1.0 for this page has not been compiled yet. Downloads become available once an admin runs the compiler.