Skip to content

Commit c1c2886

Browse files
committed
added diagrams
1 parent 43cdd60 commit c1c2886

6 files changed

Lines changed: 19 additions & 37 deletions

File tree

assets/architecture.png

722 KB
Loading

assets/user_flow.png

1.07 MB
Loading

docs/architecture/overview.md

Lines changed: 17 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,7 @@ The AI Imaging Agent uses a **two-stage pipeline** that combines fast text retri
44

55
## System Architecture
66

7-
```mermaid
8-
graph TB
9-
subgraph "User Interface"
10-
UI[Gradio Chat Interface]
11-
end
12-
13-
subgraph "API Layer"
14-
Pipeline[RAGImagingPipeline]
15-
Validator[File Validator]
16-
MetaExtractor[Metadata Extractor]
17-
end
18-
19-
subgraph "Stage 1: Retrieval"
20-
Embedder[BGE-M3 Text Embedder]
21-
FAISS[FAISS Vector Index]
22-
Reranker[CrossEncoder Reranker]
23-
Catalog[Software Catalog JSONL]
24-
end
25-
26-
subgraph "Stage 2: Agent Selection"
27-
Agent[PydanticAI Agent]
28-
VLM[GPT-4o/4o-mini VLM]
29-
Tools[Agent Tools]
30-
end
31-
32-
UI --> Pipeline
33-
Pipeline --> Validator
34-
Pipeline --> MetaExtractor
35-
Pipeline --> Embedder
36-
Embedder --> FAISS
37-
FAISS --> Reranker
38-
Catalog -.-> FAISS
39-
Reranker --> Agent
40-
Agent --> VLM
41-
Agent --> Tools
42-
Agent --> UI
43-
```
7+
![Architecture Diagram](../assets/architecture.png)
448

459
## Design Principles
4610

@@ -456,4 +420,20 @@ Typical request (~3-5 seconds total):
456420

457421
- Deep dive into [Retrieval Pipeline](retrieval.md)
458422
- Learn about [Agent & VLM Selection](agent.md)
423+
424+
## Future Improvements
425+
426+
The following areas are planned for future development:
427+
428+
### UX/UI Enhancements
429+
430+
The current Gradio interface is functional but has room for improvement. Planned work includes better result presentation, improved file management UX, and a more polished visual design to lower the barrier for non-expert users.
431+
432+
### MCP Integration by Users
433+
434+
Today, MCP (Model Context Protocol) tool adapters are defined by the development team. A future goal is to allow users to register and contribute their own MCP-compatible tools directly from the interface, making the catalog extensible without requiring code changes.
435+
436+
### SQLite Integration
437+
438+
Conversation history, tool usage logs, and per-session state currently live only in memory. Adding a SQLite backend would enable persistent sessions, usage analytics, and a foundation for personalised recommendations over time.
459439
- Explore [Software Catalog](catalog.md)

docs/assets/architecture.png

722 KB
Loading

docs/assets/user_flow.png

1.07 MB
Loading

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ Then in the web interface:
5757

5858
## How It Works
5959

60+
![User Integration Flow](assets/user_flow.png)
61+
6062
The system uses a **two-stage pipeline**:
6163

6264
1. **Retrieval Stage**: Fast text search using Qwen3-Embedding-8B embeddings and FAISS to find candidate tools from a curated catalog

0 commit comments

Comments
 (0)