You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/architecture.md
+8-18Lines changed: 8 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
-
# Application Architecture
1
+
# RAG Chat: Application Architecture
2
2
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.
4
4
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).
8
6
9
7
## Architecture Diagram
10
8
@@ -28,7 +26,6 @@ graph TB
28
26
subgraph "Approaches"
29
27
CRR[ChatReadRetrieveRead<br/>Approach]
30
28
RTR[RetrieveThenRead<br/>Approach]
31
-
Vision[Vision Approaches<br/>GPT-4V Support]
32
29
end
33
30
end
34
31
end
@@ -38,7 +35,7 @@ graph TB
38
35
OpenAI[🤖 Azure OpenAI<br/>- GPT-4 Mini<br/>- Text Embeddings<br/>- GPT-4V (optional)]
39
36
Search[🔍 Azure AI Search<br/>- Vector Search<br/>- Semantic Ranking<br/>- Full-text Search]
40
37
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)]
42
39
Speech[🎤 Azure Speech<br/>Services (optional)]
43
40
end
44
41
@@ -66,7 +63,6 @@ graph TB
66
63
%% Backend Processing
67
64
API --> CRR
68
65
API --> RTR
69
-
API --> Vision
70
66
71
67
%% Azure Service Connections
72
68
API <--> OpenAI
@@ -81,10 +77,6 @@ graph TB
81
77
PrepDocs --> OpenAI
82
78
PrepDocs --> Search
83
79
84
-
%% Vision Processing
85
-
Vision --> Vision2
86
-
Vision --> OpenAI
87
-
88
80
%% Platform Integration
89
81
ContainerApps --> API
90
82
API --> AppInsights
@@ -99,7 +91,7 @@ graph TB
99
91
classDef processing fill:#f1f8e9
100
92
101
93
class User,Browser userLayer
102
-
class React,API,CRR,RTR,Vision appLayer
94
+
class React,API,CRR,RTR appLayer
103
95
class OpenAI,Search,DocIntel,Vision2,Speech azureAI
104
96
class Blob,Cosmos azureStorage
105
97
class ContainerApps,AppInsights,KeyVault azurePlatform
@@ -165,24 +157,22 @@ sequenceDiagram
165
157
166
158
### Backend (Python)
167
159
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.
169
161
-**Approach Patterns**: Different strategies for processing queries
170
162
-`ChatReadRetrieveRead`: Multi-turn conversation with retrieval
171
163
-`RetrieveThenRead`: Single-turn Q&A with retrieval
172
-
-`Vision Approaches`: Support for image-based documents
173
164
-**Authentication**: Optional integration with Azure Active Directory
174
165
175
166
### Azure Services Integration
176
167
177
168
-**Azure OpenAI**: Powers the conversational AI capabilities
178
169
-**Azure AI Search**: Provides semantic and vector search over documents
179
170
-**Azure Blob Storage**: Stores original documents and processed content
180
-
-**Azure Container Apps**: Hosts the application with automatic scaling
181
171
-**Application Insights**: Provides monitoring and telemetry
182
172
183
173
## Optional Features
184
174
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):
186
176
187
177
-**GPT-4 with Vision**: Process image-heavy documents
0 commit comments