跳转至

SDK 设计

状态: Implemented 读者: SDK 开发者、集成方、核心开发者 范围: Tool SDK、API-backed parser、Doclib SDK 的分层、公开接口和迁移路径 非目标: HTTP API 全量字段说明;CLI 命令手册 来源: 由旧 SDK 底稿迁移整理而来;旧底稿已归档删除

当前定位

SDK 文档定义代码集成入口。它既要让普通开发者知道如何解析一个文件,也要让核心开发者知道 parser、parse-server、doclib client 之间的边界。

当前 SDK 设计按三层组织:

  • mineru.parser: 无状态解析工具层。
  • mineru.parser.MinerUApiParser: 通过 v1 API 委托解析的 parser。
  • mineru.doclib.client.DoclibClient: 本地 doclib 的 Product SDK。

目录

  1. SDK 分层: 三层 SDK 的职责、消费者和依赖方向。
  2. Tool SDK: parser: mineru.parser 的公开入口和 parser 类。
  3. API-backed Parser: MinerUApiParser 与 parse-server / mineru.net 的关系。
  4. Doclib Client: DoclibClient 的本地文档库能力。
  5. ParseResult: 解析结果对象、输出格式和保存行为。
  6. Tier 与错误: SDK 层 tier 语义、隐私策略和错误映射。
  7. 迁移路径: 从当前代码走向目标公开契约的步骤。

与其他文档的关系

整理原则

  • 公共 import path 优先于内部文件路径。
  • 当前已实现能力与目标公开契约分开描述。
  • SDK 默认遵守隐私优先,不隐式上传本地文件到远端。
  • Tool SDK 不依赖 doclib;doclib 可以依赖 Tool SDK。
  • 对外 API 层应避免 import 时加载重依赖。
  • 其他语言 SDK 暂无开发计划;如果未来开发,只覆盖 v1 Unified API,不覆盖本地 doclib transport discovery 能力。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 mi/MinerU