mauvilsa/tesseract-recognize

tesseract-recognize 镜像文档

镜像概述

tesseract-recognize是一款基于Tesseract OCR引擎的工具，主要用于对图像进行布局分析和文本识别，并将结果以Page XML格式输出。该工具支持Docker容器化部署，提供命令行和REST API两种交互方式，适用于需要从图像中提取结构化文本信息的场景。

核心功能与特性

• OCR能力：集成Tesseract OCR引擎，支持文本识别与布局分析（如段落、行、单词层级检测）
• 输出格式：结果以Page XML格式输出，便于结构化存储和后续处理
• 多语言支持：可通过挂载tessdata卷扩展支持的语言（默认仅包含英文）
• 部署灵活：提供Docker镜像，简化环境依赖管理
• 交互方式：支持命令行直接调用和REST API接口，适应不同使用场景

使用场景

• 文档数字化：将扫描图像或图片中的文本转换为结构化的Page XML格式
• OCR后处理：作为OCR流程的一环，提供标准化的文本布局与内容输出
• 文本分析：为文本挖掘、信息提取等任务提供结构化输入数据
• 自动化集成：通过API接口嵌入到需要OCR能力的应用系统中

Docker安装与使用

镜像拉取

该镜像基于Ubuntu 18.04构建，使用默认软件源中的Tesseract版本。首先需拉取指定标签的镜像：

bash
TAG="SELECTED_TAG_HERE"  # 替换为实际标签，如ubuntu18.04
docker pull mauvilsa/tesseract-recognize:$TAG

多语言支持：创建tessdata卷

基础镜像仅包含英文语言文件，如需支持其他语言，需创建包含多语言数据的卷：

bash
# 拉取语言数据镜像
docker pull mauvilsa/tesseract-recognize-langs:ubuntu18.04-pkg

# 创建tessdata卷（包含tesseract-ocr-*包中的所有语言数据）
docker run \
  --rm \
  --mount source=tesseract-ocr-tessdata,destination=/usr/share/tesseract-ocr/4.00/tessdata \
  -it mauvilsa/tesseract-recognize-langs:ubuntu18.04-pkg

命令行接口

依赖工具安装

需先安装docker-cli工具以简化容器内命令调用：

bash
# 下载并安装docker-cli
wget -O $HOME/.local/bin/docker-cli https://raw.githubusercontent.com/omni-us/docker-command-line-interface/master/docker-cli
chmod +x $HOME/.local/bin/docker-cli

# 验证安装（可选：配置bash补全，参考docker-cli --help）
docker-cli --help

基本使用

通过docker-cli调用工具，支持直接处理图像文件并输出Page XML：

bash
# 基础用法（英文识别）
docker-cli \
  --ipc=host \
  -- mauvilsa/tesseract-recognize:$TAG \
  tesseract-recognize IMAGE1 IMAGE2 -o OUTPUT.xml

# 使用多语言数据卷（需先创建tessdata卷）
docker-cli \
  --ipc=host \
  --mount source=tesseract-ocr-tessdata,destination=/usr/share/tesseract-ocr/4.00/tessdata \
  -- mauvilsa/tesseract-recognize:$TAG \
  tesseract-recognize INPUT.xml -o OUTPUT.xml

便捷别名设置

为简化命令，可创建别名：

bash
alias tesseract-recognize-docker="docker-cli --ipc=host --mount source=tesseract-ocr-tessdata,destination=/usr/share/tesseract-ocr/4.00/tessdata -- mauvilsa/tesseract-recognize:$TAG tesseract-recognize"

# 使用别名调用
tesseract-recognize-docker --help  # 查看帮助
tesseract-recognize-docker img.png -o result.xml  # 处理图像

API接口

启动API服务

镜像内置Python Flask服务器，默认暴露5000端口，可通过以下命令启动：

bash
docker run --rm -t -p 5000:5000 mauvilsa/tesseract-recognize:$TAG

API端点说明

API调用示例

使用curl调用API处理图像：

bash
# 处理单张图像，指定布局层级为单词
curl -o output.xml -F images=@img.png -F options='["--layout", "word"]' http://localhost:5000/tesseract-recognize/process

# 处理Page XML文件（需同时上传关联图像）
curl -o output.xml -F images=@img1.png -F images=@img2.png -F pagexml=@input.xml http://localhost:5000/tesseract-recognize/process

接口文档查看

启动服务后，可通过浏览器访问以下地址查看API详情：

• Swagger UI：http://localhost:5000/tesseract-recognize/swagger

结果查看工具

识别结果（Page XML格式）可通过以下工具查看或编辑：

• https://github.com/mauvilsa/nw-page-editor
• PRImA Research Tools
• Transkribus

贡献与版权

贡献指南

如需贡献代码，提交前需执行githook-pre-commit设置预提交钩子，以自动更新工具版本信息。

版权信息

本项目采用MIT许可证（MIT License），版权所有 (c) 2015-present, Mauricio Villegas <***>。