Article Recommender API
Overview
The Article Recommender API provides endpoints for managing an article index and recommending related articles based on their content and metadata.
Endpoints
| Endpoint | Description | |
|---|---|---|
| Request | 200 Response | |
| GET /v2/articles | Lists available article datasets. | |
| List[string] | ||
GET /v2/articles/{dataset}/{art_id} | Retrieves an article from an index. | |
| Article | ||
PUT /v2/articles/{dataset}/{art_id} | Adds or updates an article in an index. | |
| Article | Message | |
DELETE /v2/articles/{dataset}/{art_id} | Deletes an article from an index. | |
| Message | ||
POST /v2/articles/{dataset}/recommend | Recommends related articles for a given article. | |
| RecommendArticles | ArticlesResponse | |
POST /v2/articles/{dataset}/recommend/feedback | Sends feedback on a specific article recommendation. | |
| RecommendArticlesFeedback | Message | |
GET /v2/articles
Lists available article datasets.
- Request: (empty)
- Response: List[string]
GET /v2/articles/{dataset}/{art_id}
Retrieves a single article from the specified dataset index.
- Request: (empty)
- Response: Article
PUT /v2/articles/{dataset}/{art_id}
Adds or replaces a single article in the specified dataset index.
DELETE /v2/articles/{dataset}/{art_id}
Removes a single article from the specified dataset index.
- Request: (empty)
- Response: Message
POST /v2/articles/{dataset}/recommend
Recommends related articles based on the content and metadata of a given article.
- Request: RecommendArticles
- Response: ArticlesResponse
POST /v2/articles/{dataset}/recommend/feedback
Sends feedback on a specific article recommendation.
- Request: RecommendArticlesFeedback
- Response: Message