OCR and Markdown Conversion API

A simple web interface for testing the OCR and Markdown Conversion API.

Quick Start

1. Clone this repository
2. Run docker-compose up -d
3. Open your browser and navigate to http://localhost:9000

API Overview

The OCR and Markdown Conversion API allows you to convert image files and documents into Markdown format. It provides the following endpoints:

• Upload files for OCR processing
• Check processing progress
• Download converted Markdown files
• Clean up stored files
• Health check

API Endpoints

Upload Files

Upload one or more files to be processed by the OCR engine.

Endpoint: POST /upload/

Parameters:

• files (required): Array of files to upload
• force_ocr (optional): Boolean to force OCR processing even if text is detected (default: true)

Response:

{
  "total_processing_time_seconds": 1.39,
  "results": [
    {
      "file_name": "text-image-title.png",
      "page_count": 1,
      "processing_time_seconds": 1.39,
      "status": "Success",
      "content_preview": "# Page 1\n\n```\nHOW TO COMBINE\nTEXT AND IMAGE\nIN ELEARNING DESIGN\n\n```\n\n-----\n\n---",
      "markdown_content": "# Page 1\n\n```\nHOW TO COMBINE\nTEXT AND IMAGE\nIN ELEARNING DESIGN\n\n```\n\n-----\n\n---",
      "ocr_pdf_id": null,
      "markdown_id": "7f8f10c8-d51b-4773-9db8-5e748f12aa3d",
      "file_id": "413a9347-79ce-434e-bfac-27eab54db928"
    }
  ]
}

Check Progress

Check the processing status of an uploaded file.

Endpoint: GET /progress/{file_id}

Parameters:

• file_id (required): ID of the file to check

Response:

A string containing the progress information.

Download Markdown

Download the converted Markdown file.

Endpoint: GET /download-markdown/{md_id}

Parameters:

• md_id (required): ID of the Markdown file to download

Response:

A string containing the Markdown content.

Cleanup File

Remove a stored file from the server.

Endpoint: DELETE /cleanup/{file_id}

Parameters:

• file_id (required): ID of the file to clean up

Response:

A string confirming the cleanup operation.

Health Check

Check the health status of the API.

Endpoint: GET /health

Response:

A string containing the health status information.

How to Use

1. Upload Files:
   • Go to the "Upload File" tab
   • Select one or more files using the file input
   • Choose whether to force OCR processing
   • Click "Upload" to submit the files
2. Check Progress:
   • Go to the "Check Progress" tab
   • Enter the file ID received from the upload response
   • Click "Check Progress" to see the processing status
3. Download Markdown:
   • Go to the "Download Markdown" tab
   • Enter the Markdown ID received from the upload response
   • Click "Download" to retrieve the converted content
4. Cleanup Files:
   • Go to the "Cleanup File" tab
   • Enter the file ID you want to remove
   • Click "Cleanup" to delete the file from the server
5. Health Check:
   • Go to the "Health Check" tab
   • Click "Check Health" to verify the API is running

Understanding the Response

When you upload a file, the API returns a JSON response with the following information:

• total_processing_time_seconds: Total time taken to process all files
• results: Array of processing results for each file
  • file_name: Original name of the uploaded file
  • page_count: Number of pages in the document
  • processing_time_seconds: Time taken to process this specific file
  • status: Processing status (Success, Failed, etc.)
  • content_preview: A preview of the extracted content
  • markdown_content: The full Markdown content of the processed file
  • ocr_pdf_id: ID for the OCR processed PDF (if applicable)
  • markdown_id: ID for the Markdown content (used for downloading)
  • file_id: ID for the uploaded file (used for progress checking and cleanup)

Configuration

The API URL is set to http://192.168.1.151:8000 by default. You can change this by clicking the "Change" button next to the API URL at the top of the interface.

Troubleshooting

• If you receive a connection error, verify that the API server is running and accessible from your network
• Make sure you're using the correct file_id and markdown_id values when checking progress or downloading content
• For large files, processing may take some time. Use the progress endpoint to check status

Docker Setup

This interface is containerized using Docker. To run it:

1. Make sure Docker and Docker Compose are installed
2. Run docker-compose up -d in the directory containing the docker-compose.yml file
3. Access the interface at http://localhost:9000

To stop the container, run docker-compose down.