Score details by dureuill · Pull Request #252 · meilisearch/specifications

dureuill · 2023-07-04T07:12:37Z

🤖 API Diff Put the link of the GitHub comment generated by bump.sh if generated; Apply the OpenApi label

Summary

Specify the ranking score and ranking score details.

Specification for meilisearch/meilisearch#3771

Changes

Add new ranking score specification
Update search API with the new query parameters and the new fields added to returned documents
Update telemetry
Update Open API

Out Of Scope

N/A

Attention To Reviewers

This PR references the "experimental features" spec, and so is based on the experimental_features branch rather than the release-v1.3.0 branch. When merging, make sure to merge Experimental features #250 before this PR.

Misc

Update OpenAPI specification file (if needed; Apply the OpenApi label)
Update telemetry datapoints (if needed; Apply the Telemetry label)

Co-authored-by: Maria Craig <marycraig90@gmail.com>

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 <louis@meilisearch.com>

gmourier · 2023-07-13T16:05:59Z

 | 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` |


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 · 2023-07-13T16:13:16Z

+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))


gmourier · 2023-07-13T16:16:04Z

+    },
+    "attribute": {
+        "order": 3,
+        "attributes_ranking_order": 0.8333333333333334,


Should it be written attributesRankingOrder to follow the camelCase field naming convention ?

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.

Issue created here: meilisearch/meilisearch#3941

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?

@gmourier

Hey many 👋👶

attributeRankingOrderScore and queryWordDistanceScore

Relevant discussion (internal link)

gmourier · 2023-07-13T16:16:21Z

+    "attribute": {
+        "order": 3,
+        "attributes_ranking_order": 0.8333333333333334,
+        "attributes_query_word_order": 1,


* 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 <marycraig90@gmail.com> * Add multi search telemetry --------- Co-authored-by: Maria Craig <marycraig90@gmail.com> --------- Co-authored-by: Maria Craig <marycraig90@gmail.com>

ahmednfwela · 2023-08-31T14:18:03Z

+          properties:
+            order:
+              $ref: '#/components/schemas/order'
+            attribute_ranking_order_score:


@dureuill @brunoocasali this attribute should be attributeRankingOrderScore ?
also query_word_distance_score => queryWordDistanceScore

dureuill added Ready For Review Feature specification must be reviewed. Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect. 🧪 Experimental The PR describes an experimental feature. v1.3.0 labels Jul 4, 2023

dureuill requested review from macraig and maryamsulemani97 July 4, 2023 07:12

macraig reviewed Jul 4, 2023

View reviewed changes

Comment thread text/0118-search-api.md Outdated

dureuill force-pushed the score_details branch 3 times, most recently from 2d7f6ab to 18e6e01 Compare July 4, 2023 09:49

dureuill added 4 commits July 4, 2023 11:50

ranking score spec

204f8ac

search API changes

bd1feb3

telemetry policies score

aa6a1ba

open api

cd90e09

dureuill force-pushed the score_details branch from 18e6e01 to cd90e09 Compare July 4, 2023 09:50

macraig reviewed Jul 4, 2023

View reviewed changes

Comment thread text/0195-ranking-score.md Outdated

Comment thread text/0195-ranking-score.md Outdated

Comment thread text/0195-ranking-score.md Outdated

Comment thread text/0195-ranking-score.md Outdated

Fix typos in spec

c25d758

Co-authored-by: Maria Craig <marycraig90@gmail.com>

brunoocasali reviewed Jul 5, 2023

View reviewed changes

Comment thread text/0118-search-api.md

gmourier reviewed Jul 5, 2023

View reviewed changes

Comment thread text/0034-telemetry-policies.md Outdated

macraig mentioned this pull request Jul 5, 2023

Release v1.3.0 #244

Merged

1 task

dureuill mentioned this pull request Jul 10, 2023

Add "scoring.*" analytics to multi search route meilisearch/meilisearch#3906

Merged

bidoubiwa mentioned this pull request Jul 5, 2023

Changes regarding Meilisearch v1.3.0 meilisearch/integration-guides#280

Closed

macraig approved these changes Jul 10, 2023

View reviewed changes

dureuill commented Jul 10, 2023

View reviewed changes

Comment thread text/0034-telemetry-policies.md Outdated

Add multi search telemetry

9ed3609

bidoubiwa mentioned this pull request Jul 10, 2023

Add rankingScore and rankingScoreDetails types meilisearch/meilisearch-js#1537

Merged

maryamsulemani97 mentioned this pull request Jul 12, 2023

v1.3: Telemetry meilisearch/documentation#2492

Closed

gmourier reviewed Jul 13, 2023

View reviewed changes

maryamsulemani97 approved these changes Jul 13, 2023

View reviewed changes

gmourier reviewed Jul 13, 2023

View reviewed changes

macraig merged commit 1d6afe2 into experimental_features Jul 31, 2023

macraig deleted the score_details branch July 31, 2023 10:25

ahmednfwela reviewed Aug 31, 2023

View reviewed changes

ahmednfwela mentioned this pull request Sep 1, 2023

Add Result container meilisearch/meilisearch-dart#350

Merged

4 tasks

	\| 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` \|

Uh oh!

Conversation

dureuill commented Jul 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Out Of Scope

Attention To Reviewers

Misc

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gillian-meilisearch Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

dureuill commented Jul 4, 2023 •

edited

Loading

gillian-meilisearch Jul 20, 2023 •

edited

Loading