Skip to content

Commit

Permalink
GITBOOK-119: Feedback score computation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
spastorelli authored and gitbook-bot committed Nov 16, 2023
1 parent 0c1db95 commit e31fbfb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/changelogs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

All notable changes to the REST API will be documented in this page.

## 2023-11-16

### Breaking: changing feedback score computation logic

We have changed the way we compute the feedback score based on user ratings which is affecting the following endpoint: `/v1/spaces/:id/insights/content`

* <mark style="color:orange;">**\[Updated]**</mark> `score` is now calculated this way$$score = positives - 0.5 * intermediates - 2*negatives$$.\
This is done to reinforce negative ratings and help surfacing content that may require updates.
* <mark style="color:orange;">**\[Updated]**</mark> `rating` is now computed this way
* `'good'` whenever the score is > 0
* `'ok'` whenever the score is 0
* `'bad'` whenever the score is < 0
* <mark style="color:green;">**\[Added]**</mark> `ponderedScore` is computed by multiplying the `score` by the total amount of ratings given by visitors.

**Note: The GitBook app is displaying `ponderedScore` inside of the Insights section.**

## 2022-09-16

### API for users management
Expand Down

0 comments on commit e31fbfb

Please sign in to comment.