Documentation

Schema

Schema overview

A CKF package is a single object with 22 typed top-level sections. The first three describe the source; the rest decompose its knowledge into agent-readable units.

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
1metadataobjectMetadataView
2core_intentobjectMetadataView
3domain_mapobjectMetadataView
4entitiesEntity[]KnowledgeView
5conceptsConcept[]KnowledgeView
6principlesPrinciple[]RulesView
7heuristicsHeuristic[]RulesView
8decision_rulesDecisionRule[]RulesView
9proceduresProcedure[]ProceduresView
10patternsPattern[]ProceduresView
11anti_patternsAntiPattern[]ProceduresView
12causal_chainsCausalChain[]Reasoning
13contextual_triggersContextualTrigger[]Reasoning
14if_then_rulesIfThenRule[]RulesView
15exceptionsException[]RulesView
16mental_modelsMentalModel[]Reasoning
17playbooksPlaybook[]ProceduresView
18qa_pairsQAPair[]RetrievalView
19retrieval_chunksRetrievalChunk[]RetrievalView
20atomic_unitsAtomicUnit[]RetrievalView
21agent_instructionsobjectRetrievalView
22knowledge_limitsobjectRetrievalView