mirror of
https://github.com/opendatalab/MinerU.git
synced 2026-10-25 17:42:08 +08:00
myhloli
7f250e2331
Converge the SDK, Gradio, remote CLI, Doclib and Router on Tasks with hash-based uploads, per-file result URLs, task listing and optional model output. Preserve Files and the synchronous file_parse wrapper while removing standalone Uploads/Jobs and local-path HTTP inputs. Migrate contract, lifecycle, transport and real-document regression coverage; update documentation and HTTP examples. Validation: 1452 passed, 3 conditional skips, plus targeted final PDF checks. BREAKING CHANGE: clients and workers must use Tasks; standalone Uploads/Jobs endpoints and local-source/inline HTTP options have been removed.
44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
# Unified API
|
|
|
|
状态: Implemented
|
|
读者: API 使用者、服务端开发者、SDK 开发者
|
|
范围: MinerU v1 API 的资源模型、认证、上传、文件、任务、对话、用量和限流
|
|
非目标: 本地 CLI 参数说明；SDK 封装细节
|
|
来源: 由根目录旧 Unified API 底稿迁移整理而来；修订记录和历史接口对比未迁移
|
|
|
|
## 当前定位
|
|
|
|
Unified API 文档描述两类部署形态下的同一套 API:
|
|
|
|
- `mineru.net` 官方远程 API。
|
|
- 本地启动的 Local Parse Server API。
|
|
|
|
两者的 endpoint、请求结构和主要响应结构尽量保持一致。新文档默认先描述 `mineru.net` 的完整行为，再在每个主题末尾说明本地 server 的简化或差异。
|
|
|
|
## 目录
|
|
|
|
1. [API 总览](api/README.md): 资源模型、端点地图、认证、通用约定。
|
|
2. [响应与错误](api/responses.md): 成功响应、错误 envelope、请求追踪。
|
|
3. [Health、Models 与 Tiers](api/health-models.md): 服务能力、模型列表、解析档位。
|
|
4. [Files](api/files.md): 文件元数据、列表、产物下载和删除。
|
|
5. [Tasks](api/tasks.md): JSON 清单、hash 缓存、逐文件上传、列表、轮询和下载。
|
|
[同步 file_parse](api/file-parse.md): 独立包装服务，单文件直传、同步附件和超时恢复。
|
|
6. [Chat 与 Responses](api/chat.md): OpenAI-compatible 文档对话接口。
|
|
7. [任务通知](api/webhooks.md): 轮询和 SDK 回调边界。
|
|
8. [Usage 与 Limits](api/usage-limits.md): access level、限流、用量查询。
|
|
9. [端到端示例](api/examples.md): 常见调用流程。
|
|
|
|
## 整理原则
|
|
|
|
- 不迁移底稿开头的历史变更说明。
|
|
- 不迁移底稿末尾面向历史接口的对比内容。
|
|
- 官方 API 是主线；本地 server 差异只在对应主题中补充。
|
|
- 可观察行为优先，内部实现细节留给架构或配置文档。
|
|
|
|
## 相关文档
|
|
|
|
- Tier 语义见 [解析 Tier](tiers.md)。
|
|
- 错误码体系见 [错误码体系](errors.md)。
|
|
- SDK 封装策略见 [SDK 设计](sdk.md)。
|
|
- 本地服务边界见 [系统架构](architecture.md)。
|