Watch

gms-mineru is a framework for interfacing Go based applications with the API presented by the OpenAPI services made available through the MinerU Router and standalone API services.

go golang machine-learning mineru pdf pdf-converter pdf-document-processor pdf-to-markdown text-extraction

Go 100%

Find a file

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
Stephen Kapp 0acd777370 chore: add string() to all the constant types		2026-09-23 07:24:24 +01:00
.github/workflows	chore: housekeeping	2026-09-16 12:55:15 +01:00
.memory-bank	cline-mem: document V1 client testing patterns	2026-09-16 13:52:26 +01:00
examples/parse-file	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
pkg	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
references	chore: tweak reference docs	2026-09-16 13:28:34 +01:00
.gitignore	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
.markdownlint-cli2.jsonc	chore: tweak reference docs	2026-09-16 13:28:34 +01:00
base.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
config.go	feat: migrate client to use new MinerU 4.x V1 API, initial implementation of client and implementation of core types	2026-09-16 02:16:07 +01:00
constants.go	chore: add string() to all the constant types	2026-09-23 07:24:24 +01:00
content_types.go	feat: migrate client to use new MinerU 4.x V1 API, initial implementation of client and implementation of core types	2026-09-16 02:16:07 +01:00
COPYING.md	chore: housekeeping	2026-09-16 12:55:15 +01:00
create.go	chore: further cleanup and documentation	2026-09-16 12:48:10 +01:00
files.go	chore: further cleanup and documentation	2026-09-16 12:48:10 +01:00
go.mod	chore: housekeeping	2026-09-16 12:55:15 +01:00
go.sum	chore: housekeeping	2026-09-16 12:55:15 +01:00
jobs.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
LICENSE	chore: housekeeping	2026-09-16 12:55:15 +01:00
mineru.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
nullable.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
nullable_test.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00
README.md	chore: tweak reference docs	2026-09-16 13:28:34 +01:00
response.go	chore: further cleanup and documentation	2026-09-16 12:48:10 +01:00
SECURITY.md	init: initial commit	2026-09-05 05:03:52 +01:00
usage.go	feat: migrate client to use new MinerU 4.x V1 API, initial implementation of client and implementation of core types	2026-09-16 02:16:07 +01:00
version.go	docs(test): expanding docs and adding more tests, and undo the shitty tab formatting	2026-09-16 14:15:08 +01:00

README.md

GMS MinerU Client Library

Introduction

MinerU is a document extraction, deep learning document analysis and conversion framework, which can also be run as a service.

This package is a framework for interfacing Go based applications with the API presented by the OpenAPI services made available through the MinerU Router and standalone API services. The service implements an OpenAPI structured API however generated API libraries in Go tend to be cumbersome and this package aims to simplify interactions by implementing a concise Go based interface to the presented OpenAPI structured endpoints.

MinerU Reference Documentation

The references folder contains useful documentation cherry picked from the MinerU project and if needed tweaked to ensure it is readable in English as a good portion of the MinerU documentation is either in Chinese or has be roughly translated from Chinese. As such the documentation in this folder may differ slightly from the original in tone or grammar as it has undergone a English Technical Author proof read to remove any potentially ambiguous elements.

API Versions

There are two API versions handled by this package, the initial MinerU 3.x.x based API is represented as the mineru-legacy API within the package. This element of the package is likely only see minor updates to fix bugs and package breaking issues. The core of the package has moved to supper the new MinerU 4.x.x based V1 API, which is currently under development. The new API is a significantly different approach and is not compatible with the older now legacy API.

Features

Formulas - LaTeX - Tables - HTML, accurate complex layout reconstruction
Supports scanned docs, handwriting, multi-column layouts, cross-page table merging
Output follows human reading order with automatic header/footer removal
VLM + OCR dual engine, 109-language OCR recognition
Leverages the Self-Hosted MinerU 4.x V1 API