aherobo/DS_TASK_AI_VIEWS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update README to reflect accurate count of 10 API endpoints

Browse Source
This commit is contained in:
Aherobo Ovie Victor
2025-07-07 23:41:26 +01:00
parent 87ac5b9c14
commit 5c699bbd3a
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+9 -6
View File
@@ -9,7 +9,7 @@ DS Task AI News is a fully functional AI-powered news retrieval system that aggr
**System Metrics:** **System Metrics:**
- **238+ articles** successfully processed and stored - **238+ articles** successfully processed and stored
- **3 RSS sources** actively monitored (BBC, TechCrunch, WIRED) - **3 RSS sources** actively monitored (BBC, TechCrunch, WIRED)
- **8 API endpoints** fully functional - **10 API endpoints** fully functional
- **384-dimensional** vector embeddings operational - **384-dimensional** vector embeddings operational
- **FAISS vector database** with similarity search - **FAISS vector database** with similarity search
- **Production-ready** with comprehensive error handling - **Production-ready** with comprehensive error handling
@@ -19,7 +19,7 @@ DS Task AI News is a fully functional AI-powered news retrieval system that aggr
* **✅ Multi-Source News Aggregation**: Fetches from BBC Technology, TechCrunch, and WIRED RSS feeds * **✅ Multi-Source News Aggregation**: Fetches from BBC Technology, TechCrunch, and WIRED RSS feeds
* **✅ Vector Database Storage**: FAISS-powered vector storage with 384D embeddings * **✅ Vector Database Storage**: FAISS-powered vector storage with 384D embeddings
* **✅ AI-Powered Recommendations**: Query-based and article-to-article similarity matching * **✅ AI-Powered Recommendations**: Query-based and article-to-article similarity matching
* **✅ RESTful API**: Complete FastAPI backend with 8 endpoints * **✅ RESTful API**: Complete FastAPI backend with 10 endpoints
* **✅ Groq LLM Integration**: Ready for AI-enhanced article analysis * **✅ Groq LLM Integration**: Ready for AI-enhanced article analysis
* **✅ Fallback Embeddings**: Hash-based embeddings ensure system reliability * **✅ Fallback Embeddings**: Hash-based embeddings ensure system reliability
* **✅ Real-time Processing**: Live news fetching and vector indexing * **✅ Real-time Processing**: Live news fetching and vector indexing
@@ -156,13 +156,16 @@ Our implementation includes:
## 🔌 API Endpoints ## 🔌 API Endpoints
### Core Endpoints ### All 10 API Endpoints
* `GET /` - API health check * `GET /` - API health check
* `GET /health` - Detailed system status * `GET /health` - Detailed system status
* `POST /fetch-news` - Fetch latest news from all RSS sources * `POST /fetch-news` - Fetch latest news from all RSS sources
* `GET /trending?top_k=N` - Get N most recent articles * `GET /recommend-news` - Get recommendations by article ID
* `GET /articles?limit=N` - Get N articles from database
* `POST /recommend-by-query` - Get recommendations based on text query * `POST /recommend-by-query` - Get recommendations based on text query
* `POST /recommend-by-interests` - Get recommendations by user interests
* `GET /trending?top_k=N` - Get N most recent articles
* `GET /articles?limit=N` - Get N articles from database with filtering
* `POST /search` - Advanced search with multiple filters
* `GET /stats` - System statistics and metrics * `GET /stats` - System statistics and metrics
### Example Responses ### Example Responses
@@ -266,7 +269,7 @@ curl -X POST http://localhost:8000/fetch-news
- **✅ 238+ articles** processed and indexed - **✅ 238+ articles** processed and indexed
- **✅ 3 RSS sources** actively monitored - **✅ 3 RSS sources** actively monitored
- **✅ 8 API endpoints** fully operational - **✅ 10 API endpoints** fully operational
- **✅ 384D vector space** for similarity search - **✅ 384D vector space** for similarity search
- **✅ Production-ready** error handling - **✅ Production-ready** error handling
- **✅ Clean codebase** following best practices - **✅ Clean codebase** following best practices