stop_words.md

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 the stop-words list of an index.

Path Variables

Variable	Description
index_uid	The index UID

Example

Response: 200 Ok

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

Update 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

Response: 202 Accepted

{
  "updateId": 1
}

This updateId allows you to track the current update.

Reset 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

Response: 202 Accepted

{
  "updateId": 1
}

This updateId allows you to track the current update.