Interface OCRResult

Result returned by performOCR.

interface OCRResult {
    text: string;
    confidence: number;
    tier: VisionTier;
    category?: string;
    provider: string;
    regions?: {
        text: string;
        bbox?: {
            x: number;
            y: number;
            width: number;
            height: number;
        };
        confidence: number;
    }[];
    failedTiers?: VisionFailedTier[];
}

Properties

text confidence tier category? provider regions? failedTiers?

Properties

text

text: string

Extracted text content.

confidence

confidence: number

Overall confidence score (0 = no confidence, 1 = certain).

tier

tier: VisionTier

Which processing tier produced the winning result.

  • 'ocr' — PaddleOCR or Tesseract.js (fast, local, free).
  • 'handwriting' — TrOCR handwriting recognition (local).
  • 'document-ai' — Florence-2 document understanding (local).
  • 'cloud-vision' — Cloud LLM (GPT-4o, Claude, Gemini).

Optional category

category?: string

Content category detected by the pipeline (e.g. 'printed-text').

provider

provider: string

Provider name that produced the winning result (e.g. 'paddle', 'openai').

Optional regions

regions?: {
    text: string;
    bbox?: {
        x: number;
        y: number;
        width: number;
        height: number;
    };
    confidence: number;
}[]

Text regions with bounding boxes, when the winning tier provides spatial information. Not all tiers return region data.

Type declaration

  • text: string
  • Optional bbox?: {
        x: number;
        y: number;
        width: number;
        height: number;
    }
    • x: number
    • y: number
    • width: number
    • height: number
  • confidence: number

Optional failedTiers

failedTiers?: VisionFailedTier[]

Tiers that were due to run and failed, each with its error, such as a cloud tier whose request failed while a local tier read the text. Absent when none did.

Settings

Member Visibility

Theme

On This Page

textconfidencetiercategoryproviderregionsfailedTiers