Dirk Riemann
842c4da90c
First deploy done 2026-04-18. E2E extraction of the bank_statement_header use case completes in 35 s against the live service, with 7 of 9 header fields provenance-verified + text-agreement-green. closing_balance asserts from spec §12 all pass. Updates: - README.md: status -> "MVP deployed"; worked example curl snippet; pointers to deployment runbook + spec + plan. - AGENTS.md: status line updated with the live URL + date. - pyproject.toml: version comment referencing the first deploy. - docs/deployment.md: "First deploy" section filled in with times, field-level extraction result, plus a log of every small Docker/ops follow-up PR that had to land to make the first deploy healthy. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# InfoXtractor (ix)
|
|
|
|
Async, on-prem, LLM-powered structured information extraction microservice.
|
|
|
|
Given a document (PDF, image, text) and a named *use case*, ix returns a structured JSON result whose shape matches the use-case schema — together with per-field provenance (OCR segment IDs, bounding boxes, cross-OCR agreement flags) that let the caller decide how much to trust each extracted value.
|
|
|
|
**Status:** MVP deployed. Live on the home LAN at `http://192.168.68.42:8994`.
|
|
|
|
- Full reference spec: [`docs/spec-core-pipeline.md`](docs/spec-core-pipeline.md) (aspirational; MVP is a strict subset)
|
|
- **MVP design:** [`docs/superpowers/specs/2026-04-18-ix-mvp-design.md`](docs/superpowers/specs/2026-04-18-ix-mvp-design.md)
|
|
- **Implementation plan:** [`docs/superpowers/plans/2026-04-18-ix-mvp-implementation.md`](docs/superpowers/plans/2026-04-18-ix-mvp-implementation.md)
|
|
- **Deployment runbook:** [`docs/deployment.md`](docs/deployment.md)
|
|
- Agent / development notes: [`AGENTS.md`](AGENTS.md)
|
|
|
|
## Principles
|
|
|
|
- **On-prem always.** LLM = Ollama, OCR = local engines (Surya first). No OpenAI / Anthropic / Azure / AWS / cloud.
|
|
- **Grounded extraction, not DB truth.** ix returns best-effort fields + provenance; the caller decides what to trust.
|
|
- **Transport-agnostic pipeline core.** REST + Postgres-queue adapters in parallel on one job store.
|
|
|
|
## Submitting a job
|
|
|
|
```bash
|
|
curl -X POST http://192.168.68.42:8994/jobs \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"use_case": "bank_statement_header",
|
|
"ix_client_id": "mammon",
|
|
"request_id": "some-correlation-id",
|
|
"context": {
|
|
"files": [{
|
|
"url": "http://paperless.local/api/documents/42/download/",
|
|
"headers": {"Authorization": "Token …"}
|
|
}],
|
|
"texts": ["<Paperless Tesseract OCR content>"]
|
|
}
|
|
}'
|
|
# → {"job_id":"…","ix_id":"…","status":"pending"}
|
|
```
|
|
|
|
Poll `GET /jobs/{job_id}` until `status` is `done` or `error`. Optionally pass `callback_url` to receive a webhook on completion (one-shot, no retry; polling stays authoritative).
|
|
|
|
Full REST surface + provenance response shape documented in the MVP design spec.
|
|
|
|
## Running locally
|
|
|
|
```bash
|
|
uv sync --extra dev
|
|
uv run pytest tests/unit -v # hermetic unit + integration suite
|
|
IX_TEST_OLLAMA=1 uv run pytest tests/live -v # needs LAN access to Ollama + GPU
|
|
```
|
|
|
|
## Deploying
|
|
|
|
```bash
|
|
git push server main # rebuilds Docker image, restarts container, /healthz deploy gate
|
|
python scripts/e2e_smoke.py # E2E acceptance against the live service
|
|
```
|
|
|
|
See [`docs/deployment.md`](docs/deployment.md) for full runbook + rollback.
|