Leon/docutranslate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8987e4ef6005cabdd236c4160e9abc20c9999d83
docutranslate/README.md
xunbu 8987e4ef60 docling增加artifact检测
2025-07-29 23:45:47 +08:00

14 KiB
Raw Blame History

DocuTranslate

GitHub stars github下载数 PyPI version python版本 开源协议

文件翻译工具，借助docling、minerU与大语言模型实现多种格式文件的翻译

  • 支持多种格式文件翻译
  • 提供了多种文件翻译工作流
  • 提供了一个交互式界面
  • 提供了一套多任务异步服务接口

QQ交流群：1047781902

翻译效果

整合包

  • 对于只使用基本翻译功能的用户，可以在github releases 上下载最新的整合包，该整合包点击即用，您所需的只是获取某个ai平台的api-key，和minerU的token
  • 名字为DocuTranslate的软件不支持docling，需要在minerU申请token以进行文档解析【推荐】
  • 名字为DocuTranslate_full的软件包，自带docling模型，支持docling与minerU等所有解析文档引擎

安装

使用pip

pip install docutranslate
pip install docutranslate[docling]#如果需要使用docling进行文档解析

使用uv

  1. uv init
  2. uv add docutranslate
  3. uv add docutranslate[docling]#如果需要使用docling进行文档解析

使用git

  1. git clone https://github.com/xunbu/docutranslate.git
  2. pip install -e .
  3. uv pip install -e .#使用uv

支持的文件格式

输入格式 输出格式
PDF Markdown（推荐）
Markdown HTML
HTML、XHTML PDF(仅交互界面支持)
CSV
DOC、DOCX（部分支持）

如果想不使用交互界面获取pdf，可以先下载HTML文件，用浏览器打开并打印

前置条件

本翻译工具的翻译流程总体如下：

  1. 使用文本转换引擎将文档转换成markdown（有docling（本地）、minerU（联网）两种引擎）
  2. 使用大语言模型翻译markdown文本（需要申请api-key或本地部署）

使用minerU引擎注意事项（minerU Token获取方式）

使用minerU将文档转换为markdown时，需要在minerU平台申请token

  1. 打开minerU官网申请API
  2. 申请成功后，在API Token管理界面创建API Token

mineru token有14天有效期，若过期请创建新的token

使用docling引擎注意事项

使用docling将文档转换为markdown时，需要下载模型到本地（也可以提前下载，见FAQ），因此可能会遇到一些网络问题

可以在github release中下载docling_artifact压缩包，将该压缩包解压放置在项目下可以解决模型下载的网络问题

huggingface换源（使用docling且尚未下载docling_artifact模型包）

不能科学上网的友友注意了

无法访问的huggingface的电脑在以下操作时请换源点击测试

  • 第一次读取非markdown文本
  • 第一次使用公式识别或代码识别功能

方法1

设置电脑的环境变量(记得设置后重启IDE)
HF_ENDPOINT=https://hf-mirror.com

方法2

在代码开头设置环境变量

import os

os.environ['HF_ENDPOINT'] = 'https://hf-mirror.com'

###其余代码写在下方

获取大模型平台的baseurl、key、model-id

由于需要使用大语言模型进行markdown调整与翻译，所以需要预先获取模型的baseurl、key、model-id
常见的大模型平台baseurl与api获取方式可见常用ai平台

比较推荐的模型有智谱的glm-4-air、glm-4-flash（免费），阿里云的qwen-plus等。
推理模型（不建议使用）需要支持api请求响应中区分reasoning_content和content（详见平台开发手册，ollama、lmstudio需开启对应选项）

使用方式

注意事项（使用docling转换引擎必看，使用minerU或使用整合包时可跳过）

使用docling转换引擎时以下操作会自动从huggingface下载模型，windows需要使用管理员模式 打开IDE运行脚本，并按需换源换源指南

  • 第一次使用该库读取、翻译非markdown文本
  • 第一次使用该库的公式识别或代码识别功能

启动翻译服务（及使用交互式界面）

启动服务

docutranslate -i

启动服务并指定端口

docutranslate -i -p 8011

可以通过设置DOCUTRANSLATE_PORT环境变量指定端口

服务接口文档可以浏览器访问 http://127.0.0.1:8010/docs （或指定port）进行查看

交互式界面在启动服务后访问http://127.0.0.1:8010（或指定port）

翻译文件

from docutranslate.translater import FileTranslater

translater = FileTranslater(base_url="<baseurl>",  # 大模型的baseurl
                            key="<api-key>",  # 大模型的api-key
                            model_id="<model-id>",  # 大模型的model-id
                            convert_engin="mineru",  # 使用mineru解析文档
                            mineru_token="<申请的mineru_token>"  # 使用mineru时必填
                            # convert_engin="docling"  # 使用docling解析文档
                            )

# 不开启公式、代码识别
translater.translate_file("<文件路径>", to_lang="中文")

# 开启公式、代码识别
translater.translate_file("<文件路径>", to_lang="中文", formula=True, code=True)

# 使用ai先修复解析后的文本再翻译（解析效果很差时才需要，现不推荐使用）
translater.translate_file("<文件路径>", to_lang="中文", refine=True)

下载模型时请用管理员模式打开终端运行文件（windows），并按需换源 输出文件默认放在./output中

使用不同的agent分别进行文本修正和翻译

from docutranslate import FileTranslater
from docutranslate.agents import MDRefineAgent, MDTranslateAgent

translater = FileTranslater()

refine_agent = MDRefineAgent(baseurl="<baseurl-1>", key="<key-1>", model_id="<model-id-1>")
translate_agent = MDTranslateAgent(baseurl="<baseurl-2>", key="<key-2>", model_id="<model-id-2>")

translater.translate_file("<文件路径>", to_lang="中文", refine_agent=refine_agent,
                          translate_agent=translate_agent)

自定义翻译提示词

from docutranslate import FileTranslater
from docutranslate.agents import MDTranslateAgent

translater = FileTranslater()

translate_agent = MDTranslateAgent(baseurl="<baseurl>",
                                   key="<key>",
                                   model_id="<model-id>",
                                   custom_prompt="Ordering Node全部翻译为排序节点")  # 这里必须指定baseurl\api-key\model_id

translater.translate_file("<文件路径>", to_lang="中文", translate_agent=translate_agent)

文件转换(pdf/markdown/HTML/Doc等->markdown/html)

from docutranslate import FileTranslater

translater = FileTranslater(convert_engin="mineru",  # 使用mineru解析文档
                            mineru_token="<申请的mineru_token>"  # 使用mineru时必填
                            # convert_engin="docling"  # 使用docling解析文档
                            )
# 文件转html
translater.read_file("<文件路径>").save_as_html()  # 保存(可通过output_dir参数指定保存目录)
translater.read_file("<文件路径>").export_to_html()  # 输出字符串
# 文件转markdown
translater.read_file("<文件路径>").save_as_markdown()  # 保存内嵌bas64图片的markdown
translater.read_file("<文件路径>").save_as_markdown(embed=False)  # 保存不内嵌图片的markdown（文件夹形式）
translater.read_file("<文件路径>").export_to_markdown()  # 输出内嵌图片的markdown字符串

参数说明

创建FileTranslater

from docutranslate import FileTranslater

translater = FileTranslater(base_url="<baseurl>",  # 默认的模型baseurl
                            key="<api-key>",  # 默认的大语言模型平台api-key
                            model_id="<model-id>",  # 默认的模型id
                            chunk_size=3000,  # markdown分块长度（单位byte），分块越大效果越好（也越慢），不建议超过8000
                            concurrent=30,  # 并发数，受到ai平台并发量限制，如果文章很长建议适当加大到20以上
                            timeout=2000,  # 调用api的超时时间
                            docling_artifact=None,  # 使用提前下载好的docling模型
                            convert_engin="mineru",  # 可选minerU或docling
                            mineru_token="<mineru-token>",  # minerU的token，使用minerU时必填
                            )

使用docling需要先pip install docling或uv add docling

翻译文件

translater.translate_file(r"<要翻译的文件路径>",
                          to_lang="中文",
                          formula=True,  # 是否启用公式识别
                          code=True,  # 是否启用代码识别
                          refine=False,  # 是否在翻译前先修正一遍markdown文本（较耗时）
                          output_format="markdown",  # "markdown"与"html"两种输出格式
                          output_dir="./output",  # 默认输出文件夹
                          refine_agent=None,  # 修正Agent
                          translate_agent=None  # 翻译Agent
                          )

常用ai平台

平台名称 获取APIkey baseurl
ollama http://127.0.0.1:11434/v1
lm studio http://127.0.0.1:1234/v1
openrouter 点击获取 https://openrouter.ai/api/v1
openai 点击获取 https://api.openai.com/v1/
deepseek 点击获取 https://api.deepseek.com/v1
智谱ai 点击获取 https://open.bigmodel.cn/api/paas/v4
腾讯混元 点击获取 https://api.hunyuan.cloud.tencent.com/v1
阿里云百炼 点击获取 https://dashscope.aliyuncs.com/compatible-mode/v1
火山引擎 点击获取 https://ark.cn-beijing.volces.com/api/v3
硅基流动 点击获取 https://api.siliconflow.cn/v1
DMXAPI 点击获取 https://www.dmxapi.cn/v1

FAQ

8010端口被占用了怎么办

可以通过设置系统环境变量DOCUTRANSLATE_PORT=<port>来指定启动端口

是否支持扫描件

mineru解析引擎支持，docling不支持

第一次使用很慢是怎么回事

第一次是使用时docling需要从huggingface下载转换输入文件为markdown的模型
通过设置环境变量换源或科学上网可能有助于提高下载速度

huggingface换源，请设置环境变量：HF_ENDPOINT=https://hf-mirror.com

如何内网使用（不联网）

可以，对于docling提供的解析pdf、html等功能，可以使用以下方式提前下载所需的模型

from docutranslate.utils.docling_utils import get_docling_artifacts

print(get_docling_artifacts())  # 会显示模型下载文件夹，通常在`C:\Users\<user>\.cache\docling\models`

将模型文件夹命名为docling_artifact放置在项目下 或创建FileTranslater时docling_artifact参数设置为文件夹位置

from docutranslate import FileTranslater

translater = FileTranslater(base_url="<baseurl>",
                            key="<key>",
                            model_id="<model-id>",  # 使用的模型id
                            convert_engin="docling",  # 使用docling
                            docling_artifact=r"C:\Users\<user>\.cache\docling\models"
                            )

对于本地ai翻译功能，可以使用ollama或lm studio等方式本地部署。

Filetranslater的解析缓存机制

工具默认会缓存最近10条（全局）解析记录存于内存中，可以通过DOCUTRANSLATE_CACHE_NUM环境变量进行修改

Star History

Star History Chart
Reference in New Issue View Git Blame Copy Permalink