mindee
    Preparing search index...

    Interface InferenceParameters

    Parameters accepted by the asynchronous inference v2 endpoint.

    All fields are optional except modelId.

    const params = {
      modelId: "YOUR_MODEL_ID",
      rag: true,
      alias: "YOUR_ALIAS",
      webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
      pollingOptions: {
        initialDelaySec: 2,
        delaySec: 1.5,
      }
    };
    interface InferenceParameters {
        alias?: string;
        closeFile?: boolean;
        confidence?: boolean;
        modelId: string;
        pollingOptions?: PollingOptions;
        polygon?: boolean;
        rag?: boolean;
        rawText?: boolean;
        textContext?: string;
        webhookIds?: string[];
    }
    Index

    Properties

    alias? closeFile? confidence? modelId pollingOptions? polygon? rag? rawText? textContext? webhookIds?

    Properties

    alias?: string

    Use an alias to link the file to your own DB. If empty, no alias will be used.

    closeFile?: boolean

    By default, the file is closed once the upload is finished. Set to false to keep it open.

    confidence?: boolean

    Calculate confidence scores for values, and fill the confidence attribute of fields. Useful for automation.

    modelId: string

    Model ID to use for the inference. Required

    pollingOptions?: PollingOptions

    Client-side polling configuration (see PollingOptions).

    polygon?: boolean

    Calculate bounding box polygons for values, and fill the locations attribute of fields.

    rag?: boolean

    Use Retrieval-Augmented Generation during inference.

    rawText?: boolean

    Extract the entire text from the document as strings, and fill the rawText attribute.

    textContext?: string

    Additional text context used by the model during inference. Not recommended, for specific use only.

    webhookIds?: string[]

    Webhook IDs to call after all processing is finished. If empty, no webhooks will be used.

    Settings

    Member Visibility

    On This Page

    Properties