meilisearch / meilisearch/meilisearch-ruby

[Meilisearch v1.47.0] Add personalized search (experimental)

Open
#702 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Ruby
Stars
224
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Context

Meilisearch 1.47.0 adds full support for personalized search (experimental) to the search endpoint.

NB: before 1.47.0, federated search requests did not support personalized search.

Objective

Update the SDK to support personalized search on the search endpoint.

Update the corresponding SDK methods

Both related API endpoints now accept a new personalize object parameter:

{
  // other request parameters...
  "personalize": {
    "userContext": "The user prefers ..."
  }
}

Tasks

  • Add/update methods to handle interacting with the search API endpoints
  • Add/update test cases for the new/updated methods
  • No code samples to update

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the SDK methods corresponding to the Search (POST) and Search (GET) endpoints, then read how existing search parameters are represented and passed. Add support for the new personalize object parameter on both methods and update their test cases to cover it. Done means both endpoints accept the parameter and the tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.