Getting started with Kodexa using the Inference Model Cookie Cutter
cookie-cutter-kodexa-infer-model
is a project template that helps you quickly set up a new Kodexa inference model project with the right structure and dependencies. This template creates a model that can be deployed to a Kodexa platform for document processing and data extraction.
This documentation will guide you through:
model.py
model.yml
pyproject.toml
makefile
make format
: Format code using isort and blackmake lint
: Lint code using flake8 and mypymake test
: Run formatting, linting, and unit testsmake deploy
: Deploy the model to Kodexa platformmake undeploy
: Undeploy the model from Kodexa platformpkg_name/model.py
. The main entry point is the infer
function:
document
: The Kodexa Document to processproject
: The Kodexa project endpointpipeline_context
: Context information about the current pipelineassistant
: The Kodexa assistant for interaction with large language modelspoetry shell
)poetry install
)