mineru-open-sdk 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/README.zh-CN.md +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,8 +14,8 @@ The published package targets Node.js 18+. Bun and Deno can also work when Node-
|
|
|
14
14
|
## 🚀 Key Features
|
|
15
15
|
|
|
16
16
|
- **Completely Free**: No hidden costs for document extraction.
|
|
17
|
-
- **Flash
|
|
18
|
-
- **
|
|
17
|
+
- **Flash Extract (No Auth)**: Extract text instantly without an API token.
|
|
18
|
+
- **Precision Extract**: Comprehensive extraction with layout preservation, images, and formula support.
|
|
19
19
|
- **Blocking And Async Primitives**: Use `extract()` for simple flows, or `submit()` / `getTask()` / `getBatch()` for your own polling logic.
|
|
20
20
|
- **Built-in Save Helpers**: Save Markdown, HTML, LaTeX, DOCX, or the full extracted zip with exported helpers.
|
|
21
21
|
|
|
@@ -45,7 +45,7 @@ const result = await client.flashExtract(
|
|
|
45
45
|
console.log(result.markdown);
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
### 2.
|
|
48
|
+
### 2. Precision Extract (Auth Required)
|
|
49
49
|
Supports large files, rich assets (images/tables), and multiple formats.
|
|
50
50
|
|
|
51
51
|
```typescript
|
|
@@ -112,7 +112,7 @@ console.log(result.images);
|
|
|
112
112
|
|
|
113
113
|
## 📊 Mode Comparison
|
|
114
114
|
|
|
115
|
-
| Feature | Flash Extract |
|
|
115
|
+
| Feature | Flash Extract | Precision Extract |
|
|
116
116
|
| :--- | :--- | :--- |
|
|
117
117
|
| **Auth** | **No Auth Required** | **Auth Required (Token)** |
|
|
118
118
|
| **Speed** | Blazing Fast | Standard |
|
|
@@ -136,7 +136,7 @@ console.log(result.images);
|
|
|
136
136
|
|
|
137
137
|
If neither `token` nor `process.env.MINERU_TOKEN` is available, the client works in **flash-only mode**: `flashExtract()` works, while auth-required methods throw `NoAuthClientError`.
|
|
138
138
|
|
|
139
|
-
###
|
|
139
|
+
### Precision methods
|
|
140
140
|
|
|
141
141
|
These defaults apply to `extract()`, `submit()`, `extractBatch()`, and `submitBatch()` unless noted otherwise.
|
|
142
142
|
|
|
@@ -159,7 +159,7 @@ These defaults apply to `extract()`, `submit()`, `extractBatch()`, and `submitBa
|
|
|
159
159
|
- `crawlBatch()` is shorthand for `extractBatch(urls, { model: "html", ... })`
|
|
160
160
|
- `crawl()` / `crawlBatch()` only expose `extraFormats` and `timeout`, not OCR/table/formula switches
|
|
161
161
|
|
|
162
|
-
### Flash
|
|
162
|
+
### Flash Extract
|
|
163
163
|
|
|
164
164
|
| Option | Default | Behavior when omitted |
|
|
165
165
|
| :--- | :--- | :--- |
|
|
@@ -174,13 +174,13 @@ These defaults apply to `extract()`, `submit()`, `extractBatch()`, and `submitBa
|
|
|
174
174
|
- `extract("./file.pdf")`, `submit("./file.pdf")`, `flashExtract("./file.pdf")`, and all save helpers rely on `node:fs/promises` and `node:path`. Use them in Node.js, Bun, or Deno with Node compatibility.
|
|
175
175
|
- Standard browser runtimes are not a first-class target today because the SDK imports Node modules for local-file and save helpers. If your toolchain can bundle it anyway, stick to URL-based inputs and in-memory results.
|
|
176
176
|
- The `MINERU_TOKEN` fallback is Node-style. In browsers, pass the token explicitly: `new MinerU("your-api-token")`.
|
|
177
|
-
- Flash results only contain Markdown. `saveDocx()`, `saveHtml()`, `saveLatex()`, and `saveAll()` require a
|
|
177
|
+
- Flash results only contain Markdown. `saveDocx()`, `saveHtml()`, `saveLatex()`, and `saveAll()` require a precision result that has already reached `state === "done"`.
|
|
178
178
|
|
|
179
179
|
---
|
|
180
180
|
|
|
181
181
|
## 📖 Detailed Usage
|
|
182
182
|
|
|
183
|
-
###
|
|
183
|
+
### Precision Extraction Options
|
|
184
184
|
|
|
185
185
|
```typescript
|
|
186
186
|
import { MinerU, saveAll } from "mineru-open-sdk";
|
|
@@ -294,4 +294,4 @@ This project is licensed under the Apache-2.0 License.
|
|
|
294
294
|
## 🔗 Links
|
|
295
295
|
|
|
296
296
|
- [Official Website](https://mineru.net)
|
|
297
|
-
- [API Documentation](https://mineru.net/docs)
|
|
297
|
+
- [API Documentation](https://mineru.net/apiManage/docs)
|
package/README.zh-CN.md
CHANGED
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
## 🚀 核心特性
|
|
15
15
|
|
|
16
16
|
- **完全免费**:文档提取服务没有任何隐藏费用。
|
|
17
|
-
-
|
|
18
|
-
-
|
|
17
|
+
- **Agent 轻量解析 (No Auth)**:无需 API Token 即可立即提取。
|
|
18
|
+
- **精准解析**:提供完整的版式保留、图片、表格及公式支持。
|
|
19
19
|
- **阻塞式与异步原语并存**:简单流程直接用 `extract()`,需要自定义轮询时使用 `submit()` / `getTask()` / `getBatch()`。
|
|
20
20
|
- **内置结果保存方法**:可直接保存 Markdown、HTML、LaTeX、DOCX,或解压完整结果包。
|
|
21
21
|
|
|
@@ -31,7 +31,7 @@ npm install mineru-open-sdk
|
|
|
31
31
|
|
|
32
32
|
## 🛠️ 快速上手
|
|
33
33
|
|
|
34
|
-
### 1.
|
|
34
|
+
### 1. Agent 轻量解析 (Flash Extract - 免登录,只支持 Markdown)
|
|
35
35
|
适合快速预览。无需配置 Token。
|
|
36
36
|
|
|
37
37
|
```typescript
|
|
@@ -45,7 +45,7 @@ const result = await client.flashExtract(
|
|
|
45
45
|
console.log(result.markdown);
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
### 2.
|
|
48
|
+
### 2. 精准解析 (Precision Extract - 需登录)
|
|
49
49
|
支持大文件、丰富资产(图片/表格)以及多种输出格式。
|
|
50
50
|
|
|
51
51
|
```typescript
|
|
@@ -112,7 +112,7 @@ console.log(result.images);
|
|
|
112
112
|
|
|
113
113
|
## 📊 模式对比
|
|
114
114
|
|
|
115
|
-
| 特性 |
|
|
115
|
+
| 特性 | Agent 轻量解析 (Flash) | 精准解析 (Precision) |
|
|
116
116
|
| :--- | :--- | :--- |
|
|
117
117
|
| **身份认证** | **免登录 (No Auth)** | **需登录 (Token)** |
|
|
118
118
|
| **处理速度** | 极速 | 标准 |
|
|
@@ -159,7 +159,7 @@ console.log(result.images);
|
|
|
159
159
|
- `crawlBatch()` 等价于 `extractBatch(urls, { model: "html", ... })`
|
|
160
160
|
- `crawl()` / `crawlBatch()` 只暴露 `extraFormats` 和 `timeout`,不提供 OCR / 表格 / 公式开关
|
|
161
161
|
|
|
162
|
-
### Flash
|
|
162
|
+
### Flash Extract
|
|
163
163
|
|
|
164
164
|
| 参数 | 默认值 | 省略时行为 |
|
|
165
165
|
| :--- | :--- | :--- |
|
|
@@ -294,4 +294,4 @@ if (result?.state === "done") {
|
|
|
294
294
|
## 🔗 相关链接
|
|
295
295
|
|
|
296
296
|
- [官方网站](https://mineru.net)
|
|
297
|
-
- [API 文档](https://mineru.net/docs)
|
|
297
|
+
- [API 文档](https://mineru.net/apiManage/docs)
|