customRanking

Type: list of strings

Engine default: [] (no custom ranking)

Parameter syntax

'customRanking' => [
  'asc(attribute1)',
  'desc(attribute2)'
  ...
]

customRanking: [
  'asc(attribute1)',
  'desc(attribute2)'
]

customRanking: [
  'asc(attribute1)',
  'desc(attribute2)'
]

'customRanking': [
  'asc(attribute1)',
  'desc(attribute2)'
]

customRanking = [
  .asc("attribute1"),
  .desc("attribute2")
]

customRanking {
    +Asc("attribute1")
    +Desc("attribute2")
}

IndexSettings settings = new IndexSettings();
settings.CustomRanking = new List<string>
{
  "asc(attribute1)",
  "desc(attribute2)"
};

new IndexSettings().setCustomRanking(Arrays.asList(
  "asc(attribute1)",
  "desc(attribute2)"
))

opt.CustomRanking(
  "asc(attribute1)",
  "desc(attribute2)",
)

customRanking = Some(Seq(
  CustomRanking.asc("attribute1")
  CustomRanking.desc("attribute2"),
))

Can be used in these methods:
setSettings set_settings setSettings set_settings setSettings setSettings SetSettings setSettings SetSettings setSettings

See code examples

About this parameter

Specifies which attributes to assign to Algolia’s custom ranking criterion.

Custom ranking is used to:

Define a ranking of results using metrics that are important to you, such as popularity and date.
Only show the most relevant results rather than all results: this is called relevant sorting.

Before adding a custom ranking, test the impact in the dashboard. You should also consider planning and implementing A/B testing to ensure that it will positively affect your results.

Usage notes

Specify your custom ranking attributes as a list of strings. Each string must use the syntax: asc(<ATTRIBUTE>) or desc(<ATTRIBUTE>) to determine the ascending or descending sort order. The tie-breaking algorithm applies all custom ranking attributes in the specified sequence.

Modifiers

`asc`	Sort by increasing value of the attribute.
`desc`	Sort by decreasing value of the attribute.

Examples

Set a custom ranking

This example uses the setSettings method to apply a custom ranking. It sorts by the decreasing value of the popularity attribute, then if popularity is equal, by the increasing value of the price attribute.

Copy

1
2
3
4
5
6
$index->setSettings([
  'customRanking' => [
    'desc(popularity)',
    'asc(price)'
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
let settings = Settings()
  .set(\.customRanking, to: [
    .desc("popularity"),
    .asc("price")
  ])

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
IndexSettings settings = new IndexSettings();

settings.CustomRanking = new List<string>
{
    "desc(popularity)",
    "asc(price)"
};

index.SetSettings(settings);

1
2
3
4
5
6
7
8
client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    customRanking = Some(Seq(
      CustomRanking.desc("popularity"),
      CustomRanking.asc("price")
    ))
  )
}