Skip to main content

Document Processing API

Install package​

Installing the package

npm install @nestbox-ai/doc-processing-api --save

Usage Example​

This client can be used from both TypeScript and JavaScript. Below is a minimal end-to-end example using the generated API clients.

1. Setup​

import {
  Configuration,
  ProfilesApi,
  DocumentsApi,
  EvalsApi,
  QueriesApi,
  WebhooksApi,
} from '@nestbox-ai/doc-processing-api';

const config = new Configuration({
  basePath: 'http://localhost',
});

const profilesApi = new ProfilesApi(config);
const documentsApi = new DocumentsApi(config);
const evalsApi = new EvalsApi(config);
const queriesApi = new QueriesApi(config);
const webhooksApi = new WebhooksApi(config);

2. Create a Profile (from YAML)​

const profileYaml = `
name: invoice-profile
description: Extract fields from invoices
fields:
  - name: invoice_number
    type: string
  - name: total_amount
    type: number
`;

const profile = await profilesApi.profilesControllerCreateProfile({
  yaml: profileYaml,
});

console.log('Profile created:', profile.data.id);

3. Process a Document​

const documentResponse =
  await documentsApi.documentsControllerCreateDocument({
    profileId: profile.data.id,
    file: /* File | Buffer | Stream */,
  });

const documentId = documentResponse.data.documentId;
console.log('Document ID:', documentId);

You can later fetch the processed document:

const document =
  await documentsApi.documentsControllerGetDocument(documentId);

console.log('Document status:', document.data.status);

4. Run Evals (from YAML)​

const evalYaml = `
name: accuracy-check
assertions:
  - field: total_amount
    operator: exists
`;

const evalResponse =
  await evalsApi.evalsControllerCreateEval(
    documentId,
    { yaml: evalYaml }
  );

console.log('Eval created:', evalResponse.data.evalId);

5. Run Queries (Batch Query from YAML)​

const queryYaml = `
name: invoice-query
filters:
  - field: total_amount
    operator: gt
    value: 1000
`;

const queryResponse =
  await queriesApi.queriesControllerCreateQuery({
    yaml: queryYaml,
  });

console.log('Query created:', queryResponse.data.queryId);

6. Manage Webhooks​

Create a Webhook​

const webhookData = {
  url: 'https://your-app.com/webhooks/document-processed',
  events: ['document.processed', 'document.failed'],
  description: 'Webhook for document processing notifications',
};

const webhook = await webhooksApi.webhooksControllerCreateWebhook(webhookData);
console.log('Webhook created:', webhook.data.id);

List All Webhooks​

const webhooks = await webhooksApi.webhooksControllerListWebhooks();
console.log('All webhooks:', webhooks.data);

Get a Specific Webhook​

const webhookId = webhook.data.id;
const retrievedWebhook = await webhooksApi.webhooksControllerGetWebhook(webhookId);
console.log('Webhook details:', retrievedWebhook.data);

Update a Webhook​

const updateData = {
  url: 'https://your-app.com/webhooks/updated-endpoint',
  events: ['document.processed', 'document.failed', 'eval.completed'],
  description: 'Updated webhook with additional events',
};

const updatedWebhook = await webhooksApi.webhooksControllerUpdateWebhook(
  webhookId,
  updateData
);
console.log('Webhook updated:', updatedWebhook.data);

Delete a Webhook​

await webhooksApi.webhooksControllerDeleteWebhook(webhookId);
console.log('Webhook deleted successfully');