Sort by attribute

Replica indices

Think of a replica index as a duplicate of your primary index but with a different sorting of results. Choose from two types of replicas: standard or virtual:

Use a standard replica for exhaustive sorting. This method sorts results by the chosen attribute.
Use a virtual replica for relevant sorting. This method prioritizes relevant results while still incorporating the sorting preference for the chosen attribute.

Configure an attribute for sorting in the Algolia dashboard

Create a replica index.
Refresh the dashboard page in your browser.
Select the replica index.
On the Configuration tab, go to Relevant sort or Ranking and Sorting. You’ll see either option, depending on the type of replica you want to configure (virtual or standard).
Click +Add a sort attribute or +Add sort-by attribute
Type in the name of the attribute you want to sort. Be careful here: Algolia doesn’t check to see if what you type matches the name of an attribute in the index.
Determine the sort direction (Ascending or Descending).
Review and save your changes.

Configure an attribute for sorting with the API

Create a replica index.
Update the ranking parameter of the replica index with the setSettings method.

Update user interface

To let users select between different rankings in your user interface, you also need to update it—for example, by providing a sort-by widget.

Example: relevant sort by `price`

This example applies relevant sorting to a virtual replica.

Copy

1
2
3
4
var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { CustomRanking = new List<string> { "desc(price)" } }
);

1
2
3
4
5
6
7
8
final response = await client.setSettings(
  indexName: "ALGOLIA_INDEX_NAME",
  indexSettings: IndexSettings(
    customRanking: [
      "desc(price)",
    ],
  ),
);

1
2
3
4
5
6
7
8
response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "ALGOLIA_INDEX_NAME",
  search.NewEmptyIndexSettings().SetCustomRanking(
    []string{"desc(price)"})))
if err != nil {
  // handle the eventual error
  panic(err)
}

1
2
3
4
5
6
7
8
response = client.set_settings(
    index_name="ALGOLIA_INDEX_NAME",
    index_settings={
        "customRanking": [
            "desc(price)",
        ],
    },
)

1
2
3
4
5
6
7
8
9
val response = Await.result(
  client.setSettings(
    indexName = "ALGOLIA_INDEX_NAME",
    indexSettings = IndexSettings(
      customRanking = Some(Seq("desc(price)"))
    )
  ),
  Duration(100, "sec")
)

For virtual replicas, you only need to include the customRanking attribute used for sorting: price.

Example: exhaustive sort by `price`

This example applies exhaustive sorting to a standard replica.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings
  {
    Ranking = new List<string>
    {
      "desc(price)",
      "typo",
      "geo",
      "words",
      "filters",
      "proximity",
      "attribute",
      "exact",
      "custom",
    },
  }
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
final response = await client.setSettings(
  indexName: "ALGOLIA_INDEX_NAME",
  indexSettings: IndexSettings(
    ranking: [
      "desc(price)",
      "typo",
      "geo",
      "words",
      "filters",
      "proximity",
      "attribute",
      "exact",
      "custom",
    ],
  ),
);

1
2
3
4
5
6
7
8
response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "ALGOLIA_INDEX_NAME",
  search.NewEmptyIndexSettings().SetRanking(
    []string{"desc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"})))
if err != nil {
  // handle the eventual error
  panic(err)
}

1
2
3
4
5
client.setSettings(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings()
    .setRanking(Arrays.asList("desc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"))
);

1
2
3
4
5
6
const response = await client.setSettings({
  indexName: 'theIndexName',
  indexSettings: {
    ranking: ['desc(price)', 'typo', 'geo', 'words', 'filters', 'proximity', 'attribute', 'exact', 'custom'],
  },
});

1
2
3
4
5
6
var response = client.setSettings(
  indexName = "ALGOLIA_INDEX_NAME",
  indexSettings = IndexSettings(
    ranking = listOf("desc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"),
  ),
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$response = $client->setSettings(
    'ALGOLIA_INDEX_NAME',
    ['ranking' => [
        'desc(price)',

        'typo',

        'geo',

        'words',

        'filters',

        'proximity',

        'attribute',

        'exact',

        'custom',
    ],
    ],
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
response = client.set_settings(
    index_name="ALGOLIA_INDEX_NAME",
    index_settings={
        "ranking": [
            "desc(price)",
            "typo",
            "geo",
            "words",
            "filters",
            "proximity",
            "attribute",
            "exact",
            "custom",
        ],
    },
)

1
2
3
4
5
6
response = client.set_settings(
  "ALGOLIA_INDEX_NAME",
  Algolia::Search::IndexSettings.new(
    ranking: ["desc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"]
  )
)

1
2
3
4
5
6
7
8
9
10
val response = Await.result(
  client.setSettings(
    indexName = "ALGOLIA_INDEX_NAME",
    indexSettings = IndexSettings(
      ranking =
        Some(Seq("desc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"))
    )
  ),
  Duration(100, "sec")
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
let response = try await client.setSettings(
    indexName: "ALGOLIA_INDEX_NAME",
    indexSettings: IndexSettings(ranking: [
        "desc(price)",
        "typo",
        "geo",
        "words",
        "filters",
        "proximity",
        "attribute",
        "exact",
        "custom",
    ])
)

For standard replicas, you need to provide all ranking attributes.

Did you find this page helpful?

Sort by attribute

On this page

Replica indices

Configure an attribute for sorting in the Algolia dashboard

Configure an attribute for sorting with the API

Update user interface

Example: relevant sort by `price`

Example: exhaustive sort by `price`

On this page

Sort by attribute

On this page

Replica indices

Configure an attribute for sorting in the Algolia dashboard

Configure an attribute for sorting with the API

Update user interface

Example: relevant sort by price

Example: exhaustive sort by price

On this page

Example: relevant sort by `price`

Example: exhaustive sort by `price`