Quickstart

Get started with ADX in five minutes.

Install

pip install adx

For LLM-powered extraction (optional):

pip install adx[llm]

Upload a Document

from adx import ADX

dn = ADX()
doc_id = dn.upload("invoice.pdf")
print(f"Document ID: {doc_id}")

Profile It

profile = dn.profile(doc_id)
print(profile)

{
  "file_name": "invoice.pdf",
  "file_type": "pdf",
  "page_count": 3,
  "document_type": "invoice",
  "has_tables": true,
  "table_count": 2,
  "confidence": {"overall": 0.92},
  "recommended_tools": ["get_table", "search_document"]
}

Explore the Structure

structure = dn.structure(doc_id)
for section in structure["sections"]:
    print(f"  {section['title']} (page {section['start_page']})")
for table in structure["tables"]:
    print(f"  Table: {table['id']} — {table['row_count']}x{table['col_count']}")

Search

results = dn.search(doc_id, query="total")
for hit in results["matches"]:
    print(f"  Page {hit['page']}: {hit['snippet']}")

Extract Fields

extraction = dn.extract(doc_id, schema="invoice")
for field in extraction["fields"]:
    print(f"  {field['name']}: {field['value']} (confidence: {field['confidence']})")

Built-in schemas: invoice, contract, financial_model, table.

Validate

result = dn.validate(doc_id, extraction["id"])
for check in result["checks"]:
    print(f"  [{check['severity']}] {check['rule']}: {check['message']}")

Validation checks include:

• Required fields present
• Type correctness
• Arithmetic verification (e.g., subtotal + tax = total)
• Citation provenance

Export

# Export as markdown
md = dn.export(doc_id, format="markdown")

# Export as JSON
data = dn.export(doc_id, format="json")

# Export as CSV (tables only)
csv_data = dn.export(doc_id, format="csv")

REST API

Start the server and use HTTP endpoints:

adx serve

# Upload
curl -X POST http://localhost:8000/v1/files -F "file=@invoice.pdf"

# Profile
curl http://localhost:8000/v1/files/{id}/profile

# Extract
curl -X POST http://localhost:8000/v1/files/{id}/extract \
  -H "Content-Type: application/json" \
  -d '{"schema": "invoice"}'

CLI

adx upload invoice.pdf
adx profile <id>
adx search <id> --query "total amount"
adx extract <id> --schema invoice
adx validate <id> --extraction <eid>

Next Steps

• Agent Tools — full reference for all nine tools
• PDF Guide — PDF-specific features
• Excel Guide — spreadsheet navigation
• Examples — real-world extraction workflows