Usage
- Only applies to
searchForFacetValuesoperations. - To change the number of retrieved facet values for a regular search, see
maxValuesPerFacet.
Example
Current API clients
Current API clients
var response = await client.SetSettingsAsync(
"INDEX_NAME",
new IndexSettings { MaxFacetHits = 10 }
);
final response = await client.setSettings(
indexName: "INDEX_NAME",
indexSettings: IndexSettings(
maxFacetHits: 10,
),
);
response, err := client.SetSettings(client.NewApiSetSettingsRequest(
"INDEX_NAME",
search.NewEmptyIndexSettings().SetMaxFacetHits(10)))
if err != nil {
// handle the eventual error
panic(err)
}
UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setMaxFacetHits(10));
const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { maxFacetHits: 10 } });
var response =
client.setSettings(
indexName = "INDEX_NAME",
indexSettings = IndexSettings(maxFacetHits = 10),
)
$response = $client->setSettings(
'INDEX_NAME',
['maxFacetHits' => 10,
],
);
response = client.set_settings(
index_name="INDEX_NAME",
index_settings={
"maxFacetHits": 10,
},
)
response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(max_facet_hits: 10))
val response = Await.result(
client.setSettings(
indexName = "INDEX_NAME",
indexSettings = IndexSettings(
maxFacetHits = Some(10)
)
),
Duration(100, "sec")
)
let response = try await client.setSettings(
indexName: "INDEX_NAME",
indexSettings: IndexSettings(maxFacetHits: 10)
)
Legacy API clients
Legacy API clients
index.SearchForFacetValue(new SearchForFacetRequest
{
FacetName = "category",
FacetQuery = "phone",
SearchParameters = new Query("query") { MaxFacetHits = 5 }
});
res, err := index.SearchForFacetValues(
"category",
"phone",
opt.MaxFacetHits(5),
)
index.searchForFacetValues(new SearchForFacetRequest()
.setFacetQuery("category")
.setFacetName("phone")
.setSearchParameters(new Query().setMaxFacetHits(5L)));
index
.search("query", {
maxFacetHits: 5,
})
.then(({ hits }) => {
console.log(hits);
});
val query = query("query") {
maxFacetHits = 5
}
index.search(query)
$facetValues = $index->searchForFacetValues("category", "phone", [
'maxFacetHits' => 5
]);
facet_values = index.search_for_facet_values("category", "phone", {"maxFacetHits": 5})
facet_values = index.search_for_facet_values(
"category",
"phone",
{
maxFacetHits: 5
}
)
client.execute {
search into "myIndex" facet "category" values "phone" query Query(
maxFacetHits = Some(5)
)
}
let query = Query("query")
.set(\.maxFacetHits, to: 5)
index.search(query: query) { result in
if case .success(let response) = result {
print("Response: \(response)")
}
}