Stop-words

Child route of the settings route.

The stop-words route lets you add a list of words that will be ignored in search queries. So if you add the as a stop word and you make a search on the mask you will only have matching documents with mask.

Stop-words can also be updated directly through the global settings route along with the other settings.

Learn more about stop words

NOTE

Updating the settings means overwriting the default settings of MeiliSearch. You can reset to default values using the DELETE routes.

Get stop-words

GET

/indexes/:index_uid/settings/stop-words

Get the stop-words list of an index.

Path variables

Variable	Description
index_uid	The index UID

Example

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/stop-words'

client.index('movies').getStopWords()

client.index('movies').get_stop_words()

$client->index('movies')->getStopWords();

index.stop_words

client.Settings("movies").GetStopWords()

let stop_words: Vec<String> = movies.get_stop_words().await.unwrap();

Response: 200 Ok

["of", "the", "to"]

Update stop-words

POST

/indexes/:index_uid/settings/stop-words

Update the list of stop-words of an index.

Path variables

Variable	Description
index_uid	The index UID

Body

An array of strings that contains the stop-words.

If a list of stop-words already exists it will be overwritten (replaced).

More information about the body.

Example

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings/stop-words' \
  --data '["the", "of", "to"]'

client.index('movies').updateStopWords(['of', 'the', 'to'])

client.index('movies').update_stop_words(['of', 'the', 'to'])

$client->index('movies')->updateStopWords(['the', 'of', 'to']);

index.update_stop_words(['of', 'the', 'to'])

stopWords := []string{"of", "the", "to"}
client.Settings("movies").UpdateStopWords(stopWords)

let stop_words = ["of", "the", "to"];
let progress: Progress = movies.set_stop_words(&stop_words).await.unwrap();

Response: 202 Accepted

{
  "updateId": 1
}

This updateId allows you to track the current update.

Reset stop-words

DELETE

/indexes/:index_uid/settings/stop-words

Reset the list of stop-words of an index to its default value.

Default value

Empty array: []

Path variables

Variable	Description
index_uid	The index UID

Example

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/stop-words'

client.index('movies').resetStopWords()

client.index('movies').reset_stop_words()

$client->index('movies')->resetStopWords();

index.reset_stop_words

client.Settings(indexUID).ResetStopWords()

let progress: Progress = movies.reset_stop_words().await.unwrap();

Response: 202 Accepted

{
  "updateId": 1
}

This updateId allows you to track the current update.