External Data with kdx CLI

kdx document external list <file.kddb>

kdx document external list invoice.kddb

┌─────────────────┐
│       KEY       │
├─────────────────┤
│ ocr_results     │
│ extraction_config│
│ processing_status│
└─────────────────┘

No external data keys found

kdx document external get <file.kddb> <key>

kdx document external get invoice.kddb processing_status

┌───────────────┬─────────────────────────────────────┐
│     FIELD     │                VALUE                │
├───────────────┼─────────────────────────────────────┤
│ status        │ completed                           │
│ processed_at  │ 2024-01-15T10:30:00Z                │
│ pages_processed│ 5                                  │
└───────────────┴─────────────────────────────────────┘

kdx document external set <file.kddb> <key> <json-value>

# Set a string value
kdx document external set invoice.kddb status '"processed"'

# Set a number
kdx document external set invoice.kddb confidence '0.95'

# Set a boolean
kdx document external set invoice.kddb reviewed 'true'

# Set an object
kdx document external set invoice.kddb processing_status '{"status": "completed", "pages": 5}'

# Set an array
kdx document external set invoice.kddb tags '["invoice", "urgent", "reviewed"]'

Set external data key: processing_status

kdx document external delete <file.kddb> <key>

kdx document external delete invoice.kddb temp_data

Deleted external data key: temp_data

# JSON output
kdx document external get invoice.kddb processing_status -o json

# YAML output
kdx document external list invoice.kddb -o yaml

{
  "status": "completed",
  "processed_at": "2024-01-15T10:30:00Z",
  "pages_processed": 5
}

# Store OCR confidence
kdx document external set invoice.kddb ocr_confidence '0.92'

# Store extraction results
kdx document external set invoice.kddb extraction '{"vendor": "Acme Corp", "total": 1234.56}'

# Mark as processed
kdx document external set invoice.kddb status '"completed"'

# Store processing metadata
kdx document external set invoice.kddb processing '{"model": "invoice-v2", "timestamp": "2024-01-15T10:30:00Z"}'

# Store extraction config
kdx document external set invoice.kddb config '{"extract_tables": true, "language": "en"}'

# Check if document was processed
STATUS=$(kdx document external get invoice.kddb status -o json 2>/dev/null)
if [ "$STATUS" = '"completed"' ]; then
  echo "Already processed"
else
  echo "Needs processing"
fi

# Copy external data between documents
VALUE=$(kdx document external get source.kddb config -o json)
kdx document external set target.kddb config "$VALUE"