Skip to content

Commit 0ebaa1f

Browse files
Copilotpamelafox
andcommitted
Address PR feedback: fix Mermaid syntax, update architecture docs
Co-authored-by: pamelafox <[email protected]>
1 parent 481c539 commit 0ebaa1f

File tree

2 files changed

+9
-20
lines changed

2 files changed

+9
-20
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,6 @@ The repo includes sample data so it's ready to try end to end. In this sample ap
7070

7171
![RAG Architecture](docs/images/appcomponents.png)
7272

73-
📋 **[View detailed architecture documentation with interactive Mermaid diagrams](docs/architecture.md)**
74-
7573
## Azure account requirements
7674

7775
**IMPORTANT:** In order to deploy and run this example, you'll need:
@@ -264,6 +262,7 @@ You can find extensive documentation in the [docs](docs/README.md) folder:
264262
- [Sharing deployment environments](docs/sharing_environments.md)
265263
- [Local development](docs/localdev.md)
266264
- [Customizing the app](docs/customization.md)
265+
- **[Architecture documentation with interactive diagrams](docs/architecture.md)**
267266
- [HTTP Protocol](docs/http_protocol.md)
268267
- [Data ingestion](docs/data_ingestion.md)
269268
- [Evaluation](docs/evaluation.md)

docs/architecture.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# Application Architecture
1+
# RAG Chat: Application Architecture
22

3-
This document provides a detailed architectural overview of the Azure Search OpenAI demo application using Mermaid diagrams.
3+
This document provides a detailed architectural overview of the Azure Search OpenAI demo application. The Azure Search OpenAI demo is a Retrieval Augmented Generation (RAG) application that creates a ChatGPT-like experience over your own documents. It combines Azure OpenAI Service for AI capabilities with Azure AI Search for document indexing and retrieval.
44

5-
## Overview
6-
7-
The Azure Search OpenAI demo is a Retrieval Augmented Generation (RAG) application that creates a ChatGPT-like experience over your own documents. It combines Azure OpenAI Service for AI capabilities with Azure AI Search for document indexing and retrieval.
5+
For getting started with the application, see the main [README](../README.md).
86

97
## Architecture Diagram
108

@@ -28,7 +26,6 @@ graph TB
2826
subgraph "Approaches"
2927
CRR[ChatReadRetrieveRead<br/>Approach]
3028
RTR[RetrieveThenRead<br/>Approach]
31-
Vision[Vision Approaches<br/>GPT-4V Support]
3229
end
3330
end
3431
end
@@ -38,7 +35,7 @@ graph TB
3835
OpenAI[🤖 Azure OpenAI<br/>- GPT-4 Mini<br/>- Text Embeddings<br/>- GPT-4V (optional)]
3936
Search[🔍 Azure AI Search<br/>- Vector Search<br/>- Semantic Ranking<br/>- Full-text Search]
4037
DocIntel[📄 Azure Document<br/>Intelligence<br/>- Text Extraction<br/>- Layout Analysis]
41-
Vision2[👁️ Azure Computer Vision<br/>(optional)]
38+
Vision2[👁️ Azure AI Vision<br/>(optional)]
4239
Speech[🎤 Azure Speech<br/>Services (optional)]
4340
end
4441
@@ -66,7 +63,6 @@ graph TB
6663
%% Backend Processing
6764
API --> CRR
6865
API --> RTR
69-
API --> Vision
7066
7167
%% Azure Service Connections
7268
API <--> OpenAI
@@ -81,10 +77,6 @@ graph TB
8177
PrepDocs --> OpenAI
8278
PrepDocs --> Search
8379
84-
%% Vision Processing
85-
Vision --> Vision2
86-
Vision --> OpenAI
87-
8880
%% Platform Integration
8981
ContainerApps --> API
9082
API --> AppInsights
@@ -99,7 +91,7 @@ graph TB
9991
classDef processing fill:#f1f8e9
10092
10193
class User,Browser userLayer
102-
class React,API,CRR,RTR,Vision appLayer
94+
class React,API,CRR,RTR appLayer
10395
class OpenAI,Search,DocIntel,Vision2,Speech azureAI
10496
class Blob,Cosmos azureStorage
10597
class ContainerApps,AppInsights,KeyVault azurePlatform
@@ -165,24 +157,22 @@ sequenceDiagram
165157

166158
### Backend (Python)
167159

168-
- **API Layer**: RESTful endpoints for chat, search, and configuration
160+
- **API Layer**: RESTful endpoints for chat, search, and configuration. See [HTTP Protocol](http_protocol.md) for detailed API documentation.
169161
- **Approach Patterns**: Different strategies for processing queries
170162
- `ChatReadRetrieveRead`: Multi-turn conversation with retrieval
171163
- `RetrieveThenRead`: Single-turn Q&A with retrieval
172-
- `Vision Approaches`: Support for image-based documents
173164
- **Authentication**: Optional integration with Azure Active Directory
174165

175166
### Azure Services Integration
176167

177168
- **Azure OpenAI**: Powers the conversational AI capabilities
178169
- **Azure AI Search**: Provides semantic and vector search over documents
179170
- **Azure Blob Storage**: Stores original documents and processed content
180-
- **Azure Container Apps**: Hosts the application with automatic scaling
181171
- **Application Insights**: Provides monitoring and telemetry
182172

183173
## Optional Features
184174

185-
The architecture supports several optional features that can be enabled:
175+
The architecture supports several optional features that can be enabled. For detailed configuration instructions, see the [optional features guide](deploy_features.md):
186176

187177
- **GPT-4 with Vision**: Process image-heavy documents
188178
- **Speech Services**: Voice input/output capabilities
@@ -195,6 +185,6 @@ The architecture supports several optional features that can be enabled:
195185
The application can be deployed using:
196186

197187
- **Azure Container Apps** (default): Serverless container hosting
198-
- **Azure App Service**: Traditional PaaS hosting option
188+
- **Azure App Service**: Traditional PaaS hosting option. See the [App Service hosting guide](appservice.md) for detailed instructions.
199189

200190
Both options support the same feature set and can be configured through the Azure Developer CLI (azd).

0 commit comments

Comments
 (0)