Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: get item details with score #796

Merged
merged 2 commits into from
Jan 10, 2024
Merged

feat: get item details with score #796

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d769ef8
feat: get more details from the recommendation
ubrmnsh Jan 9, 2024
3386d12
Merge pull request #2 from ubrmnsh/feat/get-popular-items-with-more-d…
ubrmnsh Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
65 changes: 45 additions & 20 deletions server/rest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand All @@ -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
Expand All @@ -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).
Expand All @@ -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
Expand Down Expand Up @@ -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) {
Expand All @@ -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)
}
Expand Down