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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eRecommend\u003c/code\u003e method returns a list of recommended \u003ccode\u003eDocuments\u003c/code\u003e in the \u003ccode\u003eresults\u003c/code\u003e field, along with an \u003ccode\u003eattributionToken\u003c/code\u003e for tracking model performance and a list of \u003ccode\u003emissingIds\u003c/code\u003e for any requested documents that could not be found.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRecommendationResult\u003c/code\u003e provides details for each recommended document, including its \u003ccode\u003eid\u003c/code\u003e, the \u003ccode\u003edocument\u003c/code\u003e itself (if requested), and \u003ccode\u003emetadata\u003c/code\u003e such as a recommendation \u003ccode\u003escore\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eattributionToken\u003c/code\u003e is crucial for accurate tracking of the recommendation model's performance, and should be included in the \u003ccode\u003eUserEvent\u003c/code\u003e logs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003evalidateOnly\u003c/code\u003e field in the response indicates whether the \u003ccode\u003evalidate_only\u003c/code\u003e parameter in the \u003ccode\u003eRecommendRequest\u003c/code\u003e was set.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emetadata\u003c/code\u003e field within \u003ccode\u003eRecommendationResult\u003c/code\u003e may contain additional document annotations, and most notably, a \u003ccode\u003escore\u003c/code\u003e representing the recommendation's quality if requested.\u003c/p\u003e\n"]]],[],null,["# RecommendResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [RecommendationResult](#RecommendationResult)\n - [JSON representation](#RecommendationResult.SCHEMA_REPRESENTATION)\n\nResponse message for Recommend method.\n\nRecommendationResult\n--------------------\n\nRecommendationResult represents a generic recommendation result with associated metadata."]]
