diff --git a/docs/README.md b/docs/README.md index 8fe46ba..4785d2f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,7 +9,7 @@ DS Task AI News is a fully functional AI-powered news retrieval system that aggr **System Metrics:** - **238+ articles** successfully processed and stored - **3 RSS sources** actively monitored (BBC, TechCrunch, WIRED) -- **8 API endpoints** fully functional +- **10 API endpoints** fully functional - **384-dimensional** vector embeddings operational - **FAISS vector database** with similarity search - **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 * **✅ Vector Database Storage**: FAISS-powered vector storage with 384D embeddings * **✅ 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 * **✅ Fallback Embeddings**: Hash-based embeddings ensure system reliability * **✅ Real-time Processing**: Live news fetching and vector indexing @@ -156,13 +156,16 @@ Our implementation includes: ## 🔌 API Endpoints -### Core Endpoints +### All 10 API Endpoints * `GET /` - API health check * `GET /health` - Detailed system status * `POST /fetch-news` - Fetch latest news from all RSS sources -* `GET /trending?top_k=N` - Get N most recent articles -* `GET /articles?limit=N` - Get N articles from database +* `GET /recommend-news` - Get recommendations by article ID * `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 ### Example Responses @@ -266,7 +269,7 @@ curl -X POST http://localhost:8000/fetch-news - **✅ 238+ articles** processed and indexed - **✅ 3 RSS sources** actively monitored -- **✅ 8 API endpoints** fully operational +- **✅ 10 API endpoints** fully operational - **✅ 384D vector space** for similarity search - **✅ Production-ready** error handling - **✅ Clean codebase** following best practices