文档阅读器
- 作者仓库星标 9,792
- 作者仓库 Vibe-Trading
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @HKUDS · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- Python
- 检测到的文件与系统行为
-
- 只读
- 命令执行
- 读取环境变量
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# Universal Document Reader
## Purpose
Return extracted text from any supported file in a single unified JSON
envelope. The tool dispatches by file extension — you always call the same
tool regardless of format.
### Supported formats
| Category | Extensions | Notes |
|---|---|---|
| PDF | `.pdf` | Text pages extracted in ms; scanned/image pages fall back to OCR |
| Word | `.docx` | Paragraphs + table cells |
| Excel | `.xlsx`, `.xls` | All sheets, first 100 rows per sheet as preview |
| PowerPoint | `.pptx` | Slide text content |
| Images | `.png/.jpg/.jpeg/.gif/.bmp/.webp/.tiff` | OCR only |
| CSV / TSV | `.csv`, `.tsv` | Raw text with encoding fallback |
| Plain text | `.txt/.md/.log/.rst` | Encoding fallback |
| Config | `.json/.yaml/.yml/.toml/.ini/.cfg/.env` | Raw text |
| Markup | `.html/.htm/.xml` | Raw text (no HTML stripping) |
| Source code | `.py/.js/.ts/.tsx/.go/.rs/.java/.cpp/.c/.sql/.sh/...` | Raw text |
| Unknown extension | anything else | Best-effort read as UTF-8/GBK text |
**Blocked** (rejected at `/upload`): executables (`.exe/.dll/.so/...`) and
archives (`.zip/.tar/...`). Ask the user to unpack archives locally first.
## Usage
**Always call the tool directly — do not run Python from bash.**
```
read_document(file_path="uploads/paper.pdf")
read_document(file_path="uploads/annual_report.pdf", pages="1-10")
read_document(file_path="uploads/contract.docx")
read_document(file_path="uploads/sales.xlsx")
read_document(file_path="uploads/deck.pptx")
read_document(file_path="uploads/chart.png") # image → OCR
read_document(file_path="uploads/config.yaml")
read_document(file_path="uploads/notes.md")
```
The `pages` parameter only applies to PDF; other formats ignore it.
## Return envelope
All formats share this shape:
```json
{
"status": "ok",
"file": "paper.pdf",
"format": "pdf",
"char_count": 52000,
"truncated": true,
"text": "..."
}
```
Format-specific extra fields:
| Format | Extra keys |
|---|---|
| `pdf` | `total_pages`, `pages_read`, `ocr_pages` |
| `docx` | `paragraphs`, `tables` |
| `excel` | `sheets` (array of `{name, rows, cols}`) |
| `pptx` | `slides` |
| `text` | `encoding`, `size` |
Content longer than 15000 chars is truncated; for PDFs use the `pages`
parameter to read slices.
## Workflows
### Paper / report summary
```
1. read_document(file_path="paper.pdf") → full text
2. Extract abstract, methodology, conclusion → summarize
```
### Contract review
```
1. read_document(file_path="contract.docx") → paragraphs + tables
2. Flag key clauses (termination, liability, payment, IP)
```
### Spreadsheet quick-look
```
1. read_document(file_path="sales.xlsx") → all sheet previews
2. If user wants trade journal analysis specifically, pivot to
`analyze_trade_journal` tool instead (see trade-journal skill).
```
### Chart / screenshot / scanned PDF
```
1. read_document(file_path="scan.png") → OCR text
2. If OCR returns empty, tell the user; don't fabricate.
```
## Notes
- **Encoding fallback** order for text: utf-8 → utf-8-sig → gbk → gb2312 → big5 → latin-1.
- **OCR** uses RapidOCR; if the package is missing, image/scanned files
return empty `text` with a `note` field — tell the user to install
`rapidocr-onnxruntime`.
- **Excel previews** are limited to 100 rows per sheet to stay in budget.
If the user needs full data (e.g. trade journals), call
`analyze_trade_journal` instead.
- **Source-code files** are returned raw; do not re-format or re-indent.
章节与文件索引
按说明文件中的顺序排列。
目的
支持的格式
用途
回邮信封
注释
文件/命令 -> .pdf · .docx · .xlsx · .xls · .pptx · .png/.jpg/.jpeg/.gif/.bmp/.webp/.tiff · .csv · .tsv
内容校验值 -> 2f5678ab9363
当前原文的自动摘译,尚未人工审校。
目的
在单个统一的 JSON 信封中返回从任何受支持的文件中提取的文本。该工具按文件扩展名进行调度 - 无论格式如何,您始终调用相同的工具。
支持的格式
类别 · 扩展 · 注释 PDF ·
.pdf· 以毫秒为单位提取的文本页面;扫描/图像页面回退为 OCR Word ·.docx· 段落 + 表格单元格 Excel ·.xlsx、.xls· 所有工作表,每张前 100 行作为预览 PowerPoint ·.pptx· 幻灯片文本内容用途
始终直接调用该工具——不要从 bash 运行 Python。
pages参数仅适用于PDF;其他格式忽略它。回邮信封
所有格式共享此形状: 格式特定的额外字段: 格式 · 额外键
pdf·total_pages、pages_read、ocr_pagesdocx·paragraphs、tables注释
文本的编码后备顺序:utf-8 → utf-8-sig → gbk → gb2312 → big5 → latin-1。 OCR使用RapidOCR;如果软件包丢失,图像/扫描文件将返回空的
text并带有note字段 — 告诉用户安装rapidocr-onnxruntime。为了不超出预算,Excel 预览限制为每张纸 100 行。