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

# ignorePlurals

> Whether to treat singular, plural, and inflected forms as equivalent

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="boolean | list<enum<string>>" default="false" scope="settings,search" />

The `ignorePlurals` parameter controls whether Algolia treats singular, plural, and other inflected forms as equivalent.\
For example, `"car"` matches `"cars"` and `"child"` matches `"children"`.

For more information, see [Ignoring plurals and other forms](/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations#ignore-plurals-and-other-alternative-forms).

## Options

<ParamField path="true">
  Treat plural and inflected forms as equivalent for all supported languages.
  If [`queryLanguages`](/doc/api-reference/api-parameters/queryLanguages) is set, only those languages are affected.
</ParamField>

<ParamField path="false">
  Plurals and other declensions will be treated as separate words.
</ParamField>

<ParamField path="list<enum<string>>">
  List of languages (as ISO 639-1 codes) for which plural and inflected forms should be treated as equivalent.
  Overrides any language(s) set in [`queryLanguages`](/doc/api-reference/api-parameters/queryLanguages).
  See the list of [supported languages](/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages).
</ParamField>

## Usage

* You should only turn on `ignorePlurals` for languages used in your data.
* If `ignorePlurals` is set to `true` without specifying `queryLanguages`,
  Algolia enables plural normalization for all supported languages.
  This may lead to unexpected matches.
  For example, the French word `"chair"` (meaning "flesh") may match `"chairs"` in English.

## Examples

### Set default query language and ignore plurals

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings
        {
          QueryLanguages = new List<SupportedLanguage> { Enum.Parse<SupportedLanguage>("Es") },
          IgnorePlurals = new IgnorePlurals(true),
        }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          queryLanguages: [
            SupportedLanguage.fromJson("es"),
          ],
          ignorePlurals: true,
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetQueryLanguages(
          []search.SupportedLanguage{search.SupportedLanguage("es")}).SetIgnorePlurals(search.BoolAsIgnorePlurals(true))))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings(
        "INDEX_NAME",
        new IndexSettings().setQueryLanguages(Arrays.asList(SupportedLanguage.ES)).setIgnorePlurals(IgnorePlurals.of(true))
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({
        indexName: 'theIndexName',
        indexSettings: { queryLanguages: ['es'], ignorePlurals: true },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings =
            IndexSettings(
              queryLanguages = listOf(SupportedLanguage.entries.first { it.value == "es" }),
              ignorePlurals = IgnorePlurals.of(true),
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['queryLanguages' => [
              'es',
          ],
              'ignorePlurals' => true,
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "queryLanguages": [
                  "es",
              ],
              "ignorePlurals": True,
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings(
        "INDEX_NAME",
        Algolia::Search::IndexSettings.new(query_languages: ["es"], ignore_plurals: true)
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            queryLanguages = Some(Seq(SupportedLanguage.withName("es"))),
            ignorePlurals = Some(IgnorePlurals(true))
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(
              ignorePlurals: SearchIgnorePlurals.bool(true),
              queryLanguages: [SearchSupportedLanguage.es]
          )
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings();
      settings.QueryLanguages = new List { "es" };
      settings.IgnorePlurals = true;

      index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	QueryLanguages: opt.QueryLanguages("es"),
      	IgnorePlurals:  opt.IgnorePlurals(true),
      })
      ```

      ```java Java theme={"system"}
      index.setSettings(
              new IndexSettings()
                      .setQueryLanguages(Collections.singletonList("es"))
                      .setIgnorePlurals(IgnorePlurals.of(true))
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .setSettings({
          queryLanguages: ["es"],
          ignorePlurals: true,
        })
        .then(() => {
          // done
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          queryLanguages {
              +Spanish
          }
          ignorePlurals = IgnorePlurals.True
      }

      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->setSettings([
        'queryLanguages' => ['es'],
        'ignorePlurals' => true
      ]);
      ```

      ```python Python theme={"system"}
      index.set_settings({"queryLanguages": ["es"], "ignorePlurals": True})
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          queryLanguages: ["es"],
          ignorePlurals: true
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          queryLanguages = Some(QueryLanguages.list(Seq("es")),
          ignorePlurals = Some(IgnorePlurals.`true`)
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.queryLanguages, to: [.spanish])
        .set(\.ignorePlurals, to: true)

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

### Override query language in search request

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen>
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SearchSingleIndexAsync<Hit>(
        "INDEX_NAME",
        new SearchParams(
          new SearchParamsObject
          {
            Query = "query",
            IgnorePlurals = new IgnorePlurals(
              new List<SupportedLanguage>
              {
                Enum.Parse<SupportedLanguage>("Ca"),
                Enum.Parse<SupportedLanguage>("Es"),
              }
            ),
          }
        )
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.searchSingleIndex(
        indexName: "INDEX_NAME",
        searchParams: SearchParamsObject(
          query: "query",
          ignorePlurals: [
            SupportedLanguage.fromJson("ca"),
            SupportedLanguage.fromJson("es"),
          ],
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
        "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
        search.NewEmptySearchParamsObject().SetQuery("query").SetIgnorePlurals(search.ArrayOfSupportedLanguageAsIgnorePlurals(
          []search.SupportedLanguage{search.SupportedLanguage("ca"), search.SupportedLanguage("es")})))))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      SearchResponse response = client.searchSingleIndex(
        "INDEX_NAME",
        new SearchParamsObject()
          .setQuery("query")
          .setIgnorePlurals(IgnorePlurals.of(Arrays.asList(SupportedLanguage.CA, SupportedLanguage.ES))),
        Hit.class
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.searchSingleIndex({
        indexName: 'indexName',
        searchParams: { query: 'query', ignorePlurals: ['ca', 'es'] },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams =
            SearchParamsObject(
              query = "query",
              ignorePlurals =
                IgnorePlurals.of(
                  listOf(
                    SupportedLanguage.entries.first { it.value == "ca" },
                    SupportedLanguage.entries.first { it.value == "es" },
                  )
                ),
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->searchSingleIndex(
          'INDEX_NAME',
          ['query' => 'query',
              'ignorePlurals' => [
                  'ca',

                  'es',
              ],
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.search_single_index(
          index_name="INDEX_NAME",
          search_params={
              "query": "query",
              "ignorePlurals": [
                  "ca",
                  "es",
              ],
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.search_single_index(
        "INDEX_NAME",
        Algolia::Search::SearchParamsObject.new(query: "query", ignore_plurals: ["ca", "es"])
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams = Some(
            SearchParamsObject(
              query = Some("query"),
              ignorePlurals = Some(IgnorePlurals(Seq(SupportedLanguage.withName("ca"), SupportedLanguage.withName("es"))))
            )
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response: SearchResponse<Hit> = try await client.searchSingleIndex(
          indexName: "INDEX_NAME",
          searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
              query: "query",
              ignorePlurals: SearchIgnorePlurals.arrayOfSearchSupportedLanguage([
                  SearchSupportedLanguage.ca,
                  SearchSupportedLanguage.es,
              ])
          ))
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      index.Search(new Query("")
      {
          IgnorePlurals = new List { "ca", "es"}
      });
      ```

      ```go Go theme={"system"}
      res, err := index.Search(
      	"query",
      	opt.IgnorePluralsFor("ca", "es"),
      )
      ```

      ```java Java theme={"system"}
      index.search(
        new Query("").setIgnorePlurals(IgnorePlurals.of(Arrays.asList(
          "ca",
          "es"
        )))
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .search("query", {
          ignorePlurals: ["ca", "es"],
        })
        .then(({ hits }) => {
          console.log(hits);
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val query = query("query") {
          ignorePlurals = IgnorePlurals.QueryLanguages(
              QueryLanguage.Spanish,
              QueryLanguage.Catalan
          )
      }

      index.search(query)
      ```

      ```php PHP theme={"system"}
      $results = $index->search('query', [
        'ignorePlurals' => ['ca', 'es']
      ]);
      ```

      ```python Python theme={"system"}
      results = index.search("query", {"ignorePlurals": ["ca", "es"]})
      ```

      ```ruby Ruby theme={"system"}
      results = index.search(
        "query",
        {
          ignorePlurals: ["ca", "es"]
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        search into "myIndex" query Query(
          query = Some("query"),
          ignorePlurals = Some(ignorePlurals.list(Seq("ca", "es")))
        )
      }
      ```

      ```swift Swift theme={"system"}
      let query = Query("query")
        .set(\.ignorePlurals, to: [.spanish, .catalan])

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