@squidcloud/client
    Preparing search index...

    Interface ExtractDataFromDocumentResponse

    The full result of extracting data from a document, including all pages and any extracted images.

    interface ExtractDataFromDocumentResponse {
        documentMetadata?: DocumentMetadata;
        longTermStoragePath?: string;
        ocrPagesProcessed?: number;
        pages: ExtractDataFromDocumentPage[];
        spreadsheet?: SpreadsheetDocumentInfo;
    }
    Index
    documentMetadata? longTermStoragePath? ocrPagesProcessed? pages spreadsheet?
    documentMetadata?: DocumentMetadata

    Document-level metadata extracted from the source container (best-effort). Present only when the extractor was able to read it.

    longTermStoragePath?: string

    Path to the original file in cloud storage, if applicable.

    ocrPagesProcessed?: number

    Pages the OCR provider reported as processed (billed), when it reports one. Can exceed pages.length — a blank page is billed but returns no content.

    pages: ExtractDataFromDocumentPage[]

    Array of pages containing extracted data.

    spreadsheet?: SpreadsheetDocumentInfo

    Structural information about the sheets when the document is a parseable spreadsheet (best-effort). Presence marks the document for the spreadsheet summary-embedding lane.

    Settings
    Member Visibility

    On This Page
    Properties