synonyms

Type: boolean

Engine default: true

Parameter syntax

'synonyms' => true|false

synonyms: true|false

synonyms: true|false

'synonyms': True|False

synonyms = true|false

synonyms: Boolean = true|false

.Synonyms(true|false)

.setSynonyms(true|false)

opt.Synonyms(true|false)

synonyms = Some(true|false)

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

See code examples

About this parameter

Whether to take into account an index’s synonyms for a particular search.

This setting overrides the default query behavior, which is to use all defined synonyms on every search. By setting this to false, you are disabling synonyms for the given query. True is the engine default.

Examples

Do not take into account synonyms for the current search

Copy

1
2
3
$results = $index->search('query', [
  'synonyms' => false
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.synonyms, to: false)

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

Did you find this page helpful?

synonyms

About this parameter

Examples

Do not take into account synonyms for the current search

On this page