Skip to main content

Konfuzio Software Development Kit

Project description

Konfuzio SDK

Konfuzio Downloads

The Konfuzio Software Development Kit (Konfuzio SDK) provides a Python API to interact with the Konfuzio Server.


The SDK allows you to retrieve visual and text features to build your own document models. Konfuzio Server serves as an UI to define the data structure, manage training/test data and to deploy your models as API.

Function Public Host Free* On-Site (Paid)
OCR Text ✔️ ✔️
OCR Handwriting ✔️ ✔️
Text Annotation ✔️ ✔️
PDF Annotation ✔️ ✔️
Image Annotation ✔️ ✔️ ️
Table Annotation ✔️ ✔️
Download Images ✔️ ✔️
Download PDF with OCR ✔️ ✔️
Deploy AI models ✖️ ✔️

* Under fair use policy: We will impose 10 pages/hour throttling eventually.

📒 Docs Read the docs
💾 Installation How to install the Konfuzio SDK
🎓 Tutorials See what the Konfuzio SDK can do with our tutorials
💡 Explanations Here are links to teaching material about the Konfuzio SDK.
⚙️ API Reference Python classes, methods, and functions
❤️ Contributing Learn how to contribute!
🐛 Issue Tracker Report and monitor Konfuzio SDK issues
🔭 Changelog Review the release notes
📰 MIT License Review the license


As developer register on our public HOST for free:

Then you can use pip to install Konfuzio SDK and run init:

pip install konfuzio_sdk

konfuzio_sdk init

The init will create a Token to connect to the Konfuzio Server. This will create variables KONFUZIO_USER, KONFUZIO_TOKEN and KONFUZIO_HOST in an .env file in your working directory.

By default, the SDK is installed without the AI-related dependencies like torch or transformers and allows for using only the Data-related SDK concepts but not the AI models. To install the SDK with the AI components, run the following command:

pip install konfuzio_sdk[ai]

Find the full installation guide here. To configure a PyCharm setup, follow the instructions here.


We provide the basic function to create a new Project via CLI:

konfuzio_sdk create_project YOUR_PROJECT_NAME

You will see "Project {YOUR_PROJECT_NAME} (ID {YOUR_PROJECT_ID}) was created successfully!" printed.

And download any project via the id:

konfuzio_sdk export_project YOUR_PROJECT_ID


You can find detailed examples about how to set up and run document AI pipelines in our Tutorials, including:


Here we show how to use the Konfuzio SDK to retrieve data hosted on a Konfuzio Server instance.

from import Project, Document

# Initialize the Project
my_project = Project(id_=YOUR_PROJECT_ID)

# Get any online Document
doc: Document = my_project.get_document_by_id(DOCUMENT_ID_ONLINE)

# Get the Annotations in a Document

# Filter Annotations by Label
label = my_project.get_label_by_name(MY_OWN_LABEL_NAME)

# Or get all Annotations that belong to one Category
category = my_project.get_category_by_id(YOUR_CATEGORY_ID)

# Force a Project update. To save time Documents will only be updated if they have changed.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

konfuzio_sdk-0.3.11.tar.gz (219.0 kB view hashes)

Uploaded Source

Built Distribution

konfuzio_sdk-0.3.11-py3-none-any.whl (168.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page