mindee
    Preparing search index...

    Class ClientV2

    Mindee Client V2 class that centralizes most basic operations.

    Index

    Asynchronous

    • Retrieves an inference.

      Parameters

      • inferenceId: string

        id of the queue to poll.

      Returns Promise<InferenceResponse>

      a Promise containing a Job, which also contains a Document if the parsing is complete.

    • Get the status of an inference that was previously enqueued. Can be used for polling.

      Parameters

      • jobId: string

        id of the queue to poll.

      Returns Promise<JobResponse>

      a Promise containing a Job, which also contains a Document if the parsing is complete.

    Other

    • Parameters

      • options: ClientOptions = ...

        options for the initialization of a client.

      Returns ClientV2

    mindeeApi: MindeeApiV2

    Mindee API handler.

    • Load an input source from a base64 encoded string.

      Parameters

      • inputString: string

        input content, as a string.

      • filename: string

        file name.

      Returns Base64Input

    • Load an input source from a Buffer.

      Parameters

      • buffer: Buffer

        input content, as a buffer.

      • filename: string

        file name.

      Returns BufferInput

    • Load an input source from bytes.

      Parameters

      • inputBytes: Uint8Array

        input content, as a Uint8Array or Buffer.

      • filename: string

        file name.

      Returns BytesInput

    • Load an input source from a stream.Readable object.

      Parameters

      • inputStream: Readable

        input content, as a readable stream.

      • filename: string

        file name.

      Returns StreamInput

    Synchronous