feedback-analysis-agent / FILES_OVERVIEW.md
galbendavids's picture
注讚讻讜谉: 讛住专转 RAG, 讛讜住驻转 讗专讻讬讟拽讟讜专讛 诪驻讜专讟转, 转讬拽讜谉 诇讬谞拽讬诐, 砖讬谞讜讬 砖诐 驻专讜讬拽讟 诇-SQL-based
f073efc
# 住拽讬专转 拽讘爪讬诐 - 讛住讘专 注诇 讻诇 拽讜讘抓 讜讛住讬讘讛 诇拽讬讜诪讜
## 0_preprocessing/ - 注讬讘讜讚 诪拽讚讬诐 讜拽讘爪讬诐 诪砖诇讬诪讬诐
### 拽讘爪讬 谞转讜谞讬诐
- **feedback_transformed_2.csv**: 讛拽讜讘抓 讛专讗砖讬 注诐 讻诇 讛诪砖讜讘讬诐 讛诪注讜讘讚讬诐. 诪讻讬诇 讗转 讻诇 讛砖讚讜转 讛谞讚专砖讬诐 (ID, ServiceName, Level, Text, Year, Month, DayInMonth, DayOfWeek, Hour, DayOrNight). **住讬讘讛**: 讝讛讜 诪拽讜专 讛谞转讜谞讬诐 讛专讗砖讬 砖诇 讛诪注专讻转.
- **Feedback_given.csv**: 拽讜讘抓 谞转讜谞讬诐 诪拽讜专讬 (讗讜驻爪讬讜谞诇讬). **住讬讘讛**: 讙讬讘讜讬/讙专住讛 诪拽讜专讬转 砖诇 讛谞转讜谞讬诐.
- **feedback_transformed.csv**: 讙专住讛 讬砖谞讛 砖诇 讛谞转讜谞讬诐 (讗讜驻爪讬讜谞诇讬). **住讬讘讛**: 讙讬讘讜讬/讙专住讛 拽讜讚诪转.
### 拽讘爪讬 转讻谞讜谉 讜转讬注讜讚
- **ARCHITECTURE.md**: 诪住诪讱 讗专讻讬讟拽讟讜专讛 诪驻讜专讟. **住讬讘讛**: 转讬注讜讚 讟讻谞讬 砖诇 讛诪注专讻转.
- **CONTRIBUTING.md**: 讛谞讞讬讜转 诇转专讜诪讛 诇驻专讜讬拽讟. **住讬讘讛**: 转讬注讜讚 注讘讜专 诪驻转讞讬诐.
- **DEPLOYMENT_GUIDE.md**: 诪讚专讬讱 驻专讬住讛. **住讬讘讛**: 讛讜专讗讜转 诇驻专讬住转 讛诪注专讻转.
- **HUGGINGFACE_DEPLOYMENT.md**: 诪讚专讬讱 驻专讬住讛 诇-HuggingFace. **住讬讘讛**: 讛讜专讗讜转 住驻爪讬驻讬讜转 诇驻专讬住讛 讘-HuggingFace.
- **MIGRATION_TO_MAIN.md**: 诪讚专讬讱 诪讬讙专爪讬讛. **住讬讘讛**: 转讬注讜讚 转讛诇讬讻讬 诪讬讙专爪讬讛.
- **GETTING_STARTED.txt**: 诪讚专讬讱 讛转讞诇讛 诪讛讬专. **住讬讘讛**: 讛讜专讗讜转 讛转讞诇讛 诪讛讬专讜转.
- **system_architecture.pdf**: 转专砖讬诐 讗专讻讬讟拽讟讜专讛. **住讬讘讛**: 讜讬讝讜讗诇讬讝爪讬讛 砖诇 讛讗专讻讬讟拽讟讜专讛.
- **Gal Shlomo Ben David Ohayone_e-1.pdf**: 拽讜专讜转 讞讬讬诐. **住讬讘讛**: 拽讜专讜转 讞讬讬诐 砖诇 讛诪驻转讞 (诪讜驻讬注讬诐 讘诇讬谞拽 讘-frontend).
### 住拽专讬驻讟讬诐
- **scripts/smoke_check.py**: 讘讚讬拽转 转拽讬谞讜转 讘住讬住讬转. **住讬讘讛**: 讘讚讬拽讜转 讗讜讟讜诪讟讬讜转.
- **scripts/__init__.py**: 诪讗驻砖专 import 砖诇 scripts. **住讬讘讛**: Python package structure.
### 讘讚讬拽讜转
- **tests/test_analysis.py**: 讘讚讬拽讜转 讬讞讬讚讛. **住讬讘讛**: 讘讚讬拽讜转 讗讜讟讜诪讟讬讜转 砖诇 讛驻讜谞拽爪讬讜谞诇讬讜转.
### 讗讞专
- **VERSION**: 诪住驻专 讙专住讛. **住讬讘讛**: 诪注拽讘 讗讞专 讙专住讗讜转.
## 1_frontend/ - 讛讗驻诇讬拽爪讬讛 讜讛讞诇拽 讛驻专讜谞讟讬
### 拽讘爪讬 Frontend
- **index.html**: 诪诪砖拽 讛诪砖转诪砖 讛专讗砖讬. **住讬讘讛**: 诪住驻拽 诪诪砖拽 讜讜讘 讗讬谞讟专讗拽讟讬讘讬 诇诪砖转诪砖. 讻讜诇诇 砖讚讛 拽诇讟, 讛爪讙转 转砖讜讘讜转, 讛讬住讟讜专讬讛, 讜讗谞讬诪爪讬讜转.
- **app.js**: 诇讜讙讬拽转 Frontend. **住讬讘讛**: 诪讟驻诇 讘讻诇 讛讗讬谞讟专讗拽爪讬讜转 - 砖诇讬讞转 砖讗诇讜转 诇-Backend, 讛爪讙转 转砖讜讘讜转, 谞讬讛讜诇 讛讬住讟讜专讬讛, 讜讬爪讬专转 讙专驻讬诐.
## 2_backend_llm/ - 讛诇讜讙讬拽讛 讜讛讗专讻讬讟拽讟讜专讛 讛-LLM
### 谞拽讜讚转 讻谞讬住讛
- **run.py**: 谞拽讜讚转 讛讻谞讬住讛 诇讛专爪转 讛砖专转. **住讬讘讛**: 诪驻注讬诇 讗转 FastAPI server 注诐 uvicorn. 讝讛 讛拽讜讘抓 砖爪专讬讱 诇讛专讬抓 讻讚讬 诇讛转讞讬诇 讗转 讛砖专转.
- **app.py**: wrapper 驻砖讜讟. **住讬讘讛**: wrapper 谞讜住祝 诇讛专爪转 讛讗驻诇讬拽爪讬讛 (讗讜驻爪讬讜谞诇讬).
### 诪讜讚讜诇讬 Backend (app/)
- **app/__init__.py**: 诪讗驻砖专 import 砖诇 app 讻讞讘讬诇讛. **住讬讘讛**: Python package structure.
- **app/api.py**: FastAPI endpoints. **住讬讘讛**: 诪讙讚讬专 讗转 讻诇 讛-API endpoints - `/query-sql`, `/history`, `/health`. 讝讛 谞拽讜讚转 讛讻谞讬住讛 砖诇 讛-Backend.
- **app/sql_service.py**: 讛诇讬讘讛 砖诇 讛诪注专讻转. **住讬讘讛**: 诪讻讬诇 讗转 讻诇 讛诇讜讙讬拽讛 - 讬爪讬专转 砖讗讬诇转讜转 SQL 注诐 LLM, 讘讬爪讜注谉, 讜住讬谞转讝转 转砖讜讘讜转. 讝讛 讛拽讜讘抓 讛讞砖讜讘 讘讬讜转专.
- **app/config.py**: 讛讙讚专讜转 诪注专讻转. **住讬讘讛**: 诪专讻讝 讗转 讻诇 讛讛讙讚专讜转 - API keys, 谞转讬讘讬 拽讘爪讬诐, 砖诪讜转 注诪讜讚讜转.
- **app/data_loader.py**: 讟注讬谞转 谞转讜谞讬诐 诪-CSV. **住讬讘讛**: 诪讟驻诇 讘讟注讬谞转 讜谞讬拽讜讬 讛谞转讜谞讬诐 诪讛拽讜讘抓 CSV.
## 拽讘爪讬诐 讘专诪讛 讛注诇讬讜谞讛
### 拽讘爪讬 讛讙讚专讛
- **requirements.txt**: 转诇讜讬讜转 Python. **住讬讘讛**: 诪讙讚讬专 讗转 讻诇 讛讞讘讬诇讜转 讛谞讚专砖讜转 诇驻专讜讬拽讟.
- **.env**: API keys (诇讗 讘-git). **住讬讘讛**: 诪讻讬诇 诪驻转讞讜转 API (Gemini/OpenAI) - 诇讗 谞砖诪专 讘-git 诪住讬讘讜转 讗讘讟讞讛.
- **docker-compose.yml**: 讛讙讚专讜转 Docker Compose. **住讬讘讛**: 诪讗驻砖专 讛专爪讛 砖诇 讛诪注专讻转 讘-Docker.
- **docker-compose.override.yml**: 讛讙讚专讜转 Docker Compose 诪讜转讗诪讜转 讗讬砖讬转. **住讬讘讛**: override 诇讛讙讚专讜转 Docker Compose.
- **Dockerfile**: 讛讙讚专转 Docker image. **住讬讘讛**: 诪讙讚讬专 讗讬讱 诇讘谞讜转 Docker image 砖诇 讛诪注专讻转.
### 转讬注讜讚
- **README.md**: 转讬注讜讚 专讗砖讬 砖诇 讛驻专讜讬拽讟. **住讬讘讛**: 诪住驻拽 住拽讬专讛 讻诇诇讬转, 讛讜专讗讜转 讛转拽谞讛, 讜砖讬诪讜砖.
- **ARCHITECTURE.md**: 讗专讻讬讟拽讟讜专讛 诪驻讜专讟转 诪讛驻专讜谞讟 诇讗讞讜专. **住讬讘讛**: 诪住驻拽 讛住讘专 诪驻讜专讟 注诇 讛讗专讻讬讟拽讟讜专讛, 讝专讬诪转 讛谞转讜谞讬诐, 讗讬讝讛 诪讜讚诇 拽讜专讗 诇讗讬讝讛 诪讜讚诇, 讜讗讬讱 谞讘谞讬转 讛转砖讜讘讛.
- **FILES_OVERVIEW.md**: 住拽讬专转 讻诇 讛拽讘爪讬诐 讜讛住讬讘讛 诇拽讬讜诪诐. **住讬讘讛**: 诪住驻拽 住拽讬专讛 砖诇 讻诇 讛拽讘爪讬诐 讘驻专讜讬拽讟 讜讛住讬讘讛 诇拽讬讜诪诐.
### 诇讜讙讬诐
- **server.log**: 诇讜讙讬 砖专转 (讗诐 拽讬讬诐). **住讬讘讛**: 专讬砖讜诐 驻注讜诇讜转 讛砖专转 (讗讜驻爪讬讜谞诇讬, 诇讗 谞砖诪专 讘-git).
## 拽讘爪讬诐 砖谞诪讞拽讜/诇讗 专诇讜讜谞讟讬讬诐
- **scripts/fix_creation_date.py**: 谞诪讞拽 - 讛砖讚讛 CreationDate 诇讗 拽讬讬诐 讬讜转专
- **app/static/**: 讛讜注讘专 诇-1_frontend/ - 讗专讙讜谉 诪讞讚砖 砖诇 讛住驻专讬讛