View API Reference

Settings

Methods

API Method Description PHP Ruby JS Python iOS Android C# Java Go Scala name
Get settings

Get all settings of an index.

getSettings getSettings get_settings get_settings getSettings GetSettings getSettings getSettings getSettingsAsync GetSettings getSettings settings
Set settings

Set one or more settings of an index.

setSettings setSettings set_settings set_settings setSettings SetSettings setSettings setSettingsAsync SetSettings setSettings changeSettings

The scope of settings (and parameters)

Settings are set on the index and/or during a particular query. In both cases, they are sent to Algolia using parameters.

  • For the index, we use the set settings method.
  • For the search, we use the search method.

Importantly, each parameter has a scope (See API Parameters). There are 3 scopes:

settings

The setting can only be used in the set settings method. Meaning that it is not available as a search parameter.

Index settings are built directly into your index at indexing time, and they impact every search.

Individual queries can be parameterized. To do this, you pass search parameters to the search method. These parameters affect only those queries that use it. And there is not index default for them.

When applying both, you create a default/override logic: you set an index default using the set settings method that can be overriden by your search method.

Note that, if a setting or a parameter is not used, the system will apply an engine level default.

Example

Just to make it more concrete, here is an example of an index setting, where all queries performed on this index will use a queryType of prefixLast:

index.setSettings({
  queryType: 'prefixLast'
});

And here is a query that overrides that index setting with prefixAll:

index.search({
  query: 'query',
  queryType: 'prefixAll'
});

Categories

As you start fine-tuning Algolia, you will want to use more of its settings. Mastering these settings will enable you to get the best out of Algolia.

To help you navigate our list of settings, we’ve created the following setting categories:

For a full list of settings: