cogstacksystems/tika-service

Apache Tika Web服务镜像

镜像概述和主要用途

本镜像实现了以Spring Boot运行的Apache Tika web服务，通过REST API接收二进制格式文档并返回提取的文本。支持Apache Tika原生的所有文档格式，相比官方Tika server，提供了对文档解析器（如PDFParser、Tesseract OCR及CogStack-Pipeline遗留解析器）的更好控制，以及对HTTP返回码的精确管理。

核心功能和特性

• REST API接口：提供文档处理端点，支持二进制流和多部分文件请求
• 多格式支持：兼容Apache Tika支持的所有文档格式
• 解析器控制：可定制使用PDFParser、Tesseract OCR等解析器
• OCR功能：集成Tesseract OCR，支持图像文本提取
• 批量处理：支持多文件同时处理
• 元数据提取：返回文档元数据（如内容类型、页数、创建日期等）
• 错误处理：通过HTTP返回码和JSON错误信息明确处理状态

使用场景和适用范围

• 文档内容提取服务
• 需要定制文档解析逻辑的应用
• 批量文档处理系统
• 集成OCR功能的文本提取需求
• 需要标准化文档元数据提取的场景

使用方法

构建（可选）

如需本地构建，在主目录执行：

bash
./gradlew build --console=plain

构建产物位于./build目录。如需跳过测试：

bash
./gradlew bootJar --console=plain

运行应用

作为独立Java应用

bash
java -jar build/jar/service-*.jar

默认监听主机8090端口。

使用Docker镜像

推荐使用Docker镜像，已包含所有依赖。最新稳定版镜像：cogstacksystems/tika-service:latest，开发版：cogstacksystems/tika-service:dev-latest。

运行容器：

bash
docker run -p 8090:8090 cogstacksystems/tika-service:latest

服务将在主机8090端口可用。

TESSERACT OCR的重要设置

处理大量或大型文档时需根据场景优化性能。默认启用Tesseract线程限制，适合小文档处理：

yaml
environment:
  OMP_THREAD_LIMIT=1

详情参考https://github.com/tesseract-ocr/tesseract/blob/7c3ac569f9c320bdc4bacea0ec66c69e2cf06a32/doc/tesseract.1.asc#environment-variables

API

API规范

服务默认监听8090端口，返回JSON格式结果。暴露以下端点：

• GET /api/info：返回服务信息及配置
• POST /api/process：处理二进制数据流
• POST /api/process_file：处理多部分文件请求
• POST /api/process_bulk：批量处理多文件（需配置use-legacy-tika-processor-as-default: false）

文档提取结果

JSON结构包含以下主要字段：

• result：提取结果及元数据
  • text：提取的文本内容
  • metadata：文档元数据
• timestamp：处理时间戳
• success：提取是否成功（布尔值）
• error：错误信息（当success: false时）

元数据可能包含：

• X-Parsed-By：使用的解析器列表
• X-OCR-Applied：是否应用OCR（布尔值）
• Content-Type：文档内容类型
• Page-Count：文档页数
• Creation-Date：文档创建日期

示例使用

基本使用

使用curl处理本地PDF文件：

bash
curl -F file=@test.pdf http://localhost:8090/api/process_file | jq

返回结果示例：

json
{
  "result": {
    "text": "Sample Type / Medical Specialty: Lab Medicine - Pathology",
    "metadata": {
      "X-Parsed-By": [
        "org.apache.tika.parser.CompositeParser",
        "org.apache.tika.parser.DefaultParser",
        "org.apache.tika.parser.microsoft.ooxml.OOXMLParser"
      ],
      "X-OCR-Applied": "false",
      "Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
    },
    "success": true,
    "timestamp": "2019-08-13T15:14:58.022+01:00"
  }
}

批量处理

需在application.yaml中设置use-legacy-tika-processor-as-default: false：

bash
curl -F file=@test1.pdf -F file=@test2.pdf http://localhost:8090/api/process_bulk

返回结果包含多个文件的提取结果数组。

配置

配置文件

所有配置参数存储在src/main/resources/application.yaml。默认配置嵌入在JAR中，可通过运行时参数指定自定义配置：

bash
java -Dspring.config.location=/app/config/ -jar /app/service-*.jar

Docker容器中，脚本scripts/run.sh默认使用/app/config/application.yaml。

可用属性

通用应用属性

• application.version：应用版本
• server.port：服务端口（默认：8090）
• spring.servlet.multipart.max-file-size：最大文件大小（默认：100MB）
• spring.servlet.multipart.max-request-size：最大请求大小（默认：100MB）

Tika服务配置（tika.processing节点）

• use-legacy-tika-processor-as-default：是否使用遗留PDF解析器（默认：true）
• fail-on-empty-files：空文档是否报错（默认：false）
• fail-on-non-document-types：不支持的文档类型是否报错（默认：true）

Tika解析器配置（tika.parsers节点）

Tesseract OCR（tesseract-ocr）

• language：OCR语言（默认：eng）
• timeout：处理超时（ms，默认：300）
• enable-image-processing：启用ImageMagick预处理（默认：false）
• apply-rotation：启用图像旋转校正（默认：false）

PDF OCR解析器（pdf-ocr-parser）

• ocr-only-strategy：仅使用OCR（默认：true）
• min-doc-text-length：文本长度阈值（超过则跳过OCR，默认：100）
• min-doc-byte-size：最小图像数据大小（字节，默认：10000）
• use-legacy-ocr-parser-for-single-page-doc：单页文档使用遗留解析器（默认：false）

遗留PDF解析器（legacy-pdf-parser）

• image-magick.timeout：ImageMagick转换超时（ms，默认：300）
• tesseract-ocr.timeout：Tesseract OCR超时（ms，默认：300）
• min-doc-text-length：文本长度阈值（超过则跳过OCR，默认：100）