API Reference / API Parameters / removeWordsIfNoResults

Jan. 14, 2021

removeWordsIfNoResults

Type: string

Engine default: "none"

Parameter syntax

'removeWordsIfNoResults' => 'none'|'lastWords'|'firstWords'|'allOptional'

removeWordsIfNoResults: 'none'|'lastWords'|'firstWords'|'allOptional'

removeWordsIfNoResults: 'none'|'lastWords'|'firstWords'|'allOptional'

'removeWordsIfNoResults': 'none'|'lastWords'|'firstWords'|'allOptional'

removeWordsIfNoResults = .none|.lastWords|.firstWords|.allOptional

removeWordsIfNoResults: RemoveWordsIfNoResults = RemoveWordsIfNoResults.None
|  RemoveWordsIfNoResults.LastWords
|  RemoveWordsIfNoResults.FirstWords
|  RemoveWordsIfNoResults.AllOptional

new JSONObject()
  .put(
    "removeWordsIfNoResults",
    "none"|"lastWords"|"firstWords"|"allOptional"
  )

IndexSettings settings = new IndexSettings();
settings.RemoveWordsIfNoResults = "lastWords"|"firstWords"|"allOptional";

.setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_NONE)
                           RemoveWordsType.REMOVE_(LAST_WORDS)[#last-words]
                           RemoveWordsType.REMOVE_(FIRST_WORDS)[#first-words]
                           RemoveWordsType.REMOVE_ALLOPTIONAL

opt.RemoveWordsIfNoResults("none"|"lastWords"|"firstWords"|"allOptional")

removeWordsIfNoResults = Some("none"|"lastWords"|"firstWords"|"allOptional")

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 searchAsync, setSettingsAsync, browseAsync, searchForFacetValues 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

Selects a strategy to remove words from the query when it doesn’t match any hits.

The goal is to avoid empty results by progressively loosening the query until hits are matched. You can learn more about this technique, as well as caveats with non-alphanumeric characters, in our in-depth guide on removing words to improve results.

Options:

none: No specific processing is done when a query does not return any results (default behavior).
lastWords: When a query does not return any results, treat the last word as optional. The process is repeated with words N-1, N-2, etc. until there are results, or at most 5 words have been removed.
firstWords: When a query does not return any results, treat the first word as optional. The process is repeated with words 2, 3, etc. until there are results, or at most 5 words have been removed.
allOptional: When a query does not return any results, make a second attempt treating all words as optional. This is equivalent to transforming the implicit AND operator applied between query words to an OR.

Examples

Set default strategy to remove words from the query

Copy

1
2
3
4
5
6
$index->setSettings([
  'removeWordsIfNoResults' => 'none'
  // 'removeWordsIfNoResults' => 'lastWords'
  // 'removeWordsIfNoResults' => 'firstWords'
  // 'removeWordsIfNoResults' => 'allOptional'
]);

1
2
3
4
5
6
index.set_settings({
  removeWordsIfNoResults: 'none'
  # removeWordsIfNoResults: 'lastWords'
  # removeWordsIfNoResults: 'firstWords'
  # removeWordsIfNoResults: 'allOptional'
})

1
2
3
4
5
6
7
8
index.setSettings({
  removeWordsIfNoResults: 'none'
  // removeWordsIfNoResults: 'lastWords'
  // removeWordsIfNoResults: 'firstWords'
  // removeWordsIfNoResults: 'allOptional'
}).then(() => {
  // done
});

1
2
3
4
5
6
index.set_settings({
    'removeWordsIfNoResults': 'none'
    # 'removeWordsIfNoResults': 'lastWords'
    # 'removeWordsIfNoResults': 'firstWords'
    # 'removeWordsIfNoResults': 'allOptional'
})

1
2
3
4
5
6
7
8
9
10
11
let settings = Settings()
  .set(\.removeWordsIfNoResults, to: RemoveWordIfNoResults.none)
  //.set(\.removeWordsIfNoResults, to: .lastWords)
  //.set(\.removeWordsIfNoResults, to: .firstWords)
  //.set(\.removeWordsIfNoResults, to: .allOptional)

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

1
2
3
4
5
6
7
IndexSettings settings = new IndexSettings();
settings.RemoveWordsIfNoResults = "none";
// settings.RemoveWordsIfNoResults = "lastWords";
// settings.RemoveWordsIfNoResults = "firstWords";
// settings.RemoveWordsIfNoResults = "allOptional";

index.SetSettings(settings);

1
2
3
4
5
6
index.setSettings(
  new IndexSettings().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_NONE)
  // new IndexSettings().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_LAST_WORDS)
  // new IndexSettings().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_FIRST_WORDS)
  // new IndexSettings().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_ALLOPTIONAL)
);

1
2
3
4
5
6
7
8
res, err := index.SetSettings(search.Settings{
  RemoveWordsIfNoResults: opt.RemoveWordsIfNoResults(
    "none",
    // "lastWords",
    // "firstWords",
    // "allOptional",
  ),
})

1
2
3
4
5
6
7
8
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    removeWordsIfNoResults = Some("none")
    // removeWordsIfNoResults = Some("lastWords")
    // removeWordsIfNoResults = Some("firstWords")
    // removeWordsIfNoResults = Some("allOptional")
  )
}

1
2
3
4
5
6
7
8
val settings = settings {
    removeWordsIfNoResults = RemoveWordIfNoResults.None
    // removeWordsIfNoResults = RemoveWordIfNoResults.LastWords
    // removeWordsIfNoResults = RemoveWordIfNoResults.FirstWords
    // removeWordsIfNoResults = RemoveWordIfNoResults.AllOptional
}

index.setSettings(settings)

Override default strategy to remove words from the query for the current search

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'removeWordsIfNoResults' => 'lastWords'
  // 'removeWordsIfNoResults' => 'none'
  // 'removeWordsIfNoResults' => 'firstWords'
  // 'removeWordsIfNoResults' => 'allOptional'
]);

1
2
3
4
5
6
results = index.search('query', {
  removeWordsIfNoResults: 'lastWords'
  # removeWordsIfNoResults: 'none'
  # removeWordsIfNoResults: 'firstWords'
  # removeWordsIfNoResults: 'allOptional'
})

1
2
3
4
5
6
7
8
index.search('query', {
  removeWordsIfNoResults: 'lastWords'
  // removeWordsIfNoResults: 'none'
  // removeWordsIfNoResults: 'firstWords'
  // removeWordsIfNoResults: 'allOptional'
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
results = index.search('query', {
    'removeWordsIfNoResults': 'lastWords'
    # 'removeWordsIfNoResults': 'none'
    # 'removeWordsIfNoResults': 'firstWords'
    # 'removeWordsIfNoResults': 'allOptional'
})

1
2
3
4
5
6
7
8
9
10
11
let query = Query("query")
   .set(\.removeWordsIfNoResults, to: .lastWords)
 //.set(\.removeWordsIfNoResults, to: .none)
 //.set(\.removeWordsIfNoResults, to: .firstWords)
 //.set(\.removeWordsIfNoResults, to: .allOptional)

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

1
2
3
4
index.search(new Query("query").setRemoveStopWords(RemoveWordsIfNoResults.LAST_WORDS));
// index.search(new Query("query").setRemoveStopWords(RemoveWordsIfNoResults.FIRST_WORDS));
// index.search(new Query("query").setRemoveStopWords(RemoveWordsIfNoResults.NONE));
// index.search(new Query("query").setRemoveStopWords(RemoveWordsIfNoResults.ALL_OPTIONAL));

1
2
3
4
5
6
7
index.Search<T>(new Query("")
{
    RemoveWordsIfNoResults = "lastWords"
    // RemoveWordsIfNoResults = "none"
    // RemoveWordsIfNoResults = "firstWords"
    // RemoveWordsIfNoResults = "allOptional"
});

1
2
3
4
5
6
index.search(
  new Query().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_LAST_WORDS)
  // new Query().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_NONE)
  // new Query().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_FIRST_WORDS)
  // new Query().setRemoveWordsIfNoResults(RemoveWordsType.REMOVE_ALLOPTIONAL)
);

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    removeWordsIfNoResults = Some(RemoveWordsIfNoResults.lastWords)
    // removeWordsIfNoResults = Some(RemoveWordsIfNoResults.none)
    // removeWordsIfNoResults = Some(RemoveWordsIfNoResults.firstWords)
    // removeWordsIfNoResults = Some(RemoveWordsIfNoResults.allOptional)
  )
}

1
2
3
4
5
6
7
8
val query = query("query") {
    removeWordsIfNoResults = RemoveWordIfNoResults.LastWords
    // removeWordsIfNoResults = RemoveWordIfNoResults.None
    // removeWordsIfNoResults = RemoveWordIfNoResults.FirstWords
    // removeWordsIfNoResults = RemoveWordIfNoResults.AllOptional
}

index.search(query)

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

removeWordsIfNoResults

About this parameter

Options:

Examples

Set default strategy to remove words from the query

Override default strategy to remove words from the query for the current search

Did you find this page helpful?

On this page