Interface StructuredText

JSON-serializable extraction result. Partial status explicitly records collected failures.

interface StructuredText {
    fullText: string;
    pageCount: number;
    pages: TextPage[];
    schemaVersion: 1;
    status: "partial" | "complete";
    warnings: ExtractionWarning[];
}

Properties

fullText: string

Plain text derived from the ordered returned pages.

pageCount: number

Total pages in the PDF, even if only a subset was requested.

pages: TextPage[]

Requested page results in deterministic page order.

schemaVersion: 1

Version of the serializable text-result schema.

status: "partial" | "complete"

complete means requested extraction succeeded; partial preserves explicit failures in collect mode.

Document-level and aggregated extraction diagnostics.