Settings

This page describes all the settings available in MeiliSearch and how to configure them.

Variable	Description	Default value
displayedAttributes	Fields displayed in the returned documents	All attributes found in the documents
distinctAttribute	Search returns documents with distinct (different) values of the given field	`null`
filterableAttributes	List of attributes that can be used for filtering	`null`
rankingRules	List of ranking rules sorted by order of importance	A list of ordered built-in ranking rules
searchableAttributes	Fields in which to search for matching query words sorted by order of importance	All attributes found in the documents
sortableAttributes	[Strings]	Attributes to use when sorting search results
stopWords	List of words ignored by MeiliSearch when present in search queries	`[]`
synonyms	List of associated words treated similarly	`{}`

Displayed attributes

The fields whose attributes are added to the displayed-attributes list are contained in each matching document.

Documents returned upon search contain only displayed fields.

displayedAttributes=[<String>, <String>, ...]

[<String>, <String>, ...] (Array of strings, defaults to all attributes found in the documents)

An array of strings that contains attributes of an index to display.

Learn more about displayed attributes

Example

By adding the following settings, documents returned upon search will contain the fields title, description, genre and release_date.

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "displayedAttributes": [
          "title",
          "description",
          "genre",
          "release_date"
      ]
  }'

client.index('movies').updateSettings({
  displayedAttributes: [
    'title',
    'description',
    'genre',
    'release_date',
  ]
})

client.index('movies').update_settings({
  'displayedAttributes': [
    'title',
    'description',
    'genre',
    'release_date'
  ]
})

$client->index('movies')->updateDisplayedAttributes([
  'title',
  'description',
  'genre',
  'release_date'
]);

Settings settings = new Settings();
settings.setDisplayedAttributes(new String[]
{
  "title",
  "description",
  "genre",
  "release_date"
});
client.index("movies").updateSettings(settings);

client.index('movies').update_settings({
  displayed_attributes: [
    'title',
    'description',
    'genre',
    'release_date'
  ]
})

displayedAttributes := []string{
  "title",
  "description",
  "genre",
  "release_date",
}
client.Index("movies").UpdateDisplayedAttributes(&displayedAttributes)

let displayed_attributes = [
  "title",
  "description",
  "genre",
  "release_date"
];
let progress: Progress = movies.set_displayed_attributes(&displayed_attributes).await.unwrap();

let displayedAttributes: [String] = [
    "title",
    "description",
    "poster",
    "release_date",
    "rank"
]
client.index("movies").updateDisplayedAttributes(displayedAttributes) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateSettings(IndexSettings(
    displayedAttributes: ['title', 'description', 'genre', 'release_date']));

Distinct attribute

The value of a field whose attribute is set as a distinct attribute will always be unique in the returned documents.

distinctAttribute=<String>

<String> (String, defaults to null)

The field name.

Learn more about the distinct attribute

Example

Suppose you have an e-commerce dataset. For an index that contains information about jackets, you may have several identical items in different variations (color or size).

As shown below, you have 2 documents that contain information about the same jacket. One of the jackets is brown and the other one is black.

[
  {
    "id": 1,
    "description": "Leather jacket",
    "brand": "Lee jeans",
    "color": "brown",
    "product_id": "123456"
  },
  {
    "id": 2,
    "description": "Leather jacket",
    "brand": "Lee jeans",
    "color": "black",
    "product_id": "123456"
  }
]

You may want to ignore the different colors of an item. To do so, you can set product_id as a distinctAttribute.

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/jackets/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "distinctAttribute": "product_id"
  }

client.index('movies').updateSettings({
  distinctAttribute: 'product_id'
})

client.index('jackets').update_settings({
  'distinctAttribute': 'product_id'
})

$client->index('jackets')->updateDistinctAttribute('product_id');

Settings settings = new Settings();
settings.setDistinctAttribute("product_id");
client.index("jackets").updateSettings(settings);

client.index('jackets').update_distinct_attribute('product_id')

client.Index("jackets").UpdateDistinctAttribute("product_id")

let jackets: Index = client.get_index("jackets").await.unwrap();
let progress: Progress = jackets.set_distinct_attribute("product_id").await.unwrap();

client.index("movies").updateDistinctAttribute("product_id") { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client
    .index('jackets')
    .updateSettings(IndexSettings(distinctAttribute: 'product_id'));

With the settings in the example above, only one of the two documents will be returned if you search Lee leather jacket.

Filterable attributes

List of attributes that can be used for filtering and faceted search.

By default, filterableAttributes is an empty array. It expects an array of attributes whose corresponding values are either numbers or strings. null fields or fields that contain empty arrays are silently ignored, but an error will be thrown if the field’s value is an object.

TIP

Configuring filterableAttributes is necessary in order to use the filter search parameter.

Learn more about filtering and faceted search in our dedicated guide.

Example

To be able to filter search results on director and genres in a movie database, you must first add these attributes to the filterableAttributes list:

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "filterableAttributes": [
          "director",
          "genres"
      ]
  }'

client.index('movies')
  .updateFilterableAttributes([
    'director',
    'genres'
  ])

client.index('movies').update_filterable_attributes([
    'director',
    'genres',
])

$client->index('movies')->updateFilterableAttributes(['director', 'genres']);

Settings settings = new Settings();
settings.setFilterableAttributes(new String[] {"director", "genres"});
client.index("movies").updateSettings(settings);

client.index('movies').update_filterable_attributes([
  'director',
  'genres'
])

resp, err := client.Index("movies").UpdateFilterableAttributes(&[]string{
  "director",
  "genres",
})

let progress: Progress = movies.set_filterable_attributes(["director", "genres"]).await.unwrap();

client.index("movies").updateFilterableAttributes(["genre", "director"]) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateFilterableAttributes([
  'director',
  'genres',
]);

Ranking rules

Built-in ranking rules that ensure relevancy in search results. Ranking rules are applied in a default order which can be changed in the settings. You can add or remove rules and change their order of importance.

rankingRules=[<String>, <String>, ...]

[<String>, <String>, ...] (Array of strings, see default value below)

An array of strings that contains the ranking rules sorted by order of importance (arranged from the most important rule to the least important rule).

Default value (the ranking rules in the default order):

[
  "words", 
  "typo", 
  "proximity", 
  "attribute", 
  "sort",
  "exactness"
]

Read this guide to know more about what each ranking rules does

Custom ranking rule

You can add a custom ranking rule anywhere in the list of ranking rules. A custom ranking rule is composed of an attribute and an ascending or descending order. The attribute must have a numeric value in the documents.

WARNING

If some documents do not contain the attribute defined in a custom ranking rule, the application of the ranking rule is undefined and the search results might not be sorted as you expected.

We recommend that all your documents contain any attribute used in a custom ranking rule. For example, if you set the custom ranking rule desc(year), make sure that all your documents contain the attribute year.

Example

To add your ranking rules to the settings, send:

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "rankingRules": [
          "words",
          "typo",
          "proximity",
          "attribute",
          "sort",
          "exactness",
          "release_date:asc",
          "rank:desc"
      ]
  }'

client.index('movies').updateSettings({
  rankingRules: [
      'words',
      'typo',
      'proximity',
      'attribute',
      'sort',
      'exactness',
      'release_date:asc',
      'rank:desc'
  ]
})

client.index('movies').update_settings({
  'rankingRules': [
      'words',
      'typo',
      'proximity',
      'attribute',
      'sort',
      'exactness',
      'release_date:asc',
      'rank:desc'
  ]
})

$client->index('movies')->updateRankingRules([
  'words',
  'typo',
  'proximity',
  'attribute',
  'sort',
  'exactness',
  'release_date:asc',
  'rank:desc'
]);

Settings settings = new Settings();
settings.setRankingRules(new String[]
{
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank_desc"
});
client.index("movies").updateSettings(settings);

client.index('movies').update_settings({
  ranking_rules: [
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:asc',
    'rank:desc'
  ]
})

rankingRules := []string{
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank:desc",
}
client.Index("movies").UpdateRankingRules(&rankingRules)

let ranking_rules = [
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:asc",
  "rank:desc",
];
let progress: Progress = movies.set_ranking_rules(&ranking_rules).await.unwrap();

let rankingRules: [String] = [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
]
client.index("movies").updateRankingRules(rankingRules) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateSettings(IndexSettings(rankingRules: [
      'words',
      'typo',
      'proximity',
      'attribute',
      'sort',
      'exactness',
      'release_date:asc',
      'rank:desc'
    ]));

With the settings in the example above, documents will be sorted by number of typos first. If too many documents have the same number of typos, the words rule will be applied. This operation will be repeated with the next rules until the requested number of documents has been reached (default: 20).

Searchable attributes

The content of the fields whose attributes are added to the searchable-attributes list are searched for matching query words.

searchableAttributes=[<String>, <String>, ...]

[<String>, <String>, ...] (Array of strings, defaults to all attributes found in the documents)

An array of strings that contains searchable attributes ordered by importance (arranged from the most important attribute to the least important attribute).

Learn more about searchable attributes

Example

By adding the following settings, the fields title, description and genre will be searched.

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "searchableAttributes": [
          "title",
          "description",
          "genre"
      ]
  }'

client.index('movies').updateSettings({
  searchableAttributes: [
    'title',
    'description',
    'genre'
  ]
})

client.index('movies').update_settings({
  'searchableAttributes': [
    'title',
    'description',
    'genre'
  ]
})

$client->index('movies')->updateSearchableAttributes([
  'title',
  'description',
  'genre'
]);

Settings settings = new Settings();
settings.setSearchableAttributes(new String[]
{
  "title",
  "description",
  "genre"
});
client.index("movies").updateSettings(settings);

client.index('movies').update_settings({
  searchable_attributes: [
    'title',
    'description',
    'genre'
  ]
})

searchableAttributes := []string{
  "title",
  "description",
  "genre",
}
client.Index("movies").UpdateSearchableAttributes(&searchableAttributes)

let searchable_attributes = [
  "title",
  "description",
  "genre"
];
let progress: Progress = movies.set_searchable_attributes(&searchable_attributes).await.unwrap();

let searchableAttributes: [String] = [
    "uid",
    "movie_id",
    "title",
    "description",
    "poster",
    "release_date",
    "rank"
]
client.index("movies").updateSearchableAttributes(searchableAttributes) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateSettings(
    IndexSettings(searchableAttributes: ['title', 'description', 'genre']));

Sortable attributes

List of attributes that can be used for sorting.

By default, sortableAttributes is an empty array. It expects an array of attributes whose corresponding values are either numbers or strings. null fields or fields that contain empty arrays are silently ignored, but an error will be thrown if the field’s value is an object.

TIP

Configuring sortableAttributes is necessary in order to use the sort search parameter.

Learn more about sorting in our dedicated guide.

Example

To be able to sort search results according to the attributes price and author in a webshop, you must first add them to the sortableAttributes list:

No example found

Stop words

A set of words defined for an index. Because some words neither add semantic value nor context, you may want to ignore them from your search. Stop words are ignored during search.

stopWords=[<String>, <String>, ...]

[<String>, <String>, ...] (Array of strings, defaults to [])

An array of strings that contains the stop words.

Learn more about stop words

Example

To add the, a and an to the stop words list, send:

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "stopWords": [
          "the",
          "a",
          "an"
      ]
  }'

client.index('movies').updateSettings({
  stopWords: [
    'the',
    'a',
    'an'
  ]
})

client.index('movies').update_settings({
  'stopWords': [
      'the',
      'a',
      'an'
  ],
})

$client->index('movies')->updateStopWords(['the', 'a', 'an']);

Settings settings = new Settings();
settings.setStopWords(new String[]
{
  "the",
  "a",
  "an"
});
client.index("movies").updateSettings(settings);

client.index('movies').update_settings({
  stop_words: [
    'the',
    'a',
    'an'
  ]
})

stopWords := []string{"the", "a", "an"}
client.Index("movies").UpdateStopWords(&stopWords)

let progress: Progress = movies.set_stop_words(["the", "a", "an"]).await.unwrap();

let stopWords: [String] = [
    "the",
    "a",
    "an"
]
client.index("movies").updateStopWords(stopWords) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client
    .index('movies')
    .updateSettings(IndexSettings(stopWords: ['the', 'a', 'an']));

With the settings in the example above, the, a and an are now ignored by the sorting algorithm if they are present in search queries.

Suppose you would like to search the mask in a movie database. Since the is ignored during search, MeiliSearch will look for every movie containing mask and not the millions ones containing the. the is a less relevant term than mask and also a very frequent word in English. By adding the to the stop words list, MeiliSearch will ignore this word, and thus be faster to answer without losing in relevancy.

Synonyms

A set of words defined for an index. Synonyms are different words that have the same meaning, and thus are treated similarly. If either of the associated words is searched, the same results will be displayed.

synonyms=<Object>

<Object> (Object, defaults to {}) : { <String>: [<String>, <String>, ...], ... }

An object that contains words with a list of their associated synonyms. Synonym strings are normalized.

Learn more about synonyms

Example

Suppose you have an e-commerce dataset. For an index that contains information about tops, you decide to create synonyms for sweater and jumper since these two items are very similar.

cURL

Python

PHP

Java

Ruby

Rust

Swift

Dart

curl \
  -X POST 'http://localhost:7700/indexes/tops/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
      "synonyms": {
          "sweater": ["jumper"],
          "jumper": ["sweater"]
      }
  }'

client.index('tops').updateSettings({
  synonyms: {
    sweater: ['jumper'],
    jumper: ['sweater']
})

client.index('tops').update_settings({
  'synonyms': {
    sweater: ['jumper'],
    jumper: ['sweater']
  },
})

$client->index('tops')->updateSynonyms(['sweater' => ['jumper'], 'jumper' => ['sweater']]);

HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
synonyms.put("sweater", new String[] {"jumper"});
synonyms.put("jumper", new String[] {"sweater"});
settings.setSynonyms(synonyms);
client.index("movies").updateSynonyms(synonyms);

client.index('tops').update_settings({
  synonyms: {
    sweater: ['jumper'],
    jumper: ['sweater']
  }
})

synonyms := map[string][]string{
  "sweater": []string{"jumper"},
  "jumper":  []string{"sweater"},
}
client.Index("tops").UpdateSynonyms(&synonyms)

let mut synonyms = HashMap::new();
synonyms.insert(String::from("sweater"), vec![String::from("jumper")]);
synonyms.insert(String::from("jumper"), vec![String::from("sweater")]);
let tops: Index = client.get_index("tops").await.unwrap();
let progress: Progress = tops.set_synonyms(&synonyms).await.unwrap();

let synonyms: [String: [String]] = [
    "sweater": ["jumper"],
    "jumper": ["sweater"]
]
client.index("tops").updateSynonyms(synonyms) { (result: Result<Update, Swift.Error>) in
    switch result {
    case .success(let update):
        print(update)
    case .failure(let error):
        print(error)
    }
}

await client.index('tops').updateSettings(IndexSettings(synonyms: {
      'sweater': ['jumper'],
      'jumper': ['sweater']
    }));

By doing so, when searching for black sweater, results for black jumper will also be returned.