Briyah SDK - v2.0.6
    Preparing search index...

    Interface PdfConversionOptions

    How a conversion should be run. Every field has an environment-backed default.

    interface PdfConversionOptions {
        attempts?: number;
        concurrency?: number;
        onProgress?: (message: string) => void;
        pageTimeoutMs?: number;
        retryBackoffMs?: number;
    }

    Hierarchy (View Summary)

    Index
    attempts? concurrency? onProgress? pageTimeoutMs? retryBackoffMs?
    attempts?: number

    Attempts per page before giving up. Defaults to PDF_CONVERT_PAGE_ATTEMPTS or 3.

    concurrency?: number

    How many pages may be converted at once.

    The reason this exists: converting every page concurrently is what a 146-page document did before there was a cap, and the provider rate-limited most of them. Defaults to PDF_CONVERT_CONCURRENCY or 20.

    onProgress?: (message: string) => void

    Called as pages complete, for a caller with somewhere to show it.

    pageTimeoutMs?: number

    Per-attempt timeout. Defaults to PDF_CONVERT_PAGE_TIMEOUT_MS or 2 minutes.

    retryBackoffMs?: number

    Base delay for the exponential backoff between attempts. Defaults to 1000ms.

    Settings
    Member Visibility

    On This Page
    Properties