4747| ` frai rag index ` | Index compliance docs into a local vector store |
4848| ` frai eval ` | Run baseline evaluation metrics and write reports |
4949
50+ ### RAG Indexing
51+
52+ ``` bash
53+ frai rag index --input docs/policies --output .frai/compliance-index.json --chunk-size 400
54+ ```
55+ - Scans ` .md ` , ` .txt ` , ` .json ` , ` .yaml ` files recursively.
56+ - Generates a lightweight JSON vector store consumable by SDKs and future connectors.
57+
58+ ### Evaluation Harness
59+
60+ ``` bash
61+ frai eval --outputs runs/outputs.json --references runs/golden.json --report reports/eval --format markdown
62+ ```
63+ - Runs baseline metrics (exact match, toxicity keyword scan, length variance).
64+ - Produces JSON and/or Markdown summaries for CI and governance reviews.
65+
5066** Docs generated:**
5167- ` checklist.md ` — Implementation checklist
5268- ` model_card.md ` — Model card
6177- ** PDF export** : Convert docs to PDF with one command
6278- ** Codebase scanning** : Detects AI/ML code and generates relevant docs
6379- ** Easy setup** : One-time API key configuration
80+ - ** Compliance-aware RAG** : Build vector stores from policies for knowledge-grounded guardrails
81+ - ** Evaluation harness** : Run baseline metrics and capture auditable reports
82+
83+ ### Monorepo Layout
84+
85+ ```
86+ frai/
87+ ├─ packages/
88+ │ ├─ frai-cli/ # CLI entry point and command wiring
89+ │ └─ frai-core/ # Reusable services (config, questionnaire, documents, scanners, RAG, eval)
90+ ├─ docs/ # Roadmaps, design notes, and feature backlogs
91+ └─ examples/ # Sample AI projects used in tests and demos
92+ ```
6493
6594---
6695
@@ -76,6 +105,8 @@ If you skip this step, FRAI will prompt you to set up your key on first use.
76105## 📖 Learn More
77106- [ GitHub Repository] ( https://github.com/sebastianbuzdugan/frai )
78107- [ NPM Package] ( https://www.npmjs.com/package/frai )
108+ - [ AI Feature Backlog] ( docs/ai_feature_backlog.md )
109+ - [ Evaluation Harness Design] ( docs/eval_harness_design.md )
79110
80111---
81112
0 commit comments