RecommendRequest
Request object for the search/recommendation feature.
Properties
| Property | Required | Type | Description |
|---|---|---|---|
article | False | Article | Full article used as the target for recommendations. Mutually exclusive with textSnippet. |
textSnippet | False | String | Short plain-text snippet used as the target. Mutually exclusive with article. |
language | False | String | Language of textSnippet as an ISO 639-1 two-letter code. |
mode | True | String | Recommendation mode, e.g., similarity. |
modeParams | False | Map | Mode-specific parameters. |
minScore | False | Float | Minimum similarity score (0.0–1.0, default 0.5). |
maxArticles | False | Integer | Maximum number of recommended articles (1–100, default 10). |
articleFilters | False | Map | Metadata filters restricting the search scope. See this guide for details. |
returnDuplicates | False | Boolean | Whether to return ArticleDuplicate objects. |
returnFields | False | List[String] | Article fields to return in the response. id and score are always included. |
Exactly one of article or textSnippet must be provided.
Currently, only one recommendation mode is supported:
similarity — Performs a semantic search based on content similarity.