This directory contains a collection of Jupyter notebooks that demonstrate various aspects of working with Kodexa. Each notebook provides practical examples and step-by-step guidance for different Kodexa operations.
A basic introduction to working with Kodexa Documents. This notebook demonstrates:
- Loading a Kodexa Document from a KDDB file
- Accessing and navigating document pages
- Displaying document content in a readable format
- Basic document operations and exploration
Learn how to upload documents to a Kodexa store. This notebook covers:
- Setting up your Kodexa environment
- Connecting to a Kodexa instance
- Finding your store reference
- Uploading documents to a document store
Explore how to work with data objects associated with processed documents. This notebook demonstrates:
- Accessing document and data stores
- Looking up documents in the document store
- Retrieving associated data objects
- Working with document families
Before running these notebooks, make sure you have:
- A Kodexa account and API access
- The Kodexa Python client installed
- Proper environment configuration (see https://developer.kodexa.ai/getting-started)
The notebooks reference some example files:
bank-statement.kddb: A sample Kodexa document for demonstrationbank-statement.pdf: Source PDF file for examplesstore-properties.png: Reference image showing where to find store properties
Each notebook contains detailed comments and explanations to help you understand the concepts and code examples.