mindee
    Preparing search index...

    Interface WorkflowOptions

    Options relating to workflows.

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

    Hierarchy

    • BaseOptions
      • WorkflowOptions
    Index

    Properties

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

    Properties

    alias?: string

    Alias to give to the document.

    fullText?: boolean

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

    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.

    priority?: ExecutionPriority

    Priority to give to the document.

    publicUrl?: string

    A unique, encrypted URL for accessing the document validation interface without requiring authentication.

    rag?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties