Skip to content

README_API.md

Latest commit

 

History

History
141 lines (108 loc) · 4.81 KB

README_API.md

File metadata and controls

141 lines (108 loc) · 4.81 KB

RapidDoc Web API

基于 RapidDoc 官方 API 重新设计的 FastAPI 服务，完全兼容官方接口规范。

特性

  • ✅ 完全兼容官方 API: 基于 RapidDoc 官方 aio_do_parse 函数
  • ✅ 多文件支持: 支持批量上传和处理多个文件
  • ✅ 后端支持: pipeline（默认）
  • ✅ 灵活输出: 支持 Markdown、中间 JSON、模型输出、内容列表、图片等
  • ✅ 错误处理: 完善的错误处理和用户友好的错误信息

安装

1、使用pip安装

# 安装依赖
pip install -r requirements.txt

# 或者手动安装核心依赖
pip install rapid-doc fastapi uvicorn python-multipart

启动文件转换服务（可选）

# 支持 PDF 以外文件格式需要启动此服务
docker run -d -p 3000:3000 gotenberg/gotenberg:8

# 设置转换服务url到环境变量
os.environ.set("GOTENBERG_URL", "http://localhost:3000")

目前支持以下文件：

.123 .602 .abw .bib .bmp .cdr .cgm .cmx .csv .cwk .dbf .dif .doc .docm .docx .dot .dotm .dotx .dxf .emf .eps .epub .fodg .fodp .fods .fodt .fopd .gif .htm .html .hwp .jpeg .jpg .key .ltx .lwp .mcw .met .mml .mw .numbers .odd .odg .odm .odp .ods .odt .otg .oth .otp .ots .ott .pages .pbm .pcd .pct .pcx .pdb .pdf .pgm .png .pot .potm .potx .ppm .pps .ppt .pptm .pptx .psd .psw .pub .pwp .pxl .ras .rtf .sda .sdc .sdd .sdp .sdw .sgl .slk .smf .stc .std .sti .stw .svg .svm .swf .sxc .sxd .sxg .sxi .sxm .sxw .tga .tif .tiff .txt .uof .uop .uos .uot .vdx .vor .vsd .vsdm .vsdx .wb2 .wk1 .wks .wmf .wpd .wpg .wps .xbm .xhtml .xls .xlsb .xlsm .xlsx .xlt .xltm .xltx .xlw .xml .xpm .zabw

2、使用docker安装

参考 Docker部署说明

运行

1、使用pip安装运行

# 启动 API 服务
python app.py

# 或使用 uvicorn
uvicorn app:app --host 0.0.0.0 --port 8888

2、使用docker安装运行

参考 Docker部署说明

服务将在 http://localhost:8888 启动，API 文档可通过 http://localhost:8888/docs 访问。

API 接口

POST /file_parse

解析文件（PDF、图片）并返回结构化结果。

参数:

  • files: 要解析的文件列表（支持 PDF、PNG、JPG、JPEG、BMP、TIFF + 文件转换服务支持的）

  • output_dir: 输出目录（默认: ./output）

  • clear_output_file: 是否清理输出文件（默认: false）

  • parse_method: 解析方法（默认: auto）

  • formula_enable: 是否启用公式解析（默认: true）

  • table_enable: 是否启用表格解析（默认: true）

  • layout_config: 版面识别配置json字符串（默认: {}，枚举类型使用字符串会自动映射，如"OCRVersion.PPOCRV5"）

  • ocr_config: OCR识别配置json字符串（默认: {}）

  • formula_config: 公式识别配置json字符串（默认: {}）

  • table_config: 表格识别配置json字符串（默认: {}）

  • checkbox_config: 复选框识别配置json字符串（默认: {}）

  • image_config: 图片提取配置json字符串（默认: {}）

  • return_md: 是否返回 Markdown 内容（默认: true）

  • return_middle_json: 是否返回中间 JSON（默认: false）

  • return_model_output: 是否返回模型输出（默认: false）

  • return_content_list: 是否返回内容列表（默认: false）

  • return_images: 是否返回图片（默认: false）

  • response_format_zip: 是否zip压缩文件（默认: false）

  • start_page_id: 起始页码（默认: 0）

  • end_page_id: 结束页码（默认: 99999）

示例请求:

# 基础用法 - Pipeline 模式
curl -X POST "http://localhost:8888/file_parse" \
  -F "files=@document.pdf" \
  -F "return_md=true"
  
curl --location --request POST 'http://localhost:8888/file_parse' \
--form 'files=@document.pdf' \
--form 'return_md=true' \
--form 'return_middle_json=true' \
--form 'return_model_output=true' \
--form 'return_content_list=true' \
--form 'return_images=true' \
--form 'clear_output_file=false' \
--form 'layout_config="{\"model_type\": \"LayoutModelType.PP_DOCLAYOUTV2\"}"'

# 多文件批量处理
curl -X POST "http://localhost:8888/file_parse" \
  -F "files=@doc1.pdf" \
  -F "files=@doc2.pdf" \
  -F "files=@image.png" \
  -F "return_md=true" \
  -F "return_images=true"

响应格式:

{
  "backend": "pipeline",
  "version": "x.x.x",
  "results": {
    "示例1-论文模板": {
      "md_content": "# 文档标题\n\n文档内容...",
      "content_list": [...],
      "middle_json": {...},
      "images": {...},
    }
  }
}

与官方 API 的兼容性

本 API 完全基于 RapidDoc 官方的 aio_do_parse 函数构建，确保：

  1. 接口兼容: 参数名称和行为与官方 API 一致
  2. 功能完整: 支持所有官方后端和解析选项
  3. 结果一致: 输出格式与官方 API 保持一致
  4. 性能优化: 利用官方优化的解析逻辑