# @equationalapplications/core-okf 中文文档

规范地址：https://npmcn.com/package/%40equationalapplications/core-okf/

版本：8\.4\.0
npm 元数据更新时间：2026-11-12T22:18:02.856Z
中文译文更新时间：2026-11-13T20:05:48.580Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40equationalapplications/core-okf
原文对照：https://npmcn.com/package/%40equationalapplications/core-okf/?lang=original
项目主页：https://equationalapplications.github.io/expo-llm-wiki/packages/core-okf/
源码仓库：https://github.com/equationalapplications/expo-llm-wiki

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：273 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-18T19:22:17.826Z
- 最新版本发布：2026-11-12T22:18:02.502Z
- 近 30 天下载量：8939（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 84 个）

## 中文简介

0-依赖性 开放知识格式 (OKF) v0.1 + v. 2. 原始:前事序列化(有流图/序列),概念文件,索引.md和log.md构建器,信任级和 staleness 帮助器.

## 安装

```sh
npm install @equationalapplications/core-okf
```

也可以使用：`pnpm add @equationalapplications/core-okf`、`yarn add @equationalapplications/core-okf`、`bun add @equationalapplications/core-okf`

## README

# @ 方程式应用程序/ core-okf

[![npm version](https://img.shields.io/npm/v/%40equationalapplications%2Fcore-okf?label=core-okf)](https://www.npmjs.com/package/@equationalapplications/core-okf) [![npm downloads](https://img.shields.io/npm/dm/%40equationalapplications%2Fcore-okf?label=downloads)](https://www.npmjs.com/package/@equationalapplications/core-okf)

## 概览

用于解析和制作的零依赖性库 [开放知识格式 (OKF) v0. 1和 v](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf) 捆绑 此软件包提供了原始原始数据,用于与OKF前题,概念文档,以及索引/日志文件合作,与任何特定数据库或数据模型完全脱钩.

为了一个现成的 `MemoryDump` OKF 捆绑适配器,参见 [OKF 向导 `@equationalapplications/core-llm-wiki`](https://equationalapplications.github.io/expo-llm-wiki/guides/okf/)。 。 。 .

Llm-wiki互操作性简介(`llm-wiki/1` 财务报告和审定财务报表 `llm-wiki/2`,参见 [`docs/okf-profile.md`](https://github.com/equationalapplications/expo-llm-wiki/blob/main/docs/okf-profile.md)遵守的固定装置 [`fixtures/`](https://npmcn.com/package/%40equationalapplications/core-okf/fixtures/)。 。 。 .

> **GraphRAG 兼容性 :** core-okf为数据库不可知. 能充电的适配器 `llm_wiki_edges` 页:1 `traverseGraph()` 住在这里 `@equationalapplications/core-llm-wiki`。见 [GraphRAG 指南](https://equationalapplications.github.io/expo-llm-wiki/guides/graphrag/)。 。 。 .

## 安装

```bash
npm install @equationalapplications/core-okf
```

## API 参考

### `serializeFrontmatter` 编号 : `parseFrontmatter`

制作和剖析 OKF 概念文档的 YAML 前题 .

```typescript
const yaml = serializeFrontmatter({ type: 'fact', id: 'fact_123' });
const { frontmatter, rest } = parseFrontmatter(fileContent);
```

### `buildConceptDocument` 编号 : `parseConcept`

将前题和下标正文合并为一个单字符串,或将已有的OKF文件分割成其组件.

```typescript
const markdown = buildConceptDocument({ type: 'task', id: 'task_1' }, '# Buy groceries');
const { frontmatter, body } = parseConcept(markdown);
```

### `buildIndexMd` 编号 : `buildRootIndexMd`

生成目录索引列表或根 OKF 目录表 .

```typescript
const sections = [{ heading: 'Facts', entries: [{ path: 'facts/fact_123.md', title: 'Fact 123' }] }];
const dirIndex = buildIndexMd(sections);
const rootIndex = buildRootIndexMd('0.1', sections);
```

### `buildLogMd` 编号 : `parseLogMd`

序列化仅按时间顺序附加的事件,或将它们重新描述为离散条目.

```typescript
const log = buildLogMd([{ date: '2026-06-23', text: 'Observation made' }]);
const events = parseLogMd(logContent);
```

### `deriveEventId`

计算 OKF 消费者给出的确定性 ID `log.md` 无行 `<!-- id: … -->` 注释(简介§7). 同一实体的同一行总是 相同的 id,所以在存储早先的复制时再次导入日志跳过它.

```typescript
const id = deriveEventId({
  entityId: 'demo',
  date: '2026-07-05',        // the heading text
  eventType: 'observation',
  summary: 'Linked to alpha',
  occurrence: 0,             // earlier id-less lines with the same date, type and summary
});
// 'evt_okf1_02dd42bf329719f258ab93b373f44506'
```

`createEventIdDeriver({ entityId, date, eventType, summary })` 返回时 `(occurrence) => id` 以同样的结果,只将摘要散开一次。 用这个 当您需要很多一行事件时.

### `extractMarkdownLinks`

剖析相对的平分平分交叉链接来映射知识图边.

```typescript
const links = extractMarkdownLinks('See [preferences](facts/fact_abc.md) for more.');
// links: [{ text: 'preferences', path: 'facts/fact_abc.md' }]
```

## 莫诺雷波生态系统

| 软件包 | 目的 |
| --- | --- |
| [@ 方程式应用程序/ core-llm-wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/core/README.md) | 持续的零星记忆 |
| [@ 方程式应用程序/ expo- llm- wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/expo/README.md) | 世博会/反应原生器的持久性瞬间记忆 |
| [@ 方程式应用/ react-llm-wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/react/README.md) | Web 的持续的零星记忆 |
| [@equental applications/prisma-outbox (英语)](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/prisma-outbox/README.md) | 同步 SQLite 发件箱事件到 Prisma |
| [@ 方程式应用程序/ 核心工具](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/core-llm-tools/README.md) | 双子座工具计划和能力注射器 |
| [**@ 方程式应用程序/ core-okf**](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/okf/README.md) | 零依赖开放知识格式 (OKF) v0.1 + v0.2 原始人——剖析并生成可互通的知识捆. |
| [@equationalapplications/schema-org-llm-wiki (英语)](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/schema-org/README.md) | Cured schema.org 温剂肿瘤特征表 |
| [@equental应用程序/schema-software-org](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/schema-software-org/README.md) | 软件组织执行本体学表——17个节点类型,40个边缘,热剂超集,只数据 |
| [@ 公式应用程序/ mcp- server](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/mcp-server/README.md) | MCP 服务器向编码代理显示 SynapseTree 内存工具 |

## OKF v0. 2 符合性

此软件包符合 [OKF v0. 2 请检查url=值 (帮助)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)。为 v. 2: 新建助手

-   `deriveTrustTier(verified)` - 从 `'unverified' | 'machine-confirmed' | 'human-reviewed'`。 。 。 .
-   `isStaleAfter(staleAfter, now)` 与绝对值相对应的 stalety 检查 `YYYY-MM-DD` 断取.
-   `parseVerifiedFlexible(value)` - 接受一个阵列或一个空的 `{ by, at }` 测绘.
-   `extractFootnotes(body)` 编号 : `serializeFootnotes(footnotes)` - 逐字保留脚注归属.
-   `parseFlowMapping(text)` 编号 : `parseFlowSequence(text)` – 流量与地图价值筑巢的多为一等(没有被引用字符串以外的锚地/别名)进行剖析.

这个 `serializeFrontmatter` 函数释放出纯对象作为流映射和演员字符串(包含 `/` 或者说 `:`)通过 `serializeActorString`. 限制/假名扩展被拒绝 **未引用** `&` 或者说 `*` 字符被视为不透明( 扫描中不包括引用的跨度, 所以 URL 查询字符串 类似 `"https://x/a?p=1&q=2"` 页:1.

## 常见问题

### @equationalapplications/core-okf 是什么？

0-依赖性 开放知识格式 \(OKF\) v0\.1 \+ v\. 2\. 原始:前事序列化\(有流图/序列\),概念文件,索引\.md和log\.md构建器,信任级和 staleness 帮助器\.

### 如何安装 @equationalapplications/core-okf？

在项目目录运行 npm install @equationalapplications/core-okf，或使用 pnpm add / yarn add / bun add。

### @equationalapplications/core-okf 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @equationalapplications/core-okf 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @equationalapplications/core-okf 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @equationalapplications/core-okf 可以商用吗？

@equationalapplications/core-okf 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @equationalapplications/core-okf 的下载量有多少？

根据 npm 官方下载统计，@equationalapplications/core-okf 在 2026/10/14 – 2026/11/12 这 30 天内被下载 8,939 次，日均约 298 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @equationalapplications/core-okf 还在维护吗？

最新版本 8\.4\.0 发布于 2026/11/13（1 天前）；至今共发布 84 个版本，其中过去 12 个月发布了 84 个；首次发布于 2026/06/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。