mindee
    Preparing search index...

    Interface BaseProductParametersAbstract

    Base parameters for sending a file to a Mindee V2 product.

    interface BaseProductParameters {
        alias?: string;
        closeFile?: boolean;
        modelId: string;
        webhookIds?: string[];
        getRequestParameters(): Record<string, string>;
    }

    Hierarchy (View Summary)

    Index
    alias? closeFile? modelId webhookIds?
    getRequestParameters
    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.

    • Gets the request parameters for the enqueue request.

      Returns Record<string, string>

      A Record mapping parameter names to their string values.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods