API Reference / API Parameters / customRanking

Feb. 26, 2019

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")
}

new JSONObject().put(
  "customRanking",
  new JSONArray()
    .put("asc(attribute1)")
    .put("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 setSettingsAsync SetSettings setSettings SetSettings setSettings

See code examples

About this parameter

Specifies the custom ranking criterion.

Each string must conform to the syntax asc(${attributeName}) or desc(${attributeName}) and specifies a (respectively) increasing or decreasing sort on an attribute. All sorts are applied in sequence by the tie-breaking algorithm in the order they are specified.

Modifiers:

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

Examples

Set a custom ranking

In this example we will sort by decreasing value of the popularity attribute, then in case of equality by increasing value of the price attribute

Copy

$index->setSettings([
  'customRanking' => [
    'desc(popularity)',
    'asc(price)'
  ]
]);

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    customRanking = Some(Seq(
      CustomRanking.desc("popularity"),
      CustomRanking.asc("price")
    ))
  )
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

customRanking

About this parameter

Modifiers:

Examples

Set a custom ranking

Did you find this page helpful?

On this page