Skip to content

Commit f6c2b8c

Browse files
Revert "Enhance README with architecture and system flow details (#18)"
This reverts commit 629d4d3.
1 parent 7133be2 commit f6c2b8c

1 file changed

Lines changed: 0 additions & 38 deletions

File tree

README.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,6 @@
22

33
A web application that provides an AI-powered chatbot interface for dataset discovery, using Google Gemini API on the backend and a React-based frontend.
44

5-
## Architecture Overview
6-
7-
The KnowledgeSpace AI Agent is a Retrieval-Augmented Generation (RAG) system designed for neuroscience dataset discovery. It combines keyword search, semantic retrieval, and large language model reasoning to surface relevant datasets across heterogeneous sources.
8-
9-
The system consists of the following core components:
10-
11-
- **React Frontend**
12-
- Provides a chat-based interface for interacting with the dataset discovery agent.
13-
14-
- **FastAPI Backend**
15-
- Orchestrates LLM-based reasoning (Gemini), keyword search (Elasticsearch), and semantic search (Vertex AI Matching Engine).
16-
17-
- **Data Processing Pipeline**
18-
- Scrapes and normalizes neuroscience metadata, stores structured records in BigQuery, and indexes vector embeddings in Vertex AI for retrieval.
19-
20-
## System Flow (High-Level)
21-
22-
The following diagram shows the high-level request and data flow through the system:
23-
24-
```mermaid
25-
flowchart LR
26-
User --> Frontend
27-
Frontend --> Backend
28-
Backend -->|Keyword Search| Elasticsearch
29-
Backend -->|Semantic Search| VertexAI
30-
Backend -->|LLM Reasoning| Gemini
31-
Elasticsearch --> Backend
32-
VertexAI --> Backend
33-
Gemini --> Backend
34-
Backend --> Frontend
35-
```
36-
375
## Table of Contents
386

397
- [Prerequisites](#prerequisites)
@@ -97,8 +65,6 @@ Create a file named `.env` in the project root based on `.env.template`. You can
9765
**Option 1: Google API Key (Recommended for development)**
9866

9967
- Set `GOOGLE_API_KEY` in your `.env` file
100-
> You can generate a Gemini API key from **Google AI Studio**:
101-
> https://aistudio.google.com/app/apikey
10268

10369
**Option 2: Vertex AI (Recommended for production)**
10470

@@ -173,10 +139,6 @@ The backend requires specific environment variables to connect to **Google Cloud
173139

174140

175141
## Running the Application
176-
> ⚠️ **Note on Port Configuration**
177-
>
178-
> - Local development: The React development server runs on port **5000**
179-
> - Docker / Nginx deployment: The containerized frontend is exposed on port **3000**
180142

181143
#### Backend (port 8000)
182144

0 commit comments

Comments
 (0)