PhotosRequest
A request to the Assistant V2 API for photo recommendations.
Fields
| Property | Required | Type | Description |
|---|---|---|---|
| id | True | string | Unique identifier of the article |
| title | False | string | Title or subject of the article, when available; mutually exclusive with the paraSpecs parameter |
| lead | False | string | Lead or abstract of the article, when available; mutually exclusive with the paraSpecs parameter |
| text | False | string | Main text or body of the article; mutually exclusive with the paraSpecs parameter |
| paraSpecs | False | List[ParaSpec] | Article paragraphs; mutually exclusive with title and text parameters |
| categories | False | List[Category] | Categories of the article |
| referenceDate | False | string | Date to be used for the analysis as a reference; values: NOW or in format YYYY-MM-DD |
| language | False | string | Language of the article |
| presentationLanguage | False | string | Presentation language of the results |
| recommendationCount | False | integer | Number of photographs to recommend |
| altPhotosCount | False | integer | Maximum number of photo alternatives to return per recommended photograph |
| constraints | False | PhotoConstraints | Constraints and restrictions on the photo properties to narrow down the photo recommendation results |
| returnAltPhotos | False | boolean | Return photo alternatives, when available, for the recommended photographs |
| returnObjects | False | boolean | Return PhotoData objects in addition to the photo IDs for the recommended photographs |
| returnObjectFields | False | List[string] | List of photo fields to return in the PhotoData object. Ignored if returnObjects is not set to true. Photo ID field is always returned, even if not mentioned in returnObjectFields. If returnObjectFields is not specified then all photo fields are returned |
| cursor | False | string | Enables pagination. If cursor parameter is missing, pagination is disabled. To enable pagination, set the value to *. To retrieve the next page, use nextCursor from the previous result. Make sure not to change other parameters in a pagination request |