vibe.review.parsing.extraction.ocr.health

OCR backend health checking for diagnostics and configuration validation.

OcrHealthStatus

Result of an OCR backend health check.

Provides structured information about whether OCR is available and working, along with actionable suggestions if there are issues.

check_ocr_health 

check_ocr_health(*, backend_key: str | None = None, container_name: str | None = None, docker_binary: str = 'docker') -> OcrHealthStatus

Check if the OCR backend is properly configured and available.

This performs proactive health checks without actually running OCR, allowing early detection of configuration issues.

Parameters:
  • backend_key (str | None, default: None ) –

    OCR backend key (from config.yml review_backends.ocr.backend)

  • container_name (str | None, default: None ) –

    Docker container name to check (default from env or vibe-review-tesseract)

  • docker_binary (str, default: 'docker' ) –

    Path to docker binary
Returns:
  • OcrHealthStatus –

    OcrHealthStatus with health information and suggestions