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 their composing atoms in the query.

Compound words segmentation splits compound words into atoms to ensure a higher chance of finding relevant matches.

When true, it ensures that compound words are split in search queries. When false, all compound words remain whole. This applies for queries where queryLanguages is set to de, nl, fi, da, sv or no.

Usage notes

This parameter works alongside the queryLanguages setting and is complementary with decompoundedAttributes.
Most of the time, you should use this feature as it leads to better matching and relevance in the compatible languages.
List of supported languages : German, Dutch, Finnish, Danish, Swedish, and Norwegian.

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