Skip to main content

PhotosRequest

Assistant V2 photo recommendation request.

Fields

PropertyRequiredTypeDescription
idTruestringUnique identifier of the article.
titleFalsestringThe title or subject of the article, when available; mutually exclusive with the paraSpecs parameter
leadFalsestringThe lead or abstract of the article, when available; mutually exclusive with the paraSpecs parameter
textFalsestringThe main text or body of the article; mutually exclusive with the paraSpecs parameter
paraSpecsFalseList[ParaSpec]The article paragraphs; mutually exclusive with title and text parameters
categoriesFalseList[Category]The categories of the article
referenceDateFalsestringDate to be used for the analysis as a reference; values: "NOW" or in format YYYY-MM-DD
languageFalsestringThe language of the article
presentationLanguageFalsestringThe presentation language of the results
recommendationCountFalseintegerThe number of photographs to recommend.
altPhotosCountFalseintegerMaximum number of photo alternatives to return per recommended photograph.
constraintsFalsePhotoConstraintsThe constraints and restrictions on the photo properties to narrow down the photos recommendation results.
returnAltPhotosFalsebooleanReturn photo alternatives, when available, for the recommended photographs.
returnObjectsFalsebooleanReturn PhotoData objects in addition to the photo IDs for the recommended photographs.
returnObjectFieldsFalseList[string]The list of photo fields that should be returned in the PhototData object.
This is ignored if returnObjects is not set to true. The photo ID field is always returned, even if it is not mentioned in returnObjectFields. If returnObjectFields is not specified then all photo fields are returned.
cursorFalsestringEnables pagination. If cursor parameter is missing the pagination is disabled. To enable pagination set the value to *. To retrieve the next page use nextCursor from the previous result. Make sure to not change other parameters in pagination request.