This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
Score details #252
Merged
Score details #252
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dureuill
added
Ready For Review
macraig
reviewed
Jul 4, 2023
dureuill
force-pushed
the
score_details
branch
3 times, most recently
from
2d7f6ab
to
18e6e01
Compare
macraig
reviewed
Jul 4, 2023
Co-authored-by: Maria Craig <[email protected]>
brunoocasali
reviewed
Jul 5, 2023
gmourier
reviewed
Jul 5, 2023
meili-bors bot
added a commit
to meilisearch/meilisearch
that referenced
this pull request
Jul 10, 2023
3906: Add "scoring.*" analytics to multi search route r=Kerollmops a=dureuill # Pull Request ## Related issue Fixes meilisearch/specifications#252 (comment) by implementing (3): multi search now returns the "score.show_ranking_rule" and "score.show_ranking_rule_details" analytics. Co-authored-by: Louis Dureuil <[email protected]>
macraig
approved these changes
Jul 10, 2023
dureuill
commented
Jul 10, 2023
gmourier
reviewed
Jul 13, 2023
| @@ -191,6 +191,8 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat | |||
| | `clear_all` | `true` if `DELETE /indexes/:indexUid/documents` endpoint was used in this batch, otherwise `false` | false | `Documents Deleted` | | |||
| | vector_store | Whether the [vector store](./0193-experimental-features.md#vector-store) feature is enabled. | `true` | `Experimental features Updated` | | |||
| | score_details | Whether the [score details](./0193-experimental-features.md#score-details) feature is enabled. | `true` | `Experimental features Updated` | | |||
| | scoring.show_ranking_score | Was `showRankingScore` used in the aggregated event? If yes, `true`, otherwise `false` | `false` | `Documents Searched POST`, `Documents Searched GET`, `Documents Searched by Multi-Search POST` | | |||
| | scoring.show_ranking_score_details | Was `showRankingScoreDetails` used in the aggregated event? If yes, `true`, otherwise `false` | `false` | `Documents Searched POST`, `Documents Searched GET`, `Documents Searched GET` | | |||
There was a problem hiding this comment.
Suggested change
| | scoring.show_ranking_score_details | Was `showRankingScoreDetails` used in the aggregated event? If yes, `true`, otherwise `false` | `false` | `Documents Searched POST`, `Documents Searched GET`, `Documents Searched GET` | | |
| | scoring.show_ranking_score_details | Was `showRankingScoreDetails` used in the aggregated event? If yes, `true`, otherwise `false` | `false` | `Documents Searched POST`, `Documents Searched GET`, `Documents Searched by Multi-Search POST` | |
🥅
gmourier
reviewed
Jul 13, 2023
| The score is given by the following formula, assuming `n` ranking rules denoted from `0` to `n-1`: | ||
|
|
||
| ``` | ||
| score = sum(i in 0..(n-1), (rank_i - 1) / product(j in 0..=i, max_rank_j)) + (rank_(n-1) / product(i in 0..n, max_rank_i)) |
maryamsulemani97
approved these changes
Jul 13, 2023
gmourier
reviewed
Jul 13, 2023
| }, | ||
| "attribute": { | ||
| "order": 3, | ||
| "attributes_ranking_order": 0.8333333333333334, |
There was a problem hiding this comment.
Should it be written attributesRankingOrder to follow the camelCase field naming convention ?
There was a problem hiding this comment.
Yea Louis was onto me today about this. It looks like the implementation is outputting it with underscores rather than camelCase so will need a change there first (and then an update here and in the blog post to make sure they are the same). I'll create an issue on the project as a start point.
There was a problem hiding this comment.
Issue created here: meilisearch/meilisearch#3941
There was a problem hiding this comment.
Heya!
Here is the PR on Meilisearch fixing it https://github.com/meilisearch/meilisearch/pull/3949/files, however, there is a difference in the name chosen on Meilisearch side and in the spec:
attributeRankingOrderScore vs attributesRankingOrder and queryWordDistanceScore and attributesQueryWordOrder, which names should be chosen?
There was a problem hiding this comment.
Hey many 👋👶
attributeRankingOrderScore and queryWordDistanceScore
Relevant discussion (internal link)
| "attribute": { | ||
| "order": 3, | ||
| "attributes_ranking_order": 0.8333333333333334, | ||
| "attributes_query_word_order": 1, |
macraig
added a commit
that referenced
this pull request
Jul 31, 2023
* Fix various typos * Fix wrongly tagged routes in open api * Telemetry policy * Add new error and api keys actions * Add experimental features and experimental feature API specs * Update open API * Score details (#252) * ranking score spec * search API changes * telemetry policies score * open api * Fix typos in spec Co-authored-by: Maria Craig <[email protected]> * Add multi search telemetry --------- Co-authored-by: Maria Craig <[email protected]> --------- Co-authored-by: Maria Craig <[email protected]>
This was referenced Aug 8, 2023
ahmednfwela
reviewed
Aug 31, 2023
| properties: | ||
| order: | ||
| $ref: '#/components/schemas/order' | ||
| attribute_ranking_order_score: |
There was a problem hiding this comment.
@dureuill @brunoocasali this attribute should be attributeRankingOrderScore ?
also query_word_distance_score => queryWordDistanceScore
4 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤖 API Diff Put the link of the GitHub comment generated by bump.sh if generated; Apply the
OpenApilabelSummary
Specify the ranking score and ranking score details.
Specification for meilisearch/meilisearch#3771
Changes
Out Of Scope
N/A
Attention To Reviewers
experimental_featuresbranch rather than therelease-v1.3.0branch. When merging, make sure to merge Experimental features #250 before this PR.Misc
OpenApilabel)Telemetrylabel)