mindee
    Preparing search index...

    Interface PredictOptions

    Options relating to predictions.

    interface PredictOptions {
        allWords?: boolean;
        cropper?: boolean;
        endpoint?: Endpoint;
        fullText?: boolean;
        pageOptions?: PageOptions;
        rag?: boolean;
        workflowId?: string;
    }

    Hierarchy

    • BaseOptions
      • PredictOptions
    Index

    Properties

    allWords? cropper? endpoint? fullText? pageOptions? rag? 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.

    endpoint?: Endpoint

    A custom endpoint.

    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.

    rag?: boolean

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

    workflowId?: string

    The ID of the workflow.

    Settings

    Member Visibility

    On This Page

    Properties