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;
        webhookIds?: string[];
    }
    Index

    Properties

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

    Properties

    alias?: string

    Custom alias assigned to the uploaded document.

    closeFile?: boolean

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

    confidence?: boolean

    Boost the precision and accuracy of all extractions. Calculate confidence scores for all fields and fill their confidence attribute.

    modelId: string

    Identifier of the model that must process the document. Required.

    pollingOptions?: PollingOptions

    Client-side polling configuration (see PollingOptions).

    polygon?: boolean

    Calculate bounding box polygons for all fields, and fill their locations attribute.

    rag?: boolean

    Enhance extraction accuracy with Retrieval-Augmented Generation.

    rawText?: boolean

    Extract the full text content from the document as strings, and fill the raw_text attribute.

    webhookIds?: string[]

    List of webhook UUIDs that will receive the final API response.

    Settings

    Member Visibility

    On This Page

    Properties