open-knowledge-format v0.1到v0.2迁移指南:2个破坏性变更与4组新增字段的升级清单

【免费下载链接】open-knowledge-format

项目地址:https://gitcode.com/gh_mirrors/op/open-knowledge-format
点击查看免费下载

open-knowledge-format(OKF)是一个把数据目录知识表示为「Markdown 文件 + YAML frontmatter」的开放、厂商中立格式:人类可手写、Agent 可生成、任意系统可消费。如果你手里的知识包(Knowledge Bundle)还停留在 v0.1,升级到OKF v0.2需要处理2 个破坏性变更(旧字段被取代),并可按清单分批启用4 组新增字段(来源溯源、信任、生命周期、可验证计算)。本文是一份可直接照做的完整升级清单,全程不需要任何专用工具——能cat一个文件,就能完成迁移。

📌 一、升级前 30 秒:v0.2 到底改了什么

v0.2 的设计目标是让「由 Agent 持续维护的知识库」变得可信。当大多数文档由机器生成时,消费者需要快速回答 5 个问题,v0.2 正好为每个问题给了一个 frontmatter 答案:

你要回答的问题v0.2 提供的字段
这条知识从哪来?(provenance 溯源)sources
应该相信多少?(trust 信任)generated/verified
现在还新鲜吗?(freshness 新鲜度)stale_after
是当前版本吗?(lifecycle 生命周期)status
数字是按规范算出来的吗?(attestation 认证)Attested Computation概念类型

版本差异的权威出处是官方规范 SPEC.md,其中「§13 Changes from v0.1」就是本文所有内容的索引。

⚠️ 二、2 个破坏性变更:迁移必做项

变更 1:timestamp被generated取代

  • v0.1:用顶层timestamp记录文档最后修改时间。
  • v0.2:改为generated: { by: <actor>, at: <ISO 8601> },同时回答「谁生成」和「何时生成」,规范见 SPEC.md §5.2 Trust。
  • 兼容策略:v0.2 消费者在缺少generated时允许回退读取旧timestamp,所以旧 bundle 不会立刻失效;但迁移完成后应删除旧字段。
# v0.1(旧写法,见 SPEC.md 附录 A 的 v0.1 示例) timestamp: '2026-05-28T22:53:05+00:00' # v0.2(新写法) generated: { by: reference_agent/gemini-2.5-pro, at: 2026-06-20T22:53:05Z }

by的值遵循 actor 命名约定(SPEC.md §7):Agent 用<producer>/<version>,个人用human:<id>,自动化流程用process:<id>。

变更 2:正文# Citations列表被sourcesfrontmatter 取代

  • v0.1:引用来源以 URL 列表形式写在正文末尾的# Citations章节里(v0.1 示例见 SPEC.md 附录 A)。
  • v0.2:来源统一提升到 frontmatter 的sources列表,每条可带可信度信号author/usage_count/last_modified;正文里对具体论断用 markdown 脚注[^id]关联到sources[].id,详见 SPEC.md §5.1 Provenance。
  • 为什么要挪:来源从「正文装饰」变成可查询、可过滤的元数据,消费者无需解析正文即可评估可信度。

💡 官方参考 Agent 的提示词已同步更新——明确禁止再生成# Citations章节,见 reference_instruction.md;工具层校验也做了同样约束,见 bundle_tools.py。

🧩 三、4 组新增字段:按需启用的升级清单

v0.2 的新增内容全部是可选字段:一个字段都不加,文档依然合规。建议按下面 4 批启用,每批独立可回滚:

批次字段族关键字段解决的问题规范位置
1来源溯源sources(含author、usage_count、last_modified)+ 兄弟字段usage_window知识从哪来、来源是否权威§5.1
2信任generated、verified谁写的、谁核实过§5.2
3生命周期status(draft / stable / deprecated)、stale_after是否现行、何时过期§5.4–5.5
4可验证计算新类型Attested Computation:runtime、parameters、computation、executor、attester+ 正文约定章节# Computation关键数字是否按批准的 SQL/模型算出§10

信任分级(trust tier)怎么推导(§5.3):

  • 无verified⇒unverified
  • 仅process:/ Agent 验证过 ⇒machine-confirmed
  • 出现human:<id>验证 ⇒human-reviewed

💡 建议节奏:先做第 1、2 批(成本最低、收益最大);第 3 批适合财务口径、指标定义类文档;第 4 批只给营收、毛利这类关键指标配,仓库里的 acme_retail bundle 就是一个四批全开的完整示范。

✅ 四、6 步迁移操作清单

步骤 1:盘点存量

统计两个 v0.1 特征出现的范围:

grep -rl "timestamp:" bundles/ grep -rl "# Citations" bundles/

步骤 2:timestamp→generated

逐文档改写为generated: { by, at },at用带 UTC 偏移的 ISO 8601 时间,然后删除timestamp行。

步骤 3:# Citations→sources

把正文末尾的引用列表搬进 frontmatter;给每条来源起一个稳定id,正文对应论断处加[^id]脚注,最后删除# Citations章节。

步骤 4:为关键文档补status与stale_after

status缺省即stable,只需显式标注草稿与废弃项;stale_after是绝对时间点,now >= stale_after即视为过期,消费端应提示复核而非直接报错。废弃写法参考 gross-margin-legacy.md(status: deprecated+ 正文说明保留原因)。

步骤 5(可选):把关键指标升级为 Attested Computation

将「一个概念混装多个口径」拆成「叙述型 Metric 概念 + 独立计算概念」:Metric 只负责叙述并用 markdown 链接指向计算,计算概念自带runtime、参数、执行器与审核器。完整实例见 computations/revenue-ytd.md 与 metrics/revenue.md。

步骤 6:声明版本并做合规验收

  1. 在 bundle 根index.md的 frontmatter 中声明okf_version: "0.2"——这是index.md唯一允许带 frontmatter 的位置(§12 Versioning)。
  2. 按 §11 Conformance 验收:所有非保留.md都有可解析 frontmatter、type非空;且消费端不得因缺少可选字段、未知type、断链等理由拒读 bundle。
  3. 把迁移记录写进log.md,日期分组、最新在前,格式见 acme_retail/log.md。

迁移前后的完整对照样例(一张损益表从 v0.1 单文档升级为「Metric + 两个 Attested Computation」)在 SPEC.md 附录 A,建议迁移时放在手边。

❓ 五、常见问题

Q:v0.1 的旧 bundle 会升级后直接失效吗?不会。v0.2 消费者带兼容回退:缺generated可回退读timestamp,仍可从旧# Citations解析来源(§13.1)。迁移是渐进的,不是「一刀切」。

Q:新字段必须全填吗?不必。type是唯一必填项,其余全部可选;消费端必须容忍未知 key 与缺失字段,因此可以按第三节的 4 批次慢慢上。

Q:用 reference agent 自动生成的 bundle 需要手动改吗?不用。生成端提示词已对齐 v0.2(来源写sources、自动生成generated),直接产出即新格式;复现命令见各样例配方,如 samples/stackoverflow/README.md。

📚 六、参考资料

  • 官方规范(含 v0.1→v0.2 差异总表与 worked example):SPEC.md
  • 四族字段全开的示范 bundle:bundles/acme_retail/
  • 其他样例 bundle:bundles/ga4/、bundles/stackoverflow/、bundles/crypto_bitcoin/
  • 生成端提示词:prompts/reference_instruction.md

【免费下载链接】open-knowledge-format

项目地址:https://gitcode.com/gh_mirrors/op/open-knowledge-format
点击查看免费下载

相关推荐

上一篇:DEFT:面向文本到图像模型的分解式高效微调(PEFT 实现与实战指南)
下一篇:pyenv-win企业级离线部署终极指南:无网络环境下的Python版本管理实战

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻

网球场馆AI识别落地方案:目标检测、姿态估计与系统集成

网球场馆AI识别落地方案:目标检测、姿态估计与系统集成

网球场馆AI识别&#xff0c;听起来是个很“算法”的项目&#xff0c;但真正做过一次独立实施之后你会发现&#xff0c;它其实是个标准的工程系统集成项目。我两年前接手一个中型网球中心的智能化改造需求时&#xff0c;业主方最初只提了三句话——自动判罚出界、自动统计跑动数…

2026/10/20 1:33:02 阅读更多 →
tiny11builder 完整指南:一键把 28GB 的 Windows 11 系统镜像精简到 12GB

tiny11builder 完整指南:一键把 28GB 的 Windows 11 系统镜像精简到 12GB

tiny11builder 完整指南&#xff1a;一键把 28GB 的 Windows 11 系统镜像精简到 12GB 【免费下载链接】tiny11builder WinUI app for building smaller, customized Windows 11 images. 项目地址: https://gitcode.com/GitHub_Trending/ti/tiny11builder tiny11builder …

2026/10/20 1:33:02 阅读更多 →
原神抽卡记录导出完整指南:10分钟拿回从开服至今的每一抽

原神抽卡记录导出完整指南:10分钟拿回从开服至今的每一抽

原神抽卡记录导出完整指南&#xff1a;10分钟拿回从开服至今的每一抽 【免费下载链接】genshin-wish-export Easily export the Genshin Impact wish record. 项目地址: https://gitcode.com/GitHub_Trending/ge/genshin-wish-export 游戏里只留最近 6 个月的祈愿记录&a…

2026/10/20 1:33:02 阅读更多 →

最新新闻

Spring Boot公益服务平台开发实战:从数据库建模到答辩全流程指南

Spring Boot公益服务平台开发实战:从数据库建模到答辩全流程指南

最近帮几个学弟学妹把基于Spring Boot的公益服务平台从零到一完整搭了一遍&#xff0c;整个过程走了不少弯路&#xff0c;也沉淀了不少可以直接复用的经验。这类系统在课程设计和毕业设计里出现频率很高&#xff0c;一是业务场景贴近生活&#xff0c;二是功能边界清晰——用户注…

2026/10/20 2:52:44 阅读更多 →
VS2019下编译FLTK 1.4.4 64位静态库完整指南

VS2019下编译FLTK 1.4.4 64位静态库完整指南

如果有人问我Windows下最省心的C界面库是什么&#xff0c;我的答案一直是FLTK。不是因为它功能最全&#xff0c;而是因为它是少数能把二进制体积控制在几百KB、链接完不带一堆运行库依赖的轻量级选择。最近我用VS2019把一个内部工具做成64位程序&#xff0c;决定把FLTK-1.4.4从…

2026/10/20 2:52:44 阅读更多 →
NSGA2多目标优化MATLAB实现:从原理到代码全解析

NSGA2多目标优化MATLAB实现:从原理到代码全解析

简介&#xff1a;一份MATLAB环境下的NSGA-II算法实现资料包&#xff0c;围绕非支配排序遗传算法第二代展开&#xff0c;面向需要在科研或工程场景中处理多目标优化问题的开发者与学习者。资源共20个文件&#xff0c;以MATLAB的m脚本为主&#xff08;含初始化、非支配排序、锦标…

2026/10/20 2:52:44 阅读更多 →
前端大数据表格渲染卡顿?主线程调度、Worker 与虚拟滚动的优化实践

前端大数据表格渲染卡顿?主线程调度、Worker 与虚拟滚动的优化实践

1. 一次真实的卡顿现场&#xff1a;loading 转着转着就“冻住”了1.1 现象表现与复现路径先还原一下我当时遇到的问题。项目是一个典型的管理后台报表页&#xff0c;接口返回一张大列表&#xff0c;大概 8000 到 15000 行&#xff0c;每行有七八个字段&#xff0c;还要带状态标…

2026/10/20 2:52:44 阅读更多 →
C++ eVTOL仿真工程:六自由度动力学与控制分配实战

C++ eVTOL仿真工程:六自由度动力学与控制分配实战

简介&#xff1a;eVTOL_Simulation 是一份面向 C 学习者与仿真爱好者的轻量级项目源码&#xff0c;围绕电动垂直起降飞行器的调度场景展开。程序设定 5 家公司共 20 架飞机同时起飞&#xff0c;每架飞机拥有巡航速度、电池容量、充电时间、巡航能耗及每小时故障概率等参数&…

2026/10/20 2:52:44 阅读更多 →
STM32双串口DMA互透传:零CPU干预的硬件级直通方案

STM32双串口DMA互透传:零CPU干预的硬件级直通方案

简介&#xff1a;本资源是基于STM32CubeMX与HAL库实现的双串口DMA互透传完整工程&#xff0c;面向嵌入式初学者及STM32进阶开发者&#xff0c;解决多串口高吞吐、低CPU占用场景下的实时数据转发难题&#xff0c;适用于工业通信网关、协议转换器、传感器汇聚等典型应用。压缩包共…

2026/10/20 2:51:44 阅读更多 →

日新闻

CLRC663芯片Pin-to-Pin替代实战:从评估到量产全记录

CLRC663芯片Pin-to-Pin替代实战:从评估到量产全记录

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/20 1:01:30 阅读更多 →
ESP32舵机控制指南:原理、多路驱动与避坑实战

ESP32舵机控制指南:原理、多路驱动与避坑实战

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/20 1:01:30 阅读更多 →
位移法实现一阶低通滤波:单片机ADC采样降噪实战

位移法实现一阶低通滤波:单片机ADC采样降噪实战

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/20 1:01:30 阅读更多 →

周新闻

基于GMM的语音识别系统原理与MATLAB实现详解

基于GMM的语音识别系统原理与MATLAB实现详解

说到基于高斯混合模型&#xff08;GMM&#xff09;的语音识别系统&#xff0c;很多人第一反应就是一堆数学公式&#xff0c;觉得门槛很高。但如果你真的在MATLAB里把它落地跑通&#xff0c;会发现核心其实就是三件事&#xff1a;把声音变成特征向量&#xff0c;用GMM给每个类别…

2026/10/19 10:02:04 阅读更多 →
数字图像处理入门:反白、灰度化、调色板修改与导出txt实践

数字图像处理入门:反白、灰度化、调色板修改与导出txt实践

数字图像处理这四个字听起来挺唬人&#xff0c;但落到具体操作上&#xff0c;无非就是让计算机按你的想法“摆弄”像素。我在一个模拟项目X里用了一套特别经典的基础处理流程&#xff1a;对图像做反白、改调色板、彩色转灰度&#xff0c;最后把像素数据导出成txt文件。单看每一…

2026/10/19 17:32:41 阅读更多 →
机器人大脑技术盘点:具身智能的感知、决策与数据闭环

机器人大脑技术盘点:具身智能的感知、决策与数据闭环

如果你的信息流最近也天天刷到“机器人大脑”这个词&#xff0c;你会发现一个很有意思的现象&#xff1a;每个人说的“大脑”根本不是同一个东西。有人指的是大语言模型&#xff0c;有人指的是运动控制系统&#xff0c;还有人指的是能理解物理世界的端到端模型。在2026年这个时…

2026/10/20 2:50:50 阅读更多 →

月新闻

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/19 2:54:50 阅读更多 →
Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/19 9:10:22 阅读更多 →
黑夜航拍船只数据集训练YOLOV5模型全流程解析

黑夜航拍船只数据集训练YOLOV5模型全流程解析

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/18 12:16:16 阅读更多 →