Parsing Invoices

Invoice Parsing Demo

vlm-1 extracts structured data from invoice PDFs and images. The response includes visual grounding. Only schema-requested values are retrieved and visualized. OCR returns all text in the document, with no context.

Parsing an invoice with visual grounding enabled

Enable Visual Grounding for higher-quality extraction. See High-Accuracy Parsing with Grounding.

Parsing Invoices in 2 Steps

Submit an Invoice Parsing Job

from pathlib import Path
from vlmrun.client import VLMRun
from vlmrun.client.types import FileResponse

# Initialize the client
client = VLMRun(api_key="<your-api-key>")

# Submit the invoice for parsing
response: PredictionResponse = client.document.generate(
    file=Path("<path/to/invoice.pdf>"),
    domain="document.invoice",
    batch=True,
)
print(f"Job submitted:\n {response.model_dump()}")

import { VlmRun } from "vlmrun";

// Initialize the client
const client = new VlmRun({
  apiKey: "<your-api-key>",
});

// Submit the invoice for parsing
const response = await client.document.generate({
  file: "<path/to/invoice.pdf>",
  domain: "document.invoice",
  batch: true,
});

// Wait for the job to complete
const job = await client.predictions.wait(response.id);
console.log(job);

Job submitted:
{
  "id": "052cf2a8-2b84-45f5-a385-ccac2aae13bb",
  "created_at": "2024-08-15T02:22:09.157788",
  "response": null,
  "status": "pending"
}

Wait for the Job to Complete

# Wait for the job to complete
response: PredictionResponse = client.predictions.wait(
    id=response.id,
    timeout=120,
)
print(f"Job completed:\n {response.model_dump()}")

// Wait for the job to complete
const job = await client.predictions.wait(response.id);
console.log(job);

{
    "id": "052cf2a8-2b84-45f5-a385-ccac2aae13bb",
    "created_at": "2024-08-15T02:22:09.157788",
    "status": "completed",
    "response": {
    "currency": "USD",
    "currency_metadata": {
      "bboxes": [
        {
          "content": "$19,647.68",
          "bbox": {
            "xywh": [0.843, 0.611, 0.084, 0.014]
          },
          "page": 0
        }
      ]
    },
    "customer": "Jane Smith",
    "customer_billing_address": {
      "city": "Mountain View",
      "city_metadata": {
        "bboxes": [
          {
            "content": "Mountain View, CA 94043",
            "bbox": {
              "xywh": [0.080, 0.194, 0.190, 0.014]
            },
            "page": 0
          }
        ]
      },
      "country": null,
      "country_metadata": null,
      "postal_code": "94043",
      "postal_code_metadata": {
        "bboxes": [
          {
            "content": "Mountain View, CA 94043",
            "bbox": {
              "xywh": [0.080, 0.194, 0.190, 0.014]
            },
            "page": 0
          }
        ]
      },
    }
    ...
    "items": [...],   // List of items in the invoice
    ...
    "total": 19647.68,
    "total_metadata": {
      "bboxes": [
        {
          "content": "$19,647.68",
          "bbox": {
            "xywh": [...]
          },
          "page": 0
        }
      ]
    }
  }
}

High-Accuracy Parsing with Grounding

Set config=GenerationConfig(grounding=True) to enable Visual Grounding.

from vlmrun.client.types import GenerationConfig

# Enable grounding when submitting the job
response: PredictionResponse = client.document.generate(
    file=Path("<path/to/invoice.pdf>"),
    domain="document.invoice",
    batch=True,
    config=GenerationConfig(grounding=True),
)

// Enable grounding when submitting the job
const response = await client.document.generate({
  file: "<path/to/invoice.pdf>",
  domain: "document.invoice",
  batch: true,
  config: { grounding: true },
});

Try our Document -> JSON API today

Open Document -> JSON on VLM Run. Sign up on the platform.

Gateway

Documents

Images

Video and audio

Parsing Invoices

Invoice Parsing Demo

Parsing Invoices in 2 Steps

High-Accuracy Parsing with Grounding

Try our Document -> JSON API today

Invoice Parsing Demo

​Parsing Invoices in 2 Steps

​High-Accuracy Parsing with Grounding

​Try our Document -> JSON API today

Parsing Invoices in 2 Steps

High-Accuracy Parsing with Grounding

Try our Document -> JSON API today