用途:当用户希望把数据仓库、湖仓或 BigQuery/Snowflake 风格的数据目录表示为 OKF bundle,或为已有目录导出补充精选上下文时使用。资料称这是 OKF 的旗舰用例:智能体拥有精选的表、指标和连接路径上下文时,回答数据问题效果远好于原始模式。
两遍模型:元数据遍(低成本、确定性)遍历目录,仅用结构元数据为每个持久资产生成一个概念;增强遍(选择性、有来源)从文档、dbt 模型、查询历史或负责人处补充描述、注意事项、血缘和连接路径,外部文档引用放在 # Citations 下。不要因增强遍阻塞元数据遍,骨架目录可立即使用并逐步增强。
目录结构:<catalog>/ 下含 AGENTS.md、index.md、log.md、datasets/、tables/、metrics/、decisions/。超大目录可嵌套 tables/<dataset>/<table>.md 以保持路径稳定、索引浅层。
概念类型:dataset/schema 为 Dataset;table/view 为 Table;物化指标/KPI 为 Metric;业务定义为 Business Term;管道/定时任务为 Runbook;建模或治理选择为 Architectural Decision。
表概念模式包含 frontmatter(type、title、description、resource、tags、timestamp)及 # Summary、# Schema、# Grain、# Relationships 等章节。外键和连接关系以 Markdown 链接表达,例如 customer_id 列链接到 customers,这些链接成为图边,帮助智能体规划多表查询,优先使用 bundle 相对绝对链接。
指标:每个受治理指标单独成概念,含精确定义、SQL 或公式、来源表(链接)和注意事项。模糊指标是错误分析答案最常见原因,定义须明确。
资源 URI:使用真实控制台或目录 URI(BigQuery 控制台 URL、Snowflake 对象路径、dbt 文档 URL),不得编造;无规范 URI 时省略 resource。
质量门:每个表概念有 # Schema 章节;外键以链接而非散文表达;每个指标有公式和具名来源表;bundle 内 AGENTS.md 说明如何以纯 OKF Markdown 消费目录,无需 Codex 或 OKF 专用工具。交接前运行 python tools/okf_tool.py lint <catalog> 和 python tools/okf_tool.py visualize <catalog> -o <artifact-dir>/viz.html,便于审阅者查看连接图。
完成报告:返回已记录的数据集/表/指标、创建的连接边、增强缺口(仍缺描述或负责人的表)及验证状态。