> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ranking

> Ranking criteria

export const Setting = ({type, default: defaultValue, defaultNote, scope, min, max, formerly}) => {
  const renderedDefault = defaultValue === '' ? '""' : defaultValue;
  const renderedNote = defaultNote ? `(${defaultNote})` : '';
  return <ul>
      <li><strong>Type:</strong> <code>{type}</code></li>
      <li><strong>Default:</strong> <code>{renderedDefault}</code>{renderedNote}</li>
      {min && <li><strong>Min:</strong> <code>{min}</code></li>}
      {max && <li><strong>Max:</strong> <code>{max}</code></li>}
      <li><strong>Scope:</strong> <a href="/doc/api-reference/api-parameters"><code>{scope}</code></a></li>
      {formerly && <li>
          <strong>Deprecated name:</strong> <code>{formerly}</code>
        </li>}
    </ul>;
};

<Setting type="list<string>" default="[&#x22;typo&#x22;, &#x22;geo&#x22;, &#x22;words&#x22;, &#x22;filters&#x22;, &#x22;proximity&#x22;, &#x22;attribute&#x22;, &#x22;exact&#x22;, &#x22;custom&#x22;]" scope="settings" />

This setting controls how Algolia sorts your results.
The tie-breaking algorithm sequentially applies [ranking criteria](/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)
in the order specified.

<Tip>
  You can change the order of the default criteria but you shouldn't.
  The [out-of-the-box ranking order](/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria) works for most uses.
  Before changing this parameter, consider running an [A/B test](/doc/guides/ab-testing/ab-test-implementation-checklist) to ensure your changes will positively affect results.
</Tip>

## Usage

* Attribute names are case-sensitive.
* Add `asc(attribute)` or `desc(attribute)` to the list to sort by attributes such as `price` or `popularity`.
* You can reorder or remove criteria to fine-tune ranking, but the default order works well for most situations.
* Ranking also depends on the order of attributes in [`searchableAttributes`](/doc/api-reference/api-parameters/searchableAttributes).

## Ranking criteria

<ParamField path="typo">
  Rank results by the fewest spelling mistakes.
</ParamField>

<ParamField path="geo">
  Rank results by increasing distance.
  This option only applies when performing a geographical search.
</ParamField>

<ParamField path="words">
  Rank results by the number of matching query words, starting with the most matches.
  Only applies when using [`optionalWords`](/doc/api-reference/api-parameters/optionalWords).
</ParamField>

<ParamField path="filters">
  Rank results by filter score.
  This option is essential when using [`optionalFilters`](/doc/api-reference/api-parameters/optionalFilters).
</ParamField>

<ParamField path="proximity">
  Rank results by how close the query words are to each other in the record.
</ParamField>

<ParamField path="attribute">
  Rank results based on the order of attributes defined in [`searchableAttributes`](/doc/api-reference/api-parameters/searchableAttributes).
</ParamField>

<ParamField path="exact">
  For single-word queries, follows the behavior defined by the [`exactOnSingleWordQuery`](/doc/api-reference/api-parameters/exactOnSingleWordQuery) setting.
  For multi-word queries, ranks by number of exact word matches.
</ParamField>

<ParamField path="custom">
  Rank results based on the values of attributes listed in [`customRanking`](/doc/api-reference/api-parameters/customRanking).
  If not included in `ranking`, the custom ranking criterion is ignored.
</ParamField>

## Modifiers

<ParamField path="asc">
  Sort in ascending order (lowest to highest).
</ParamField>

<ParamField path="desc">
  Sort in descending order (highest to lowest).
</ParamField>

## Examples

### Use the default ranking

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings
        {
          Ranking = new List<string>
          {
            "typo",
            "geo",
            "words",
            "filters",
            "attribute",
            "proximity",
            "exact",
            "custom",
          },
        }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          ranking: [
            "typo",
            "geo",
            "words",
            "filters",
            "attribute",
            "proximity",
            "exact",
            "custom",
          ],
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetRanking(
          []string{"typo", "geo", "words", "filters", "attribute", "proximity", "exact", "custom"})))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings(
        "INDEX_NAME",
        new IndexSettings().setRanking(Arrays.asList("typo", "geo", "words", "filters", "attribute", "proximity", "exact", "custom"))
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({
        indexName: 'theIndexName',
        indexSettings: { ranking: ['typo', 'geo', 'words', 'filters', 'attribute', 'proximity', 'exact', 'custom'] },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings =
            IndexSettings(
              ranking =
                listOf("typo", "geo", "words", "filters", "attribute", "proximity", "exact", "custom")
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['ranking' => [
              'typo',

              'geo',

              'words',

              'filters',

              'attribute',

              'proximity',

              'exact',

              'custom',
          ],
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "ranking": [
                  "typo",
                  "geo",
                  "words",
                  "filters",
                  "attribute",
                  "proximity",
                  "exact",
                  "custom",
              ],
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings(
        "INDEX_NAME",
        Algolia::Search::IndexSettings.new(
          ranking: ["typo", "geo", "words", "filters", "attribute", "proximity", "exact", "custom"]
        )
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            ranking = Some(Seq("typo", "geo", "words", "filters", "attribute", "proximity", "exact", "custom"))
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(ranking: [
              "typo",
              "geo",
              "words",
              "filters",
              "attribute",
              "proximity",
              "exact",
              "custom",
          ])
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings();
      settings.Ranking = new List
      {
          "typo",
          "geo",
          "words",
          "filters",
          "attribute",
          "proximity",
          "exact",
          "custom"
      };

      index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	Ranking: opt.Ranking(
      		"typo",
      		"geo",
      		"words",
      		"filters",
      		"attribute",
      		"proximity",
      		"exact",
      		"custom",
      	),
      })
      ```

      ```java Java theme={"system"}
      index.setSettings(
        new IndexSettings().setRanking(Arrays.asList(
          "typo",
          "geo",
          "words",
          "filters",
          "attribute",
          "proximity",
          "exact",
          "custom"
        ))
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .setSettings({
          ranking: [
            "typo",
            "geo",
            "words",
            "filters",
            "attribute",
            "proximity",
            "exact",
            "custom",
          ],
        })
        .then(() => {
          // done
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          ranking {
              +Typo
              +Geo
              +Words
              +Filters
              +Attribute
              +Proximity
              +Exact
              +Custom
          }
      }

      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->setSettings([
        'ranking' => [
          'typo',
          'geo',
          'words',
          'filters',
          'attribute',
          'proximity',
          'exact',
          'custom'
        ]
      ]);
      ```

      ```python Python theme={"system"}
      index.set_settings(
          {
              "ranking": [
                  "typo",
                  "geo",
                  "words",
                  "filters",
                  "attribute",
                  "proximity",
                  "exact",
                  "custom",
              ]
          }
      )
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          ranking: [
            "typo",
            "geo",
            "words",
            "filters",
            "attribute",
            "proximity",
            "exact",
            "custom"
          ]
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          ranking = Some(Seq(
            Ranking.typo,
            Ranking.geo,
            Ranking.words,
            Ranking.filters,
            Ranking.attribute,
            Ranking.proximity,
            Ranking.exact,
            Ranking.custom
          ))
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.ranking, to: [
          .typo,
          .geo,
          .words,
          .filters,
          .attribute,
          .proximity,
          .exact,
          .custom
        ])

      index.setSettings(settings) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>

### Sort by ascending price

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen>
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings
        {
          Ranking = new List<string>
          {
            "asc(price)",
            "typo",
            "geo",
            "words",
            "filters",
            "proximity",
            "attribute",
            "exact",
            "custom",
          },
        }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          ranking: [
            "asc(price)",
            "typo",
            "geo",
            "words",
            "filters",
            "proximity",
            "attribute",
            "exact",
            "custom",
          ],
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetRanking(
          []string{"asc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"})))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings(
        "INDEX_NAME",
        new IndexSettings().setRanking(
          Arrays.asList("asc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom")
        )
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({
        indexName: 'theIndexName',
        indexSettings: {
          ranking: ['asc(price)', 'typo', 'geo', 'words', 'filters', 'proximity', 'attribute', 'exact', 'custom'],
        },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings =
            IndexSettings(
              ranking =
                listOf(
                  "asc(price)",
                  "typo",
                  "geo",
                  "words",
                  "filters",
                  "proximity",
                  "attribute",
                  "exact",
                  "custom",
                )
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['ranking' => [
              'asc(price)',

              'typo',

              'geo',

              'words',

              'filters',

              'proximity',

              'attribute',

              'exact',

              'custom',
          ],
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "ranking": [
                  "asc(price)",
                  "typo",
                  "geo",
                  "words",
                  "filters",
                  "proximity",
                  "attribute",
                  "exact",
                  "custom",
              ],
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings(
        "INDEX_NAME",
        Algolia::Search::IndexSettings.new(
          ranking: ["asc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"]
        )
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            ranking =
              Some(Seq("asc(price)", "typo", "geo", "words", "filters", "proximity", "attribute", "exact", "custom"))
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(ranking: [
              "asc(price)",
              "typo",
              "geo",
              "words",
              "filters",
              "proximity",
              "attribute",
              "exact",
              "custom",
          ])
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings
      settings.Ranking = new List
      {
          "asc(price)",
          "typo",
          "geo",
          "words",
          "filters",
          "proximity",
          "attribute",
          "exact",
          "custom"
      };

      index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	Ranking: opt.Ranking(
      		"asc(price)",
      		"typo",
      		"geo",
      		"words",
      		"filters",
      		"proximity",
      		"attribute",
      		"exact",
      		"custom",
      	),
      })
      ```

      ```java Java theme={"system"}
      index.setSettings(
        new IndexSettings().setRanking(Arrays.asList(
          "asc(price)",
          "typo",
          "geo",
          "words",
          "filters",
          "proximity",
          "attribute",
          "exact",
          "custom"
        ))
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .setSettings({
          ranking: [
            "asc(price)",
            "typo",
            "geo",
            "words",
            "filters",
            "proximity",
            "attribute",
            "exact",
            "custom",
          ],
        })
        .then(() => {
          // done
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          ranking {
              +Asc("price")
              +Typo
              +Geo
              +Words
              +Filters
              +Proximity
              +Attribute
              +Exact
              +Custom
          }
      }

      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->setSettings([
        'ranking' => [
          'asc(price)',
          'typo',
          'geo',
          'words',
          'filters',
          'proximity',
          'attribute',
          'exact',
          'custom'
        ]
      ]);
      ```

      ```python Python theme={"system"}
      index.set_settings(
          {
              "ranking": [
                  "asc(price)",
                  "typo",
                  "geo",
                  "words",
                  "filters",
                  "proximity",
                  "attribute",
                  "exact",
                  "custom",
              ]
          }
      )
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          ranking: [
            "asc(price)",
            "typo",
            "geo",
            "words",
            "filters",
            "proximity",
            "attribute",
            "exact",
            "custom"
          ]
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          ranking = Some(Seq(
            Ranking.asc("price"),
            Ranking.typo,
            Ranking.geo,
            Ranking.words,
            Ranking.filters,
            Ranking.proximity,
            Ranking.attribute,
            Ranking.exact,
            Ranking.custom
          ))
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.ranking, to: [
          .asc("price"),
          .typo,
          .geo,
          .words,
          .filters,
          .proximity,
          .attribute,
          .exact,
          .custom
        ])

      index.setSettings(settings) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>