Member Junction
    Preparing search index...

    Interface ExtractRequest

    What the Extract stage passes an extractor.

    interface ExtractRequest {
        ArchiveBudget?: ArchiveBudget;
        Confidence?: ResolvedConfidenceScale;
        Content: Uint8Array;
        FileType: string;
        Parameters: Readonly<Record<string, string>>;
        Signal: AbortSignal;
        Tuning?: ResolvedPipelineTuning;
        URL: string;
        ReportProgress(message: string): void;
    }
    Index

    Properties

    ArchiveBudget? Confidence? Content FileType Parameters Signal Tuning? URL

    Methods

    ReportProgress

    Properties

    ArchiveBudget?: ArchiveBudget

    Shared tree-wide budget when unpacking an archive or a nested archive member.

    Confidence?: ResolvedConfidenceScale

    The resolved confidence scale for this source and run.

    Content

    Content: Uint8Array

    The fetched bytes.

    FileType: string

    The resolved file type key, e.g. pdf, html, docx.

    Parameters: Readonly<Record<string, string>>

    The source's type-specific settings, already defaulted and validated.

    Signal: AbortSignal

    Fires when the run is asked to stop.

    Tuning?: ResolvedPipelineTuning

    The run's resolved tuning. An extractor that needs a limit and finds none must refuse.

    URL: string

    Where the bytes came from, for diagnostics and for resolving relative links.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods