mindee
    Preparing search index...

    Interface WorkflowParams

    Parameters sent to workflow execution endpoints.

    interface WorkflowParams {
        alias?: string;
        fullText: boolean;
        inputDoc: InputSource;
        pageOptions?: PageOptions;
        priority?: ExecutionPriority;
        publicUrl?: string;
        rag?: boolean;
    }

    Hierarchy

    • HTTPParams
      • WorkflowParams
    Index

    Properties

    alias? fullText inputDoc pageOptions? priority? publicUrl? rag?

    Properties

    alias?: string

    Custom alias assigned to the submitted file.

    fullText: boolean

    Enables full-text OCR output when supported.

    inputDoc: InputSource

    Input source to submit to the API.

    pageOptions?: PageOptions

    Optional local page filtering options applied before upload.

    priority?: ExecutionPriority

    Processing priority of the workflow execution.

    publicUrl?: string

    Whether to request a public validation URL.

    rag?: boolean

    Enables Retrieval-Augmented Generation when supported.

    Settings

    Member Visibility

    On This Page

    Properties