User Guide
The Helixor Decision Runtime is the decision core of the Helixor platform. It evaluates a versioned decision pack inside your own process. You hand it a payload; it returns an action from the pack's closed set, the rules that fired, a remedied version of the payload and a receipt hash, usually in microseconds.
What the runtime does#
A decision pack describes a decision: what to extract from the input, which rules must hold, which action to take when one does not, and how to repair the payload. The runtime loads the pack once and evaluates it for every payload you pass in. Packs cover operational decisions such as eligibility, limits, routing and release.
The runtime ships with one pack built in, so every guide can run with no setup. This built-in example pack (data protection, compliance.regulatory_pii_guard.v1) inspects text for sensitive data (Social Security numbers, card numbers, health record IDs, email addresses, phone numbers and IP addresses) and decides whether the text can leave your system. The guides use it to illustrate calls that work the same for any pack.
When to use it#
- Hard rules on a hot path. Decisions that must be exact and cheap enough to run on every request.
- Gating what leaves or enters a step. Check requests, model prompts and responses, or exported records against a pack before they move on.
- Decisions you have to explain later. Every result names the rules that fired and carries a receipt hash you can log.
Use the hosted Helixor reasoning API instead when the decision needs evidence you do not have locally, multi-step reasoning, or a calibrated probability of being correct.
How this guide is organized#
Core concepts
Packs, codons, rules, actions, remedies, receipts and licenses.
SetupInstallation
Requirements, install options and how to verify.
UseEvaluating decisions
The evaluate() call, its result, and how to act on it.
Streaming
Decide on text while it is still arriving, and repair or halt the stream.
UseServing decisions
REST, SSE and WebSocket for callers in other languages.
OperateLicensing and tiers
What each tier unlocks and how licenses are verified.
Status of this release#
This documentation describes runtime version 0.2.1. Features that are designed but not yet shipped are marked Planned wherever they come up, so you can tell what works today from what is coming. 0.2.1 fixes most of the defects documented for 0.2.0; the ones that remain are stated as "Known issue in 0.2.1" where they apply, and collected in Troubleshooting. Most of those are fixed in the runtime's source but not yet in a release; each such callout says "Fixed in the next release" and what changes, and keeps the 0.2.1 workaround.
| Capability | Status |
|---|---|
| In-process evaluation, streaming, batch, HTTP/SSE/WebSocket service | Available |
Loading your own compiled packs in process (HelixorEngine.load_pack) | Available |
| Bearer-token authentication and loopback-by-default binding for the service | Available |
Signed licenses (.hxlic, Ed25519) and encrypted packs (.hxpack, AES-256-GCM) | Available |
| Python package on the public index | Planned |
| Compiled native runtime library behind the Python, Java and TypeScript SDKs | Planned |
| Signed packs, keyed and chained (Merkle) receipts | Planned |