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

docs: Update API endpoints section to include all 13 endpoints

Browse Source 
🔧 FIXED MISSING ENDPOINTS:
- Updated 'All 10 API Endpoints' to 'All 13 API Endpoints'
- Added missing 3 AI Analysis endpoints:
  * POST /analyze-article - AI article analysis
  * POST /generate-insights - AI insights generation
  * GET /ai-status - AI system status
- Organized endpoints by functional categories
- Enhanced descriptions with parameters

✅ COMPLETE ENDPOINT DOCUMENTATION:
- All 13 endpoints now properly documented
- Consistent formatting and categorization
- Ready for developer reference and integration
This commit is contained in:
Aherobo Ovie Victor
2025-07-08 19:11:19 +01:00
parent 9745cdeaa6
commit fce69683a5
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+21 -8
View File
@@ -265,17 +265,30 @@ Our implementation includes:
## 🔌 API Endpoints
### All 10 API Endpoints
* `GET /` - API health check
* `GET /health` - Detailed system status
### All 13 API Endpoints
#### **Core System (3)**
* `GET /` - API health check and version info
* `GET /health` - Detailed system status and vector store metrics
* `GET /stats` - Comprehensive system statistics and performance data
#### **News Management (2)**
* `POST /fetch-news` - Fetch latest news from all RSS sources
* `GET /recommend-news` - Get recommendations by article ID
* `GET /articles?limit=N&offset=M` - Get articles with pagination and advanced filtering
#### **Recommendations (4)**
* `GET /recommend-news?article_id=X&top_k=N` - 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
* `GET /trending?top_k=N` - Get N most trending articles
#### **Search & Discovery (1)**
* `POST /search` - Advanced semantic search with multiple filters
#### **AI Analysis (3)**
* `POST /analyze-article` - AI-powered article analysis (summary, sentiment, keywords)
* `POST /generate-insights` - Generate AI insights from multiple articles
* `GET /ai-status` - Check AI system status and capabilities
### Example Responses