OKF 示例

OKF 示例

复制实用的 Open Knowledge Format 示例：涵盖 API、数据集、指标、运行手册与产品文档。

寻找 OKF API 示例的开发者。

API 接口 OKF 示例

用于智能体可读 API 文档的单接口参考页。

---
type: api_reference
id: api-endpoint
title: "API Endpoint OKF Example"
description: "A single endpoint reference page for agent-readable API documentation."
tags: [api, openapi, reference]
---

# Create Customer Endpoint

Creates a customer record and returns the canonical customer ID.

## Request

POST /v1/customers

Required JSON fields:

- email: customer email address
- name: display name

## Response

Returns 201 with id, email, name, and created_at.

打开独立页面

为智能体编写数据目录的数据团队。

数据集 OKF 示例

带归属、模式说明与更新频率的数据集条目。

---
type: dataset
id: dataset
title: "Dataset OKF Example"
description: "A dataset entry with ownership, schema notes, and update cadence."
tags: [dataset, catalog, analytics]
---

# Revenue Events Dataset

Revenue Events stores normalized billing events used by finance dashboards and forecasting jobs.

## Owner

Data Platform team.

## Freshness

Updated hourly from the billing warehouse.

## Fields

- event_id: stable event identifier
- account_id: customer account identifier
- amount_usd: normalized revenue amount
- occurred_at: event timestamp

打开独立页面

统一 AI 可读指标定义的分析团队。

指标 OKF 示例

带公式、注意事项与业务用途的指标定义。

---
type: metric
id: metric
title: "Metric OKF Example"
description: "A metric definition with formula, caveats, and business usage."
tags: [metric, analytics, semantic-layer]
---

# Net Revenue Retention

Net Revenue Retention measures expansion and contraction in existing customer revenue.

## Formula

(Starting MRR + Expansion MRR - Contraction MRR - Churned MRR) / Starting MRR

## Usage

Use NRR for cohort-level retention analysis and investor reporting.

## Caveats

Exclude trial accounts and one-time services revenue.

打开独立页面

把运维知识转成 OKF 的 DevOps 团队。

运行手册 OKF 示例

为智能体工作流编排的生产事故运行手册。

---
type: runbook
id: runbook
title: "Runbook OKF Example"
description: "A production incident runbook formatted for agent workflows."
tags: [runbook, incident, devops]
---

# API Latency Incident Runbook

Use this runbook when p95 API latency exceeds 900ms for more than five minutes.

## Triage

1. Check current deploy status.
2. Inspect database connection saturation.
3. Compare cache hit rate with the previous hour.

## Rollback

Rollback the latest deploy if latency rose within 15 minutes of release.

## Escalation

Page the platform owner when error rate exceeds 2%.

打开独立页面

发布智能体可读产品文档的 SaaS 团队。

产品文档 OKF 示例

范围清晰、含操作指引的产品能力页。

---
type: product_doc
id: product-docs
title: "Product Docs OKF Example"
description: "A product capability page with concise scope and workflow guidance."
tags: [product-docs, saas, support]
---

# Workspace Invitations

Workspace Invitations let administrators invite teammates by email and assign default roles.

## Availability

Available on Team and Enterprise plans.

## Workflow

1. Open Settings.
2. Select Members.
3. Enter email addresses.
4. Choose a role.
5. Send invitations.

## Permissions

Only owners and administrators can invite new members.

打开独立页面

FAQ

这些 OKF 示例有什么用？

它们为开发者提供可直接复制的起点，用于发布带类型、智能体可读的 Markdown 文件。

可以编辑 frontmatter 吗？

可以。保持 type 非空，再按需添加 title、description、id、tags、source_url、owner 等字段。

如何校验复制后的文件？

在发布或提交到知识包之前，把它粘贴进 OKF 校验器。

API 接口 OKF 示例

数据集 OKF 示例

指标 OKF 示例

运行手册 OKF 示例

产品文档 OKF 示例

相关 OKF 工具与指南

FAQ