# All settings

The /settings route allows you to customize search settings for the given index. It is possible to modify all of an index's settings at once using the update settings endpoint, or modify each one individually using the child routes.

These are the reference pages for the child routes:

To learn more about settings, refer to our dedicated guide.

WARNING

When you update a setting, you overwrite its default value. Use the DELETE route to reset any setting to its original value.

# Get settings

GET

/indexes/{index_uid}/settings

Get the settings of an index. The index uid is required.

Learn more about the settings.

# Response body

Variable	Type	Description	Default value
displayedAttributes	[Strings]	Fields displayed in the returned documents	`["*"]` (all attributes)
distinctAttribute	String	Search returns documents with distinct (different) values of the given field	`null`
faceting	Object	Faceting settings	`{}`
filterableAttributes	[Strings]	Attributes to use as filters and facets	`[]`
pagination	Object	Pagination settings	`{}`
rankingRules	[Strings]	List of ranking rules sorted by order of importance	A list of ordered built-in ranking rules
searchableAttributes	[Strings]	Fields in which to search for matching query words sorted by order of importance	`["*"]` (all attributes)
sortableAttributes	[Strings]	Attributes to use when sorting search results	`[]`
stopWords	[Strings]	List of words ignored by Meilisearch when present in search queries	`[]`
synonyms	Object	List of associated words treated similarly	`{}`
typoTolerance	Object	Typo tolerance settings	`{}`

Learn more about the settings in this guide.

# Example

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

# Response: `200 Ok`

List the settings.

{
  "rankingRules": [
    "typo",
    "words",
    "proximity",
    "attribute",
    "words",
    "exactness",
    "desc(release_date)"
  ],
  "filterableAttributes": [
    "genres"
  ],
  "distinctAttribute": null,
  "searchableAttributes": [
    "title",
    "overview",
    "genres"
  ],
  "displayedAttributes": [
    "title",
    "overview",
    "genres",
    "release_date"
  ],
  "stopWords": null,
  "synonyms": {
    "wolverine": [
      "xmen",
      "logan"
    ],
    "logan": [
      "wolverine",
      "xmen"
    ]
  },
  "typoTolerance": {
    "enabled": true, 
    "minWordSizeForTypos": {
        "oneTypo": 5,
        "twoTypos": 10
      },
    "disableOnWords": [],
    "disableOnAttributes": []
  },
  "pagination": {
    "maxTotalHits": 1000
  },
  "faceting": {
    "maxValuesPerFacet": 100
  }
}

# Update settings

PATCH

/indexes/{index_uid}/settings

Update the settings of an index. The index uid is required.

Passing null to an index setting will reset it to its default value.

Updates in the settings route are partial. This means that any parameters not provided in the body will be left unchanged.

If the provided index does not exist, it will be created.

Learn more about the settings in this guide.

# Body

Variable	Type	Description	Default value
displayedAttributes	[Strings]	Fields displayed in the returned documents	`["*"]` (all attributes)
distinctAttribute	String	Search returns documents with distinct (different) values of the given field	`null`
faceting	Object	Faceting settings	`{}`
filterableAttributes	[Strings]	Attributes to use as filters and facets	`[]`
pagination	Object	Pagination settings	`{}`
rankingRules	[Strings]	List of ranking rules sorted by order of importance	A list of ordered built-in ranking rules
searchableAttributes	[Strings]	Fields in which to search for matching query words sorted by order of importance	`["*"]` (all attributes)
sortableAttributes	[Strings]	Attributes to use when sorting search results	`[]`
stopWords	[Strings]	List of words ignored by Meilisearch when present in search queries	`[]`
synonyms	Object	List of associated words treated similarly	`{}`
typoTolerance	Object	Typo tolerance settings	`{}`

# Example

curl \
  -X PATCH 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "rankingRules": [
      "words",
      "typo",
      "proximity",
      "attribute",
      "sort",
      "exactness",
      "release_date:desc",
      "rank:desc"
    ],
    "distinctAttribute": "movie_id",
    "searchableAttributes": [
      "title",
      "overview",
      "genres"
    ],
    "displayedAttributes": [
      "title",
      "overview",
      "genres",
      "release_date"
    ],
    "stopWords": [
      "the",
      "a",
      "an"
    ],
    "sortableAttributes": [
      "title",
      "release_date"
    ],
    "synonyms": {
      "wolverine": [
        "xmen",
        "logan"
    ],
      "logan": ["wolverine"]
    },
    "typoTolerance": {
      "minWordSizeForTypos": {
        "oneTypo": 8,
        "twoTypos": 10
      },
      "disableOnAttributes": ["title"]
    },
    "pagination": {
      "maxTotalHits": 5000
    },
    "faceting": {
      "maxValuesPerFacet": 200
    }
  }'

client.index('movies').updateSettings({
    rankingRules: [
        'words',
        'typo',
        'proximity',
        'attribute',
        'sort',
        'exactness',
        'release_date:desc',
        'rank:desc'
    ],
    distinctAttribute: 'movie_id',
    searchableAttributes: [
        'title',
        'overview',
        'genres'
    ],
    displayedAttributes: [
        'title',
        'overview',
        'genres'
        'release_date'
    ],
    stopWords: [
        'the',
        'a',
        'an'
    ],
    sortableAttributes: [
      'title',
      'release_date'
    ],
    synonyms: {
        'wolverine': ['xmen', 'logan'],
        'logan': ['wolverine']
    },
    typoTolerance: {
        'minWordSizeForTypos': {
            'oneTypo': 8,
            'twoTypos': 10
        },
        'disableOnAttributes': [
            'title'
        ]
    },
    pagination: {
        maxTotalHits: 5000
    },
    faceting: {
        maxValuesPerFacet: 200
    }
})

client.index('movies').update_settings({
  'rankingRules': [
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:desc',
    'rank:desc'
  ],
  'distinctAttribute': 'movie_id',
  'searchableAttributes': [
    'title',
    'overview',
    'genres'
  ],
  'displayedAttributes': [
    'title',
    'overview',
    'genres',
    'release_date'
  ],
  'sortableAttributes': [
    'title',
    'release_date'
  ],
  'stopWords': [
    'the',
    'a',
    'an'
  ],
  'synonyms': {
    'wolverine': ['xmen', 'logan'],
    'logan': ['wolverine']
  },
  'typoTolerance': {
    'minWordSizeForTypos': {
        'oneTypo': 8,
        'twoTypos': 10
    },
    'disableOnAttributes': ['title']
  },
  'pagination': {
    'maxTotalHits': 5000
  },
  'faceting': {
    'maxValuesPerFacet': 200
  }
})

$client->index('movies')->updateSettings([
  'rankingRules' => [
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:desc',
    'rank:desc'
  ],
  'distinctAttribute' => 'movie_id',
  'searchableAttributes' => [
    'title',
    'overview',
    'genres'
  ],
  'displayedAttributes' => [
    'title',
    'overview',
    'genres',
    'release_date'
  ],
  'stopWords' => [
    'the',
    'a',
    'an'
  ],
  'sortableAttributes' => [
    'title',
    'release_date'
  ],
  'synonyms' => [
    'wolverine' => ['xmen', 'logan'],
    'logan' => ['wolverine']
  ],
  'typoTolerance' => [
      'minWordSizeForTypos' => [
        'oneTypo' => 8,
        'twoTypos' => 10
      ],
      'disableOnAttributes' => ['title']
  ],
  'pagination' => [
    'maxTotalHits' => 5000
  ],
  'faceting' => [
    'maxValuesPerFacet' => 200
  ]
]);

Settings settings = new Settings();
settings.setRankingRules(
  new String[] {
      "typo",
      "words",
      "sort",
      "proximity",
      "attribute",
      "exactness",
      "release_date:desc",
      "rank:desc"
  });
settings.setDistinctAttribute("movie_id");
settings.setSearchableAttributes(
  new String[] {
    "title",
    "overview",
    "genres"
  });
settings.setDisplayedAttributes(
  new String[] {
    "title",
    "overview",
    "genres",
    "release_date"
  });
settings.setStopWords(
  new String[] {
    "the",
    "a",
    "an"
  });
settings.setSortableAttributes(
  new String[] {
    "title",
    "release_date"
  });
HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
synonyms.put("wolverine", new String[] {"xmen", "logan"});
synonyms.put("logan", new String[] {"wolverine"});
settings.setSynonyms(synonyms);
client.index("movies").updateSettings(settings);

client.index('movies').update_settings({
  ranking_rules: [
    'words',
    'typo',
    'proximity',
    'attribute',
    'sort',
    'exactness',
    'release_date:desc',
    'rank:desc'
  ],
  distinct_attribute: 'movie_id',
  searchable_attributes: [
    'title',
    'overview',
    'genres'
  ],
  displayed_attributes: [
    'title',
    'overview',
    'genres',
    'release_date'
  ],
  stop_words: [
    'the',
    'a',
    'an'
  ],
  sortable_attributes: [
    'title',
    'release_date'
  ],
  synonyms: {
    wolverine: ['xmen', 'logan'],
    logan: ['wolverine']
  },
  pagination: {
    max_total_hits: 5000
  },
  faceting: {
    max_values_per_facet: 200
  }
})

distinctAttribute := "movie_id"
settings := meilisearch.Settings{
	RankingRules: []string{
		"words",
		"typo",
		"proximity",
		"attribute",
		"sort",
		"exactness",
		"release_date:desc",
		"rank:desc",
	},
	DistinctAttribute: &distinctAttribute,
	SearchableAttributes: []string{
		"title",
		"overview",
		"genres",
	},
	DisplayedAttributes: []string{
		"title",
		"overview",
		"genres",
		"release_date",
	},
	StopWords: []string{
		"the",
		"a",
		"an",
	},
	SortableAttributes: []string{
		"title",
		"release_date",
	},
	Synonyms: map[string][]string{
		"wolverine": []string{"xmen", "logan"},
		"logan":     []string{"wolverine"},
	},
	TypoTolerance: &meilisearch.TypoTolerance{
		MinWordSizeForTypos: meilisearch.MinWordSizeForTypos{
			OneTypo:  8,
			TwoTypos: 10,
		},
		DisableOnAttributes: []string{"title"},
	},
  Pagination: &meilisearch.Pagination{
    MaxTotalHits: 5000,
  },
  Faceting: &meilisearch.Faceting{
    MaxValuesPerFacet: 200,
  },
}
client.Index("movies").UpdateSettings(&settings)

Settings newSettings = new Settings
{
  RankingRules = new string[]
  {
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:desc",
    "rank:desc"
  },
  DistinctAttribute = "movie_id",
  SearchableAttributes = new string[] { "title", "overview", "genres" },
  DisplayedAttributes = new string[] { "title", "overview", "genres", "release_date" },
  SortableAttributes = new string[] { "title", "release_date" },
  StopWords = new string[] { "the", "a", "an" },
  Synonyms = new Dictionary<string, IEnumerable<string>>
  {
    { "wolverine", new string[] { "xmen", "logan" } },
    { "logan", new string[] { "wolverine" } },
  },
  FilterableAttributes = new string[] { },
  TypoTolerance = new TypoTolerance
  {
      DisableOnAttributes = new string[] { "title" },
      MinWordSizeForTypos = new TypoTolerance.TypoSize
      {
          OneTypo = 8,
          TwoTypos = 10
      }
  }
};
TaskInfo task = await client.Index("movies").UpdateSettingsAsync(newFilters);

let mut synonyms = std::collections::HashMap::new();
synonyms.insert(String::from("wolverine"), vec!["xmen", "logan"]);
synonyms.insert(String::from("logan"), vec!["wolverine"]);

let settings = Settings::new()
  .with_ranking_rules([
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:desc",
    "rank:desc"
  ])
  .with_distinct_attribute("movie_id")
  .with_searchable_attributes([
    "title",
    "overview",
    "genres"
  ])
  .with_displayed_attributes([
    "title",
    "overview",
    "genres",
    "release_date"
  ])
  .with_stop_words([
    "the",
    "a",
    "an"
  ])
  .with_sortable_attributes([
    "title",
    "release_date"
  ])
  .with_synonyms(synonyms);

let task: TaskInfo = client
  .index("movies")
  .set_settings(&settings)
  .await
  .unwrap();

let settings = Setting(rankingRules: [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:desc",
    "rank:desc"
], searchableAttributes: [
    "title",
    "overview",
    "genres"
], displayedAttributes: [
    "title",
    "overview",
    "genres"
    "release_date"
], stopWords: [
    "the",
    "a",
    "an"
], synonyms: [
    "wolverine": ["xmen", "logan"],
    "logan": ["wolverine"]
], distinctAttribute: "movie_id",
sortableAttributes: [
    "title",
    "release_date"
])
client.index("movies").updateSettings(settings) { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateSettings(IndexSettings(
      rankingRules: [
        'words',
        'typo',
        'proximity',
        'attribute',
        'sort',
        'exactness',
        'release_date:desc',
        'rank:desc'
      ],
      distinctAttribute: 'movie_id',
      searchableAttributes: ['title', 'overview', 'genres'],
      displayedAttributes: ['title', 'overview', 'genres', 'release_date'],
      stopWords: ['the', 'a', 'an'],
      sortableAttributes: ['title', 'release_date'],
      synonyms: {
        'wolverine': ['xmen', 'logan'],
        'logan': ['wolverine'],
      },
    ));

# Response: `202 Accepted`

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

# Reset settings

DELETE

/indexes/{index_uid}/settings

Reset the settings of an index. The index uid is required.

All settings will be reset to their default value.

Variable	Type	Description	Default value
displayedAttributes	[Strings]	Fields displayed in the returned documents	`["*"]` (all attributes)
distinctAttribute	String	Search returns documents with distinct (different) values of the given field	`null`
faceting	Object	Faceting settings	`{}`
filterableAttributes	[Strings]	Attributes to use as filters and facets	`[]`
pagination	Object	Pagination settings	`{}`
rankingRules	[Strings]	List of ranking rules sorted by order of importance	A list of ordered built-in ranking rules
searchableAttributes	[Strings]	Fields in which to search for matching query words sorted by order of importance	`["*"]` (all attributes)
sortableAttributes	[Strings]	Attributes to use when sorting search results	`[]`
stopWords	[Strings]	List of words ignored by Meilisearch when present in search queries	`[]`
synonyms	Object	List of associated words treated similarly	`{}`
typoTolerance	Object	Typo tolerance settings	`{}`

Learn more about the settings.

# Example

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

# Response: `202 Accepted`

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

← Keys Displayed attributes →

# All settings

# Get settings

# Response body

# Example

# Response: 200 Ok

# Update settings

# Body

# Example

# Response: 202 Accepted

# Reset settings

# Example

# Response: 202 Accepted

# Response: `200 Ok`

# Response: `202 Accepted`

# Response: `202 Accepted`