Synonyms

Child route of the settings route.

Synonyms is an object containing words and their respective synonyms. A synonym in Meilisearch is considered equal to its associated word in a search query.

Synonyms can also be updated directly through the global settings route along with the other settings.

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

WARNING

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

Get synonyms

GET

/indexes/{index_uid}/settings/synonyms

Get the list of synonyms of an index. The index uid is required.

Example

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

client.index('movies').getSynonyms()

client.index('movies').get_synonyms()

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

client.index("movies").getSynonyms();

client.index('movies').synonyms

client.Index("movies").GetSynonyms()

await client.Index("movies").GetSynonymsAsync();

let synonyms: HashMap<String, Vec<String>> = client
  .index("movies")
  .get_synonyms()
  .await
  .unwrap();

client.index("movies").getSynonyms { (result) in
    switch result {
    case .success(let synonyms):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').get_synonyms();

Response: 200 OK

{
  "wolverine": [
    "xmen",
    "logan"
  ],
  "logan": [
    "wolverine",
    "xmen"
  ],
  "wow": [
    "world of warcraft"
  ]
}

Update synonyms

PUT

/indexes/{index_uid}/settings/synonyms

Update the list of synonyms of an index. Synonyms are normalized. The index uid is required.

Body

An object that contains all synonyms and their associated words.

More information about the body.

Example

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "wolverine": [
      "xmen",
      "logan"
    ],
    "logan": [
      "wolverine",
      "xmen"
    ],
    "wow": ["world of warcraft"]
  }'

client.index('movies').updateSynonyms({
  wolverine: ['xmen', 'logan'],
  logan: ['wolverine', 'xmen'],
  wow: ['world of warcraft']
})

client.index('movies').update_synonyms({
  'wolverine': ['xmen', 'logan'],
  'logan': ['wolverine', 'xmen'],
  'wow': ['world of warcraft']
})

$client->index('movies')->updateSynonyms([
  'wolverine' => ['xmen', 'logan'],
  'logan' => ['wolverine', 'xmen'],
  'wow' => ['world of warcraft']
]);

HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
synonyms.put("wolverine", new String[] {"xmen", "logan"});
synonyms.put("logan", new String[] {"wolverine"});
client.index("movies").updateSynonymsSettings(synonyms);

client.index('movies').update_synonyms({
  wolverine: ['xmen', 'logan'],
  logan: ['wolverine', 'xmen'],
  wow: ['world of warcraft']
})

synonyms := map[string][]string{
  "wolverine": []string{"xmen", "logan"},
  "logan":     []string{"wolverine", "xmen"},
  "wow":       []string{"world of warcraft"},
}
client.Index("movies").UpdateSynonyms(&synonyms)

var synonyms = new Dictionary<string, IEnumerable<string>>
{
	{ "wolverine", new string[] { "xmen", "logan" } },
	{ "logan", new string[] { "wolverine", "xmen" } },
  { "wow", new string[] { "world of warcraft" } }
};
await client.Index("movies").UpdateSynonymsAsync(synonyms);

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

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

let synonyms: [String: [String]] = [
    "wolverine": ["xmen", "logan"],
    "logan": ["wolverine", "xmen"],
    "wow": ["world of warcraft"]
]
client.index("movies").updateSynonyms(synonyms) { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateSynonyms(
  {
    'wolverine': ['xmen', 'logan'],
    'logan': ['wolverine', 'xmen'],
    'wow': ['world of warcraft']
  }
);

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 synonyms

DELETE

/indexes/{index_uid}/settings/synonyms

Reset the list of synonyms of an index to its default value. The index uid is required.

Default value

Empty object : {}

Example

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

client.index('movies').resetSynonyms()

client.index('movies').reset_synonyms()

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

client.index("movies").resetSynonymsSettings();

client.index('movies').reset_synonyms

client.Index("movies").ResetSynonyms()

await client.Index("movies").ResetSynonymsAsync();

let task: TaskInfo = client
  .index("movies")
  .reset_synonyms()
  .await
  .unwrap();

client.index("movies").resetSynonyms { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').resetSynonyms();

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.