mindee
    Preparing search index...

    Interface BaseParametersAbstract

    Parameters accepted by all v2 products.

    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"],
    };
    interface BaseParameters {
        alias?: string;
        closeFile?: boolean;
        modelId: string;
        webhookIds?: string[];
        getFormData(): FormData;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alias? closeFile? modelId webhookIds?

    Methods

    getFormData

    Properties

    alias?: string

    Optional: a free-form string to tag the request with your own identifier. For example, an internal document ID, reference number, or database key. If set, it will be included in the job and result responses.

    closeFile?: boolean

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

    modelId: string

    Model ID to use for the inference. Required.

    webhookIds?: string[]

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

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods