Skip to content

Fix #422: Improve Architecture Documentation #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JiwaniZakir wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #422: Improve Architecture Documentation #444

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,25 @@ GPT-RAG is built on a Zero-Trust architecture to ensure that all components oper
## Architecture

![Zero Trust Architecture](media/architecture_zero_trust.png)
*Zero-Trust Architecture*
*Zero-Trust Architecture — full deployment with all optional modules enabled*

### Required vs. Optional Modules

The diagram above shows a complete deployment. In practice, many components are optional. The table below clarifies what is needed for a minimal deployment versus what can be added incrementally.

| Component | Required | Notes |
|-----------|----------|-------|
| **Azure OpenAI** | ✅ Required | Core LLM for generation |
| **Azure AI Search** | ✅ Required | Retrieval index |
| **gpt-rag-orchestrator** | ✅ Required | Query orchestration and agent logic |
| **gpt-rag-ingestion** | ✅ Required | Document chunking and indexing pipeline |
| **gpt-rag-ui** | ⬜ Optional | Reference chat UI — bring your own front-end instead |
| **Zero-Trust / AI Landing Zone** | ⬜ Optional | Recommended for production; not needed for PoC/dev |
| **Document-level security (ACL/RBAC)** | ⬜ Optional | Enable when per-user data trimming is required |
| **SharePoint / Lists connector** | ⬜ Optional | Add when SharePoint is a data source |
| **NL2SQL / MCP strategies** | ⬜ Optional | Advanced agent strategies; enable per use case |

> **Start small.** A working RAG solution requires only the four core components. Add optional modules as your requirements evolve.

## AI Agent Capabilities

Expand Down
Loading