RecommendArticles
Request object for recommending related articles based on the content and metadata of a given article.
Fields
| Property | Required | Type | Description |
|---|---|---|---|
| id | True | string | Unique identifier of the article |
| title | False | string | Title or subject of the article; mutually exclusive with paraSpecs |
| lead | False | string | Lead or abstract of the article; mutually exclusive with paraSpecs |
| text | False | string | Required when paraSpecs is missing or empty; mutually exclusive with paraSpecs |
| paraSpecs | False | List[ParaSpec] | Mutually exclusive with title, lead, and text |
| language | False | string | ISO 639-1 language code, e.g., en or fr |
| publishDate | False | string | ISO 8601 date/time, e.g., 2025-01-01T12:00:00Z |
| categories | False | List[Category] | Categories associated with the article |
| recommendationCount | False | int | Number of related articles to recommend |
| constraints | False | ArticleConstraints | Constraints for filtering recommendation results |
| returnObjects | False | bool | Whether to return full article objects; default is false |
| returnObjectFields | False | List[string] | Fields to return in full article objects; all returned when missing or empty |