Set an Index's Query Language

Most of Algolia’s textual matching is language agnostic: this means the matching and ranking processes are the same for every language. If a search textually matches a record, that record is returned. This approach ensures that Algolia works for any language without any extra customization.

However, there are circumstances where knowledge of the query language is important for accurate search. For example, by identifying your query language, you can treat plurals and singulars as equivalent. If your users search for “mice”, you most likely don’t want to treat the singular “mouse” as a typo.

Algolia has two main parameters that rely on query language:

1. ignorePlurals, which treats both the singular and plural of a word as a zero typo match.
2. removeStopWords, which prevents stop words from being processed as a part of the query. English stop words include “the”, “a”, “an”, “and”.

The language(s) that these parameters use (to determine stop words or plurals) can be set independently, or through the queryLanguages parameter.

If you don’t set queryLanguages, be careful when using ignorePlurals and removeStopWords. In this circumstance, setting either of these to true without passing a language causes Algolia to ignores plurals or removes stop words for every language. This can lead to strange or inaccurate search results.

Using the API

To set an index’s language through the API, you need to use the setSettings method.

In the below example, we set queryLanguages for the english index and set ignorePlurals to true. This means “mice” and “mouse” will be treated as equivalent.

1
2
3
4
$index->setSettings([
  'queryLanguages' => ['en'],
  'ignorePlurals' => true
]);

1
2
3
4
index.set_settings({
  queryLanguages: ['en'],
  ignorePlurals: true
})

1
2
3
4
5
6
index.setSettings({
  queryLanguages: ['en'],
  ignorePlurals: true
}).then(() => {
  // done
});

1
2
3
4
index.set_settings({
  'queryLanguages': ['en'],
  'ignorePlurals': True
})

1
2
3
4
index.setSettings([
  "queryLanguages": ["en"],
  "ignorePlurals": true
])

1
2
3
4
5
6
7
8
9
index.setSettings(
  new JSONObject()
    .put(
      "queryLanguages",
      new JSONArray()
        .put("en")
    )
    .put("ignorePlurals", true)
);

1
2
3
4
5
IndexSettings settings = new IndexSettings();
settings.QueryLanguages = new List<string> { "en" };
settings.IgnorePlurals = true;

index.SetSettings(settings);

1
2
3
4
5
index.setSettings(
  new IndexSettings()
    .setQueryLanguages(Collections.singletonList("en"))
    .setIgnorePlurals(IgnorePlurals.of(true))
);

1
2
3
4
res, err := index.SetSettings(search.Settings{
  QueryLanguages:  opt.QueryLanguages("en"),
  IgnorePlurals:   opt.IgnorePlurals(true),
})

1
2
3
4
5
6
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    queryLanguages = Some(QueryLanguages.list(Seq("en")),
    ignorePlurals = Some(IgnorePlurals.`true`)
  )
}

1
2
3
4
5
6
7
8
val settings = settings {
    queryLanguages {
        +English
    }
    ignorePlurals = IgnorePlurals.True
}

index.setSettings(settings)

Using the Dashboard

You can also set an index’s query language in your Algolia dashboard:

1. Go to your dashboard and select your index from the Indices tab.
2. Click on the Configuration tab, then the Language subsection.
3. Click Select one or more languages under the Query Languages section, and enter your desired language. You can enter as many languages as you want.
4. Don’t forget to save your changes.