RecommendResponse

Response message for Recommend method.

JSON representation
 { 
 "results" 
 : 
 [ 
 { 
 object (  RecommendationResult 
 
) 
 } 
 ] 
 , 
 "attributionToken" 
 : 
 string 
 , 
 "missingIds" 
 : 
 [ 
 string 
 ] 
 , 
 "validateOnly" 
 : 
 boolean 
 } 
Fields
results[]

object ( RecommendationResult )

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

attributionToken

string

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

missingIds[]

string

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

validateOnly

boolean

True if RecommendRequest.validate_only was set.

RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

JSON representation
 { 
 "id" 
 : 
 string 
 , 
 "document" 
 : 
 { 
 object (  Document 
 
) 
 } 
 , 
 "metadata" 
 : 
 { 
 string 
 : 
 value 
 , 
 ... 
 } 
 } 
Fields
id

string

Resource ID of the recommended Document.

document

object ( Document )

Set if returnDocument is set to true in RecommendRequest.params .

Design a Mobile Site
View Site in Mobile | Classic
Share by: