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 response message containing a list of recommended documents (\u003ccode\u003eresults\u003c/code\u003e), an attribution token (\u003ccode\u003eattributionToken\u003c/code\u003e), IDs of any missing documents (\u003ccode\u003emissingIds\u003c/code\u003e), and a boolean indicating if the request was for validation only (\u003ccode\u003evalidateOnly\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eEach recommended document in the \u003ccode\u003eresults\u003c/code\u003e list is represented by a \u003ccode\u003eRecommendationResult\u003c/code\u003e, which includes the document's ID (\u003ccode\u003eid\u003c/code\u003e), the full document object (\u003ccode\u003edocument\u003c/code\u003e) if requested, and additional metadata (\u003ccode\u003emetadata\u003c/code\u003e) like the recommendation score.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eattributionToken\u003c/code\u003e is a unique identifier that should be logged in \u003ccode\u003eUserEvent\u003c/code\u003e logs to track and attribute the performance of the recommendation model.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emissingIds\u003c/code\u003e field indicates which requested document IDs were not found in the default branch associated with the serving configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe metadata field can include additional information, such as the recommendation score, which is available if requested.\u003c/p\u003e\n"]]],[],null,[]]