API Reference

This section documents every public module in PROTEA at the symbol level. It is generated from source docstrings via Sphinx autodoc and is always in sync with the installed codebase.

The reference is organised into six pages:

Core

The domain layer: the Operation protocol and OperationRegistry, shared HTTP utilities, KNN search backends, feature engineering, scoring, metrics, evaluation, re-ranker, and all registered operations.

Infrastructure

The persistence and messaging layer: SQLAlchemy ORM models (including evaluation sets, scoring configs, and support entries), session management, logging, RabbitMQ publisher and consumer, and the configuration loader.

HTTP API

The HTTP API: FastAPI application factory, all routers, middleware, authentication helpers, and a complete endpoint summary table.

Workers

The execution layer: BaseWorker (two-session job lifecycle), StaleJobReaper, graceful shutdown, worker entry points, and the QueueConsumer / OperationConsumer distinction.

Services

The services layer: business-logic modules that routers delegate to, plus their internal helper submodules.

Configuration

The configuration subpackage: tuning parameters and benchmark YAML loader.