feat: get more details from the recommendation (#796)

gorse-io · Jan 10, 2024 · 09ad3aa · 09ad3aa
1 parent ab030fd
commit 09ad3aa
Showing 1 changed file with 45 additions and 20 deletions.
diff --git a/server/rest.go b/server/rest.go
@@ -69,6 +69,11 @@ type RestServer struct {
 	HiddenItemsManager *HiddenItemsManager
 }
 
+type ScoredItem struct {
+	data.Item
+	Score float64
+}
+
 // StartHttpServer starts the REST-ful API server.
 func (s *RestServer) StartHttpServer(container *restful.Container) {
 	// register restful APIs
@@ -430,6 +435,7 @@ func (s *RestServer) CreateWebService() {
 		Param(ws.QueryParameter("n", "Number of returned recommendations").DataType("integer")).
 		Param(ws.QueryParameter("offset", "Offset of returned recommendations").DataType("integer")).
 		Param(ws.QueryParameter("user-id", "Remove read items of a user").DataType("string")).
+		Param(ws.QueryParameter("more-details", "If more details of items are needed").DataType("boolean")).
 		Returns(http.StatusOK, "OK", []cache.Scored{}).
 		Writes([]cache.Scored{}))
 	ws.Route(ws.GET("/popular/{category}").To(s.getPopular).
@@ -440,6 +446,7 @@ func (s *RestServer) CreateWebService() {
 		Param(ws.QueryParameter("n", "Number of returned items").DataType("integer")).
 		Param(ws.QueryParameter("offset", "Offset of returned items").DataType("integer")).
 		Param(ws.QueryParameter("user-id", "Remove read items of a user").DataType("string")).
+		Param(ws.QueryParameter("more-details", "If more details of items are needed").DataType("boolean")).
 		Returns(http.StatusOK, "OK", []cache.Scored{}).
 		Writes([]cache.Scored{}))
 	// Get latest items
@@ -450,6 +457,7 @@ func (s *RestServer) CreateWebService() {
 		Param(ws.QueryParameter("n", "Number of returned items").DataType("integer")).
 		Param(ws.QueryParameter("offset", "Offset of returned items").DataType("integer")).
 		Param(ws.QueryParameter("user-id", "Remove read items of a user").DataType("string")).
+		Param(ws.QueryParameter("more-details", "If more details of items are needed").DataType("boolean")).
 		Returns(http.StatusOK, "OK", []cache.Scored{}).
 		Writes([]cache.Scored{}))
 	ws.Route(ws.GET("/latest/{category}").To(s.getLatest).
@@ -460,6 +468,7 @@ func (s *RestServer) CreateWebService() {
 		Param(ws.QueryParameter("n", "Number of returned items").DataType("integer")).
 		Param(ws.QueryParameter("offset", "Offset of returned items").DataType("integer")).
 		Param(ws.QueryParameter("user-id", "Remove read items of a user").DataType("string")).
+		Param(ws.QueryParameter("more-details", "If more details of items are needed").DataType("boolean")).
 		Returns(http.StatusOK, "OK", []cache.Scored{}).
 		Writes([]cache.Scored{}))
 	// Get neighbors
@@ -583,42 +592,57 @@ func (s *RestServer) getSort(key, category string, isItem bool, request *restful
 		return
 	}
 	userId = request.QueryParameter("user-id")
+	isDetailsRequired, _ := strconv.ParseBool(request.QueryParameter("more-details"))
 
 	// Get the popular list
 	items, err := s.CacheClient.GetSorted(ctx, cache.Key(key, category), offset, s.Config.Recommend.CacheSize)
 	if err != nil {
 		InternalServerError(response, err)
 		return
 	}
+
 	if isItem {
 		items = s.FilterOutHiddenScores(response, items, category)
 	}
+	if n > 0 && len(items) > n {
+		items = items[:n]
+	}
 
-	// Remove read items
-	if userId != "" {
-		feedback, err := s.DataClient.GetUserFeedback(ctx, userId, s.Config.Now())
-		if err != nil {
-			InternalServerError(response, err)
-			return
-		}
-		readItems := strset.New()
-		for _, f := range feedback {
-			readItems.Add(f.ItemId)
+	if isDetailsRequired {
+		details := make([]ScoredItem, len(items))
+		for i := range items {
+			details[i].Score = items[i].Score
+			details[i].Item, err = s.DataClient.GetItem(ctx, items[i].Id)
+			if err != nil {
+				InternalServerError(response, err)
+				return
+			}
 		}
-		prunedItems := make([]cache.Scored, 0, len(items))
-		for _, item := range items {
-			if !readItems.Has(item.Id) {
-				prunedItems = append(prunedItems, item)
+		Ok(response, details)
+		// Send result
+	} else {
+		// Remove read items
+		if userId != "" {
+			feedback, err := s.DataClient.GetUserFeedback(ctx, userId, s.Config.Now())
+			if err != nil {
+				InternalServerError(response, err)
+				return
+			}
+			readItems := strset.New()
+			for _, f := range feedback {
+				readItems.Add(f.ItemId)
 			}
+			prunedItems := make([]cache.Scored, 0, len(items))
+			for _, item := range items {
+				if !readItems.Has(item.Id) {
+					prunedItems = append(prunedItems, item)
+				}
+			}
+			items = prunedItems
 		}
-		items = prunedItems
+		Ok(response, items)
 	}
 
-	// Send result
-	if n > 0 && len(items) > n {
-		items = items[:n]
-	}
-	Ok(response, items)
 }
 
 func (s *RestServer) getPopular(request *restful.Request, response *restful.Response) {
@@ -629,6 +653,7 @@ func (s *RestServer) getPopular(request *restful.Request, response *restful.Resp
 
 func (s *RestServer) getLatest(request *restful.Request, response *restful.Response) {
 	category := request.PathParameter("category")
+	log.ResponseLogger(response).Debug("get category popular items in category", zap.String("category", category))
 	log.ResponseLogger(response).Debug("get category latest items in category", zap.String("category", category))
 	s.getSort(cache.LatestItems, category, true, request, response)
 }