mindee
    Preparing search index...

    Interface OptionalAsyncOptions

    Asynchronous polling parameters.

    interface OptionalAsyncOptions {
        allWords?: boolean;
        cropper?: boolean;
        delaySec?: number;
        endpoint?: Endpoint;
        fullText?: boolean;
        initialDelaySec?: number;
        initialTimerOptions?: TimerOptions;
        maxRetries?: number;
        pageOptions?: PageOptions;
        rag?: boolean;
        recurringTimerOptions?: TimerOptions;
        workflowId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allWords? cropper? delaySec? endpoint? fullText? initialDelaySec? initialTimerOptions? maxRetries? pageOptions? rag? recurringTimerOptions? workflowId?

    Properties

    allWords?: boolean

    Whether to include the full text for each page.

    This performs a full OCR operation on the server and will increase response time.

    cropper?: boolean

    Whether to include cropper results for each page.

    delaySec?: number

    Delay in seconds between polling attempts.

    endpoint?: Endpoint

    A custom endpoint.

    fullText?: boolean

    Whether to include the full ocr text. Only available on compatible APIs.

    initialDelaySec?: number

    Delay in seconds before the first polling attempt.

    initialTimerOptions?: TimerOptions

    Timer options used for the first delay.

    maxRetries?: number

    Maximum number of polling attempts.

    pageOptions?: PageOptions

    If set, remove pages from the document as specified. This is done before sending the file to the server and is useful to avoid page limitations.

    rag?: boolean

    If set, will enable Retrieval-Augmented Generation (only works if a valid workflowId is set).

    recurringTimerOptions?: TimerOptions

    Timer options used for recurring polling delays.

    workflowId?: string

    The ID of the workflow.

    Settings

    Member Visibility

    On This Page

    Properties