mindee
    Preparing search index...

    Interface PredictParams

    Parameters sent to synchronous/asynchronous prediction endpoints.

    interface PredictParams {
        cropper: boolean;
        fullText: boolean;
        includeWords: boolean;
        inputDoc: InputSource;
        pageOptions?: PageOptions;
        rag?: boolean;
        workflowId?: string;
    }

    Hierarchy

    • HTTPParams
      • PredictParams
    Index

    Properties

    cropper: boolean

    Enables cropper extras in the response.

    fullText: boolean

    Enables full-text OCR output when supported.

    includeWords: boolean

    Enables word-level OCR details in the response.

    inputDoc: InputSource

    Input source to submit to the API.

    pageOptions?: PageOptions

    Optional local page filtering options applied before upload.

    rag?: boolean

    Enables Retrieval-Augmented Generation when supported.

    workflowId?: string

    Optional workflow ID used for workflow-backed inference.