Skip to content

Commit eee4701

Browse files
committed
docs: link SECURITY.md and stop claiming live eval gating
Public CI writes a mock faithfulness report without LANGCHAIN_API_KEY. Point recruiters at the threat model and the honest eval path.
1 parent f3aced0 commit eee4701

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ AEGIS takes a natural language operational request — _"Why is checkout latency
1111
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)]()
1212
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)]()
1313
[![LangChain](https://img.shields.io/badge/LangChain-0.3-orange)]()
14+
[![Security](https://img.shields.io/badge/Security-threat%20model-informational)](SECURITY.md)
1415

1516
---
1617

@@ -35,6 +36,8 @@ Open [aegis-agent-api.vercel.app/ui](https://aegis-agent-api.vercel.app/ui) and
3536

3637
![Demo completed with confidence chips](docs/screenshots/03-demo-completed.png)
3738

39+
Public demo threat model: [SECURITY.md](SECURITY.md). `/invoke`, `/stream`, and HITL resume are unauthenticated by design — accepted residual risk for this portfolio deploy.
40+
3841
---
3942

4043
## Architecture
@@ -146,7 +149,9 @@ aegis/
146149
python scripts/run_evals.py
147150
```
148151

149-
Generates `evals/reports/latest.md`. CI fails if faithfulness < 0.82.
152+
Writes `evals/reports/latest.md`. Public CI has no `LANGCHAIN_API_KEY`, so that job writes a **mock** report and exits 0 — it does not measure live LangSmith faithfulness. With the key set, datasets `aegis_rag_qa`, `aegis_tool_use`, and `aegis_incident_triage` run against project `aegis-production`; the intended production threshold is faithfulness ≥ 0.82.
153+
154+
CI itself fails on ruff (real errors), mypy on tools/evals/tests, and pytest (graph compile, RAG loop, tool guards, `/health` `/ui` `/stream` smokes). `pip-audit` is informational and does not fail the job on LangChain majors.
150155

151156
## Environment Variables
152157

0 commit comments

Comments
 (0)