Generation may proceed
Includes evidence IDs, bounded packet, unknowns, token statistics, relation status, and an audit trace.
Developer docs
One decision contract. Any retrieval stack.
Local runtime
Install, initialize, ingest, query.
The local Python runtime is the current reference implementation. Use synthetic or sanitized data until your security and retention boundary is approved.
python -m venv .venv
source .venv/bin/activate
pip install pail-cognitive-middleware
pail init
pail doctor
pail ingest ./sample-data --section demo
pail query "transaction_id=TXN-25 status cause" \
--section demo --explainBranch on status, not prose.
Applications should make decisions from explicit fields and treat natural-language answers as optional rendering.
Generation must stop
Includes conflicting fields and values. The application may ask for review or additional evidence.
Answer from model memory is forbidden
Includes an explicit empty-evidence contract and the reason the query could not be supported.
Integration pattern
Retriever → PAIL → renderer.
PAIL can receive externally retrieved documents or manage local ingestion. The guard must remain on every path, including bring-your-own-retriever adapters.
Runnable middleware
Wrap retriever output, return a typed decision, and call the model only for verified packets.
Exact candidate source
Pass rows with provenance and preserve original identifiers and timestamps.
Managed ingestion
Use file-aware parsers and source-specific record boundaries.
Generation gate
Require a verified packet before an answer or downstream action can proceed.
Security boundary
Public contract. Protected core.
The public repository demonstrates API shapes, evaluator behavior, and safe synthetic fixtures. Proprietary grammar, relation internals, acoustic fingerprints, private evidence, secrets, and customer adapters stay out.
| Surface | Public | Protected |
|---|---|---|
| Website evaluator | Bounded synthetic JSON behavior | No private runtime or customer evidence |
| API contract | Status, evidence, token, and audit schemas | Rule implementation and ranking policy |
| File upload | Browser form and forwarding boundary | Authenticated tenant runtime and storage |
| LLM call | Grounded prompt contract | Model credentials and customer packet |
| Research | Methods and honest results | Unpublished rule catalog and private datasets |
Start safely
Choose the surface that matches your evaluation.
Public downloads do not contain the protected core.
Evaluation kit
Clients, schemas, fixtures, and smoke assertions for the earlier public evaluator contract. Use the live OpenAPI document for the current 2.0 trial contract.
Download ZIP →Private local runtime
Full ingestion and guarded query evaluation after scope, retention, and access are agreed.
Request evaluation →Build the smallest proof
Integrate one retriever and one failure case first.
Measure wrong joins, answer coverage, conflict recall, latency, and exact prompt tokens before expanding.