docs · v0.7.8 · 构建套件

60 秒构建 kolm

本页所有示例都是 kolm.ai 在 2026-05-11 真实捕获的响应。复制任意代码块并粘贴到终端运行即可。如果失效,请提交 issue。

代码块、CLI 命令、API 端点、环境变量名以及 JSON 键保持英文,因为它们在不同语言下保持不变。

快速开始

注册、获取密钥、用两个示例编译一个脱敏函数,然后在真实输入上运行。六行命令完成。

$ curl -sX POST https://kolm.ai/v1/signup \
    -H 'content-type: application/json' \
    -d '{"email":"you@example.com","plan":"free"}'
$ export KOLM_KEY=ks_...                            # 取自上面的响应
$ curl -sX POST https://kolm.ai/v1/synthesize \
    -H "authorization: Bearer $KOLM_KEY" -H 'content-type: application/json' \
    -d '{"name":"redact","positives":[{"input":"token=sk_live_xxx","expected":"[REDACTED]"}]}'
$ curl -sX POST https://kolm.ai/v1/run \
    -H "authorization: Bearer $KOLM_KEY" -H 'content-type: application/json' \
    -d '{"concept_id":"cpt_...","input":"my token=sk_live_abc123"}'

40 微秒、一个 HMAC、一份签名回执 (signed receipt)。这就是整个循环。

身份认证 (Authentication)

authorization 头中使用 Bearer token。可从 POST /v1/signup/signup 获取。免费层每月包含 10,000 次调用。

curl -H "authorization: Bearer ks_..." https://kolm.ai/v1/account

安装 CLI

npm i -g github:sneaky-hippo/kolmogorov-stack
kolm login

注册 (Sign up)

POST/v1/signupno auth
curl -X POST https://kolm.ai/v1/signup \
  -H 'content-type: application/json' \
  -d '{"email":"you@example.com","plan":"free"}'
注意: API 密钥只会显示一次。请妥善保存。丢失后可通过 POST /v1/account/rotate-key 轮换。

Synthesize (合成)

把一组输入/期望输出的样本对,编译成一个可分类、脱敏或转换的 JavaScript 函数。返回 concept_id 和一个质量分数。

POST/v1/synthesizebearer
curl -X POST https://kolm.ai/v1/synthesize \
  -H "authorization: Bearer $KOLM_KEY" \
  -H 'content-type: application/json' \
  -d '{ "name":"redact-secrets", "positives":[ { "input":"token=sk_live_xxx", "expected":"[REDACTED]" } ] }'

K-score 默认阈值为 0.85。低于阈值的编译会返回 accepted: false,并指出未通过的维度。补充更多示例或调整 spec 后重新提交即可。

Run (运行)

对新的输入执行已编译的 concept。返回输出以及一份签名回执,任何持有相同密钥的人都可以重新验证。

POST/v1/runbearer
curl -X POST https://kolm.ai/v1/run \
  -H "authorization: Bearer $KOLM_KEY" \
  -H 'content-type: application/json' \
  -d '{ "concept_id":"cpt_mp11ol06a...", "input":"my token=sk_live_abc123" }'

回执 (Receipts)

当前已交付: 每个 .kolm 工件携带一个对归档内容 (manifest + 层哈希) 的 HMAC-SHA256 签名。每个 /v1/run 响应都会返回一个 _kolm 元数据块,其中包含 source_hash · input_hash · output_hash · version_id · issued_at,签发方或持有共享租户回执密钥的任何人均可重新验证。目标架构: 跨请求的逐次 HMAC 链以及基于 Ed25519 公钥的回执仍在路线图上,尚未交付。

.kolm 文件格式

一个签名的 zip 文件,包含五个文件: spec.json (配方)、policy.json (闸口)、recall/ (可选的边车)、verifier.js (低成本的输出检查)、receipt.json (HMAC 链)。完整 schema 见 /spec

K-score

按工件,而非按模型。 每个编译出来的 .kolm 都基于其自身的评测集生成独立的 K-score;该分数衡量的是这个工件,而不是其下层的基础模型。一个标量,以 0.85 作为发布闸口。计算公式为 0.40·A + 0.15·(S + L + C + V),其中 A 表示准确率 (accuracy)、S 表示特异度 (specificity)、L 表示延迟 (latency)、C 表示成本 (cost)、V 表示可验证性 (verifiability)。完整分解见 /k-score

CLI

八个动词覆盖完整闭环。认证方式与 API 相同;kolm login 会把密钥存到 ~/.kolm/config.json

kolm init              # 初始化 kolm.yaml + examples/
kolm compile           # synthesize · 签名 · 写出 .kolm
kolm run file.kolm     # 执行并发出回执
kolm tune --airgap     # 从已捕获的运行训练一个 LoRA 适配器
kolm rag attach docs/  # 构建 BM25 边车
kolm serve --mcp       # 面向 Claude Code / Cursor 的本地 MCP 服务
kolm install claude-code   # 接入 agent 框架
kolm doctor            # 检查环境、密钥、端口、版本

MCP serve

kolm serve --mcp 通过 stdio 将本地工件以 MCP 工具的形式暴露出来 (MCP 的默认方式)。客户端把它作为子进程启动 ── kolm install <harness> --apply 会把启动配置写入 claude-code / cursor / continue / cline 对应的位置。传入 --http 可在 127.0.0.1:8765 额外开启 HTTP JSON-RPC 端点。

远程访问

默认部署是本地的。kolm serve --local 将运行时绑定到本机;笔记本、手机或编码 agent 通过你自己的网络访问它。你的提示词与输出永远不会经过我们的基础设施 ── 因为没有这样的基础设施。

对于希望在不信任厂商的前提下获得托管访问的团队,可以把同一个 .kolm 跑在 TEE (Trusted Execution Environment、可信执行环境) 中。硬件飞地 (AWS Nitro、GCP Confidential、Azure SEV) 会把模型、权重以及请求数据封闭起来,使 kolm 和云厂商都无法读取。相对安全、相对私密;并不是密码学层面的强保证,但这是对云上推理最诚实的表述。

OpenAI 兼容

运行时在 localhost:8765 暴露 /v1/chat/completions/v1/models/v1/embeddings。把任何兼容 OpenAI 的客户端指向它即可;工具调用与流式响应都按文档行为工作。每次请求都会发出一份签名回执。

合规包 (Compliance packs)

合规包是 (recipe.json + evidence.md + dpia.md + mrm.md + controls.md) 的版本化捆绑,描述某项任务的合规形态: 哪些字段必须脱敏、哪些字段必须校验、审计师会问什么 ── 让工程团队和法务团队的目标对齐。

当前发布三个合规包,分别位于 data/compliance-packs/<pack>/: HIPAA (PHI 脱敏,K 阈值 0.92)、SR 11-7 (美联储模型风险管理)、SOX-lite (针对 AI 的 ITGC)。

关于此翻译

本中文版仅涵盖摘要部分;代码块、CLI 命令、API 端点、JSON 形态及错误码因不随语言变化而保持英文。完整参考、所有教程及最新示例,请查阅英文原文: kolm.ai/docs