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.

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

[v1.3] [EXPERIMENTAL] Display ranking details at search #501

Closed
3 tasks
brunoocasali opened this issue Aug 8, 2023 · 1 comment
Closed
3 tasks

[v1.3] [EXPERIMENTAL] Display ranking details at search #501

brunoocasali opened this issue Aug 8, 2023 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@brunoocasali
Copy link
Member

⚠️ This issue is generated, it means the examples and the namings do not necessarily correspond to the language of this repository.
Also, if you are a maintainer, please add any clarification and instructions about this issue.

Sorry if this is already wholly/partially implemented. Feel free to let me know about the state of this issue in the repo.

Related to meilisearch/integration-guides#280


This issue is divided into two sections, first, you need to make the implementation, and second, you must update the code-samples (no one likes outdated docs, right?).

New implementation

Related to:

This feature aims to return ranking details for each document to understand and tweak the score of the documents more easily.

Ensure the SDKs can handle the new search parameter showRankingScoreDetails. Also ensure the SDK can handle the _rankingScoreDetails attributes in the matched hits.

⚠️ This feature is enabled by querying PATCH /experimental-features with { "scoreDetails": true }

Extra: Add inline documentation for the method, explaining the availability of this feature only for Meilisearch v1.3 and newer. And that is also an experimental feature that must be manually opt-in using the /experimental-features meilisearch/meilisearch#3857 endpoint.

TODO:

  • Add the ability receive a new param in the search method called showRankingScoreDetails.
  • Add the ability handle the new _rankingScoreDetails key/value in the search hits' response.
  • Add integration tests (don't forget to enable the experimental feature)
@brunoocasali brunoocasali added good first issue Good for newcomers enhancement New feature or request labels Aug 8, 2023
meili-bors bot added a commit that referenced this issue Sep 12, 2023
509: Add total field to get-tasks route r=irevoire a=hmacr

# Pull Request

## Related issue
Fixes #504 

## What does this PR do?
- Adds `total` field to `get-tasks` route

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


516: Implement client for experimental-features API r=irevoire a=hmacr

# Pull Request

## Related issue
Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite

## What does this PR do?
- Introduces the experimental-features client in the SDK
- Implements the `get` and `patch` endpoint.
- Adds code-samples and tests.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: hmacr <hmac.devo@gmail.com>
meili-bors bot added a commit that referenced this issue Sep 12, 2023
509: Add total field to get-tasks route r=curquiza a=hmacr

# Pull Request

## Related issue
Fixes #504 

## What does this PR do?
- Adds `total` field to `get-tasks` route

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


516: Implement client for experimental-features API r=curquiza a=hmacr

# Pull Request

## Related issue
Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite

## What does this PR do?
- Introduces the experimental-features client in the SDK
- Implements the `get` and `patch` endpoint.
- Adds code-samples and tests.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: hmacr <hmac.devo@gmail.com>
Co-authored-by: Clémentine U. - curqui <clementine@meilisearch.com>
meili-bors bot added a commit that referenced this issue Sep 12, 2023
516: Implement client for experimental-features API r=curquiza a=hmacr

# Pull Request

## Related issue
Needed for #498 & #501, since these issues involve updating the experimental-feature as a pre-requisite

## What does this PR do?
- Introduces the experimental-features client in the SDK
- Implements the `get` and `patch` endpoint.
- Adds code-samples and tests.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: hmacr <hmac.devo@gmail.com>
Co-authored-by: Clémentine U. - curqui <clementine@meilisearch.com>
@curquiza
Copy link
Member

Replaced by #556 because the feature has been stabilized in Meilisearch v1.7.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants