Ranking rules

Child route of the settings route.

Ranking rules are built-in rules that allow you to customize the relevancy of your search results. They are stored in an array and applied in order of appearance.

Ranking rules can also be updated directly through the global settings route along with the other settings.

To learn more about ranking rules, refer to our dedicated guide.

WARNING

Updating the settings means overwriting the default settings of Meilisearch. You can reset to default values using the DELETE routes.

Get ranking rules

GET

/indexes/{index_uid}/settings/ranking-rules

Get the ranking rules of an index. The index uid is required.

Default value

An array that contains ranking rules in order of importance.

Example

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/ranking-rules'

client.index('movies').getRankingRules()

client.index('movies').get_ranking_rules()

$client->index('movies')->getRankingRules();

client.index("movies").getRankingRules();

client.index('movies').ranking_rules

client.Index("movies").GetRankingRules()

await client.Index("movies").GetRankingRulesAsync();

let ranking_rules: Vec<String> = client
  .index("movies")
  .get_ranking_rules()
  .await
  .unwrap();

client.index("movies").getRankingRules { (result) in
    switch result {
    case .success(let rankingRules):
        print(rankingRules)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').get_ranking_rules();

Response: 200 Ok

List the settings.

[
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:desc"
]

Update ranking rules

PUT

/indexes/{index_uid}/settings/ranking-rules

Update the ranking rules of an index. The index uid is required.

Body

An array that contain ranking rules sorted by order of importance.

To add your own ranking rule, you have to communicate an attribute followed by a colon (:) and either asc for ascending order or desc for descending order.

• To apply an ascending sort (results sorted by increasing value): attribute_name:asc

• To apply a descending sort (results sorted by decreasing value): attribute_name:desc

More information about the body.

Example

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
  ]'

client.index('movies').updateRankingRules([
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:asc',
    'rank:desc'
])

client.index('movies').update_ranking_rules([
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:asc',
    'rank:desc'
])

$client->index('movies')->updateRankingRules([
  'words',
  'typo',
  'proximity',
  'attribute',
  'sort',
  'exactness',
  'release_date:asc',
  'rank:desc'
]);

Settings settings = new Settings();
settings.setRankingRules(new String[]
{
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank:desc"
});
client.index("movies").updateSettings(settings);

client.index('movies').update_ranking_rules([
  'words',
  'typo',
  'proximity',
  'attribute',
  'sort',
  'exactness',
  'release_date:asc',
  'rank:desc'
])

rankingRules := []string{
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank:desc",
}
client.Index("movies").UpdateRankingRules(&rankingRules)

await client.Index("movies").UpdateRankingRulesAsync(new[]
{
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
});

let ranking_rules = [
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank:desc",
];

let task: TaskInfo = client
  .index("movies")
  .set_ranking_rules(&ranking_rules)
  .await
  .unwrap();

let rankingRules: [String] = [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
]
client.index("movies").updateRankingRules(rankingRules) { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').update_ranking_rules([
  'words',
  'typo',
  'proximity',
  'attribute',
  'sort',
  'exactness',
  'release_date:asc',
  'rank:desc'
]);

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset ranking rules

DELETE

/indexes/{index_uid}/settings/ranking-rules

Reset the ranking rules of an index to their default value. The index uid is required.

TIP

Note that resetting the ranking rules is not the same as removing them.
To remove a ranking rule, use the add or replace ranking rules route.

Default value

An array that contains the built-in ranking rules in the following order:

[
  "words", 
  "typo", 
  "proximity", 
  "attribute", 
  "sort",
  "exactness"
]

Example

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/ranking-rules'

client.index('movies').resetRankingRules()

client.index('movies').reset_ranking_rules()

$client->index('movies')->resetRankingRules();

client.index("movies").resetRankingRuleSettings();

client.index('movies').reset_ranking_rules

client.Index("movies").ResetRankingRules()

await client.Index("movies").ResetRankingRulesAsync();

let task: TaskInfo = client
  .index("movies")
  .reset_ranking_rules()
  .await
  .unwrap();

client.index("movies").resetRankingRules { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').resetRankingRules();

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.