Skip to content
dignite-projectsPublic

About

Channel layer that turns any content needing IDP — scans, photos, image PDFs, Office files — into trustworthy structured data (OCR + Markdown + metadata + optional field extraction), exposed via REST / EventBus / MCP. Built on ABP.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

0 watching

Forks

Latest commit

 

History

1,371 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Dignite Vault

Dignite Vault = any content requiring IDP (Intelligent Document Processing) — scans / photos / PDF images / Office files / digital-born documents → trustworthy structured data. A channel layer, not an end-product. It doesn't consume, doesn't own, doesn't dive into business — it hands Markdown + structured metadata to downstream RAG platforms, business systems, and AI clients via REST / EventBus / MCP server / Webhook (planned).

For the positioning, architecture, what the module does not contain, the event contract and the security rules for LLM call paths, see CLAUDE.md. It is the truth source — this README only stages the entry points; everything operational lives in docs/.

Data flow

content requiring IDP: scans / photos / PDF images / Office files / digital-born documents
    ↓
[Dignite Vault Extract channel]: OCR + Markdown + system metadata + type-bound field extraction
    ↓ (REST / EventBus / MCP server / Webhook — planned)
    ├─→ downstream RAG platform
    ├─→ business systems (finance / CLM / HR / ERP)
    ├─→ AI clients (Claude Desktop / Cursor / any MCP client)
    └─→ any consumer (build your own subscriber)

Solution structure

vault/
├── modules/
│   ├── vault.parse/     # Vault Parse — the text-extraction library: OCR and digital engines on Microsoft.Extensions.DocumentExtraction
│   └── vault.extract/   # Channel implementation — ABP layers (Abstractions / Domain.Shared / Domain / Application / EntityFrameworkCore / HttpApi / Mcp)
│                        # and angular/ (the @dignite/ng.vault-extract library)
├── src/                 # Host application — provider wiring (OCR + AI) and middleware (ASP.NET Core API)
├── angular/             # Host SPA (operator UI); compiles the module libraries from source
├── etc/                 # Docker, ABP Studio run profile, scripts, PaddleOCR sidecar
└── docs/                # Documentation: setup, configuration, egress contracts, deployment

Business modules (contract management / invoice management / HR records / etc.) are not in this repo — they belong on the downstream consumer side per the channel philosophy.

Use it as a module

Vault Extract is distributed as an ABP application module: the Dignite.Vault.Extract.* NuGet packages for the server and the @dignite/ng.vault-extract npm package for the Angular operator UI. This repository's host (src/Dignite.Vault.Extract.Host/) is one host built from them. To add the modules to an ABP application of your own, see Installation.

Quick start (run this repository)

Requirement Version
.NET SDK 11.0
Node.js ^22.22.3 or ^24.15.0 (Angular 22)
SQL Server 2022+ (EF Core 11 emits SQL for compatibility level 160; Vault Index needs 2025). LocalDB works for development
ABP CLI matching ABP 11.0
An LLM provider mandatory — any OpenAI-compatible endpoint; a local Ollama works
Docker Desktop optional — PaddleOCR sidecar and the local OpenTelemetry dashboard

1. Configure the LLM provider. Create src/Dignite.Vault.Extract.Host/appsettings.secrets.json. It is git-ignored and never published; do not put credentials in the committed appsettings.json or appsettings.Development.json.

{
  "Vault": {
    "Extract": {
      "Endpoint": "https://api.openai.com/v1",
      "ApiKey": "sk-...",
      "ChatModelId": "gpt-6-luna",
      "VisionOcrModelId": "gpt-6-luna",
      "ReasoningEffort": "None"
    }
  }
}

The host fails fast at startup while ApiKey is still the committed placeholder, because classification and field extraction have no non-LLM fallback. VisionOcrModelId must name a vision-capable model: the host's default OCR provider is Vision-LLM. See AI Provider.

2. Run the backend.

cd src/Dignite.Vault.Extract.Host
abp install-libs
dotnet run --migrate-database   # first run, and after pulling a new migration; seeds admin / 1q2w3E*
dotnet run

API: https://localhost:44348. Swagger: https://localhost:44348/swagger.

3. Run the Angular UI.

npm install       # once, at the repo root: one install for every Angular workspace
cd angular
npm start

SPA: http://localhost:4200. Sign in with admin / 1q2w3E*.

The full walkthrough — database connection, sidecars, proxy regeneration, tests, troubleshooting — is in Local Development.

Where to go next

Start at the documentation index.

You want to… Read
Run this repository on your machine Local Development
Add the modules to your own ABP application Installation
Define what gets extracted Document Types and Fields
Choose an OCR provider Text Extraction
Integrate a downstream system Integration Events, REST API
Connect an AI client MCP Server
Deploy to production Deployment, Deployment Checklist

Release notes, including breaking changes and their migrations, are in CHANGELOG.md.

External references:

License

Dignite Vault is licensed under the GNU Lesser General Public License v3.0.

About

Channel layer that turns any content needing IDP — scans, photos, image PDFs, Office files — into trustworthy structured data (OCR + Markdown + metadata + optional field extraction), exposed via REST / EventBus / MCP. Built on ABP.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages