PdfInspector.Result (pdf_inspector_ex v0.1.1)

Copy Markdown View Source

Result of PdfInspector.process/1 and PdfInspector.detect/1.

pages_needing_ocr, pages_with_tables, pages_with_columns and the page fields inside ocr_reasons_by_page are 1-indexed (upstream process-level convention). markdown is nil for detect/1.

Summary

Types

pdf_type()
t()

Types

pdf_type()

@type pdf_type() :: :text_based | :scanned | :image_based | :mixed

t()

@type t() :: %PdfInspector.Result{
  confidence: float(),
  has_encoding_issues: boolean(),
  is_complex: boolean(),
  markdown: String.t() | nil,
  ocr_reasons_by_page: [PdfInspector.PageOcrReasons.t()],
  page_count: non_neg_integer(),
  pages_needing_ocr: [pos_integer()],
  pages_with_columns: [pos_integer()],
  pages_with_tables: [pos_integer()],
  pdf_type: pdf_type(),
  processing_time_ms: non_neg_integer(),
  title: String.t() | nil
}