Requirements and scope¶
MVP scope for the Rocky documentation assistant portfolio build.
Core loop¶
User query → Intent → Router → [RAG | Tools] → Report
Intents: knowledge, setup, scripting, calculation, unknown.
Must-have (MVP)¶
| # | Requirement | Status |
|---|---|---|
| R1 | Intents incl. scripting for Rocky API | Done |
| R2 | RAG with citations (source + page) | Done |
| R3 | 3 DEM helper tools (pure Python) | Done |
| R4 | FastAPI POST /ask |
Done |
| R5 | Streamlit UI (HTTP-only, SSE streaming) | Done |
| R6 | Eval golden Q&A (Rocky-themed) | Done |
| R7 | Rocky v26r1 PDF ingest via manifest | Done |
| R8 | Private data plane (data/cae/ gitignored) |
Done |
| R9 | CI: lint, test, image build | Done |
Anti-goals¶
| Anti-goal | Rationale |
|---|---|
| Live Rocky / COM automation | No vendor API in portfolio demo |
| Committing Ansys PDFs | Copyright + license |
| ANSYS Copilot branding | Unofficial demo |
| GOST / generic FEA KB | Replaced by Rocky adapter |
Quality gates¶
pdm run lint && pdm run typecheck && pdm run test