PhotosRequest¶
Assistant V2 photo recommendation request.
Fields¶
Property |
Required |
Type |
Description |
---|---|---|---|
id |
True |
string |
Unique identifier of the article. |
title |
False |
string |
The title or subject of the article, when available; mutually exclusive with the |
lead |
False |
string |
The lead or abstract of the article, when available; mutually exclusive with the |
text |
False |
string |
The main text or body of the article; mutually exclusive with the |
paraSpecs |
False |
List[ParaSpec] |
The article paragraphs; mutually exclusive with |
categories |
False |
List[Category] |
The 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 |
The language of the article |
presentationLanguage |
False |
string |
The presentation language of the results |
recommendationCount |
False |
integer |
The number of photographs to recommend. |
altPhotosCount |
False |
integer |
Maximum number of photo alternatives to return per recommended photograph. |
constraints |
False |
The constraints and restrictions on the photo properties to narrow down the photos 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] |
The list of photo fields that should be returned in the |
cursor |
False |
string |
Enables pagination. If cursor parameter is missing the pagination is disabled. To enable pagination set the value to |