opensource/MinerU
3
0
Fork 0
mirror of https://github.com/opendatalab/MinerU.git synced 2026-10-29 18:27:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: implement synchronous parsing endpoint and enhance task management

Browse Source
This commit is contained in:
myhloli
2026-03-23 16:11:47 +08:00
parent 42c278a79f
commit e4995cfd84
3 changed files with 224 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/usage/quick_usage.md
+6 -5
View File
@@ -35,23 +35,24 @@ If you need to adjust parsing options through custom parameters, you can also ch
>Access `http://127.0.0.1:8000/docs` in your browser to view the API documentation.
>
>- Health endpoint: `GET /health`
>- Task submission endpoint: `POST /tasks`
>- Asynchronous task submission endpoint: `POST /tasks`
>- Synchronous parsing endpoint: `POST /file_parse`
>- Task query endpoints: `GET /tasks/{task_id}`, `GET /tasks/{task_id}/result`
>- Compatibility route: `POST /file_parse`, which now behaves the same as `POST /tasks` and returns a `task_id` immediately
>- API outputs are controlled by the server and written to `./output` by default
>
>Async tasks are tracked only in-process for a single `mineru-api` instance. Task status is not preserved across service restarts, `--reload`, or multi-process deployments.
>`POST /tasks` returns immediately with a `task_id`. `POST /file_parse` uses the same task manager internally, waits for the task to finish, and then returns the final result synchronously.
>Tasks are tracked only in-process for a single `mineru-api` instance. Task status is not preserved across service restarts, `--reload`, or multi-process deployments.
>Completed or failed tasks are retained for 24 hours by default, then their task state and output directory are cleaned automatically. After cleanup, task status and result endpoints return `404`.
>Use `MINERU_API_TASK_RETENTION_SECONDS` and `MINERU_API_TASK_CLEANUP_INTERVAL_SECONDS` to adjust retention and cleanup polling intervals.
>
>Task submission example:
>Asynchronous task submission example:
>```bash
>curl -X POST http://127.0.0.1:8000/tasks \
> -F "files=@demo/pdfs/demo1.pdf" \
> -F "return_md=true"
>```
>
>Compatibility route example:
>Synchronous parsing example:
>```bash
>curl -X POST http://127.0.0.1:8000/file_parse \
> -F "files=@demo/pdfs/demo1.pdf" \