synonyms parameter controls whether Algolia uses synonym matching
for the current search query.
By default, synonyms are enabled and applied during search.
Use this parameter to turn them off for specific queries.
Example
Current API clients
Current API clients
var response = await client.SearchSingleIndexAsync<Hit>(
"INDEX_NAME",
new SearchParams(new SearchParamsObject { Query = "query", Synonyms = false })
);
final response = await client.searchSingleIndex(
indexName: "INDEX_NAME",
searchParams: SearchParamsObject(
query: "query",
synonyms: false,
),
);
response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
"INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
search.NewEmptySearchParamsObject().SetQuery("query").SetSynonyms(false))))
if err != nil {
// handle the eventual error
panic(err)
}
SearchResponse response = client.searchSingleIndex(
"INDEX_NAME",
new SearchParamsObject().setQuery("query").setSynonyms(false),
Hit.class
);
const response = await client.searchSingleIndex({
indexName: 'indexName',
searchParams: { query: 'query', synonyms: false },
});
var response =
client.searchSingleIndex(
indexName = "INDEX_NAME",
searchParams = SearchParamsObject(query = "query", synonyms = false),
)
$response = $client->searchSingleIndex(
'INDEX_NAME',
['query' => 'query',
'synonyms' => false,
],
);
response = client.search_single_index(
index_name="INDEX_NAME",
search_params={
"query": "query",
"synonyms": False,
},
)
response = client.search_single_index(
"INDEX_NAME",
Algolia::Search::SearchParamsObject.new(query: "query", synonyms: false)
)
val response = Await.result(
client.searchSingleIndex(
indexName = "INDEX_NAME",
searchParams = Some(
SearchParamsObject(
query = Some("query"),
synonyms = Some(false)
)
)
),
Duration(100, "sec")
)
let response: SearchResponse<Hit> = try await client.searchSingleIndex(
indexName: "INDEX_NAME",
searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
query: "query",
synonyms: false
))
)
Legacy API clients
Legacy API clients
index.Search(new Query("query")
{
Synonyms = true
});
res, err := index.Search(
"query",
opt.Synonyms(false),
)
index.search(
new Query("query")
.setSynonyms(true)
);
index
.search("query", {
synonyms: false,
})
.then(({ hits }) => {
console.log(hits);
});
val query = query("query") {
synonyms = true
}
index.search(query)
$results = $index->search('query', [
'synonyms' => false
]);
results = index.search("query", {"synonyms": False})
results = index.search(
"query",
{
synonyms: false
}
)
client.execute {
search into "myIndex" query Query(
query = Some("query"),
synonyms = Some(true)
)
}
let query = Query("query")
.set(\.synonyms, to: false)
index.search(query: query) { result in
if case .success(let response) = result {
print("Response: \(response)")
}
}