❤
npm
Sign UpSign In

@abbyy-sdk/document-ai
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

@abbyy-sdk/document-ai

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @abbyy-sdk/document-ai API.

Summary

Document AI API: A modern, simple, and easy-to-integrate OCR and document processing API service

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @abbyy-sdk/document-ai

PNPM

pnpm add @abbyy-sdk/document-ai

Bun

bun add @abbyy-sdk/document-ai

Yarn

yarn add @abbyy-sdk/document-ai zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
apiKeyAuth http HTTP Bearer DOCUMENTAI_API_KEY_AUTH

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Available Resources and Operations

Available methods

documents

models

models.airWaybill

models.arrivalNotice

models.bankStatement

models.basicContract

models.billOfLading

models.brokerageStatement

models.certificateOfOrigin

models.commercialInvoice

models.customsDeclaration

models.dangerousGoodsDeclaration

models.deliveryNote

models.documentConversion

models.hotelInvoice

models.imageToText

models.internationalConsignmentNote

models.invoice

models.packingList

models.personalEarningsStatement

models.purchaseOrder

models.receipt

models.remittanceAdvice

models.seaWaybill

models.taxiReceipt

models.usForm1040

models.usFormW2

models.utilityBill

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the list method may throw the following errors:

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.UnauthorizedError 401 application/json
errors.TooManyRequestsError 429 application/json
errors.InternalServerError 500 application/json
errors.APIError 4XX, 5XX */*

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { DocumentAi } from "@abbyy-sdk/document-ai";
import {
  BadRequestError,
  InternalServerError,
  SDKValidationError,
  TooManyRequestsError,
  UnauthorizedError,
} from "@abbyy-sdk/document-ai/models/errors";

const documentAi = new DocumentAi({
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  let result;
  try {
    result = await documentAi.documents.list({
      cursor: "xyz",
    });

    for await (const page of result) {
      // Handle the page
      console.log(page);
    }
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof BadRequestError): {
        // Handle err.data$: BadRequestErrorData
        console.error(err);
        return;
      }
      case (err instanceof UnauthorizedError): {
        // Handle err.data$: UnauthorizedErrorData
        console.error(err);
        return;
      }
      case (err instanceof TooManyRequestsError): {
        // Handle err.data$: TooManyRequestsErrorData
        console.error(err);
        return;
      }
      case (err instanceof InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised or unexpected error

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { DocumentAi } from "@abbyy-sdk/document-ai";

const documentAi = new DocumentAi({
  serverURL: "https://api.abbyy.com/document-ai",
  apiKeyAuth: process.env["DOCUMENTAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await documentAi.documents.list({
    cursor: "xyz",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { DocumentAi } from "@abbyy-sdk/document-ai";
import { HTTPClient } from "@abbyy-sdk/document-ai/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new DocumentAi({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { DocumentAi } from "@abbyy-sdk/document-ai";

const sdk = new DocumentAi({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable DOCUMENTAI_DEBUG to true.

Readme

Keywords

none

Package Sidebar

Install

npm i @abbyy-sdk/document-ai

Repository

github.com/abbyyProduct/document-ai-sdk-typescript

Homepage

github.com/abbyyProduct/document-ai-sdk-typescript#readme

Weekly Downloads

34

Version

0.1.4

License

none

Unpacked Size

10.6 MB

Total Files

2460

Last publish

Collaborators

  • larsmikkelsen
  • jaredhagen-abbyy
Try on RunKit
Report malware