decompoundQuery

Type: boolean

Engine default: true

Parameter syntax

'decompoundQuery' => true

'decompoundQuery': true

decompoundQuery: true

'decompoundQuery': True

decompoundQuery = true

decompoundQuery = true

DecompoundQuery = true

new IndexSettings().setDecompoundQuery(true);

opt.DecompoundQuery(true|false)

decompoundQuery = Some(true)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Splits compound words into constituent parts in the query.

For certain queryLanguages (German, Dutch, Finnish, Danish, Swedish, and Norwegian), compound word segmentation splits compound words into constituent parts.

If decompoundQuery is true, compound words in the query are split into constituent parts. This will increase the likelihood of finding relevant matches because Algolia will look for records that contain any of the word’s parts. For example, if users search for “schoolboeken” (Dutch for “school books”), Algolia looks for records that contain the words “schoolboeken”, “school”, and “boeken”. You should usually set decompoundQuery to true as it leads to better matching and relevance.
If decompoundQuery is false, compound words in the search query aren’t split. For example, if users search for “gartenstühle” (German for “garden chairs”), Algolia won’t look for records that contain the words “garten” and “stühle”. Set decompoundQuery to false to enforce exact matches for compound words. For example, for product names or legal terms.

Usage notes

Decompounding doesn’t work if words contain non-spacing mark Unicode characters. For example, Gartenstühle won’t be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
See also: decompoundedAttributes.

Examples

Enable splitting compound words by default

Copy

1
2
3
$index->setSettings(array(
  'decompoundQuery' => true,
));

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.decompoundQuery, to: true)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
IndexSettings settings = new IndexSettings
{
  DecompoundQuery = true
};

index.SetSettings(settings);

// Asynchronous
await index.SetSettings(settings);

1
2
3
4
5
IndexSettings setting = new IndexSettings().setDecompoundQuery(true);
// Synchronous
index.setSettings(setting);
// Asynchronous
index.setSettingsAsync(setting);

Enable splitting compound words for the current search