maxFacetHits

Type: integer

Engine default: 10

Parameter syntax

'maxFacetHits' => number_of_facet_hits

maxFacetHits: number_of_facet_hits

'maxFacetHits' => number_of_facet_hits

'maxFacetHits': number_of_facet_hits

maxFacetHits = number_of_facet_hits

maxFacetHits: Int = number_of_facet_hits

IndexSettings settings = new IndexSettings();
settings.MaxFacetHits = number_of_facet_hits;

.setMaxFacetHits(number_of_facet_hits)

opt.MaxFacetHits(number_of_facet_hits)

maxFacetHits = Some(number_of_facet_hits)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Maximum number of facet hits to return during a search for facet values.

If you want to change the number of retrieved facet values for a regular search, see maxValuesPerFacet.

Usage notes

Doesn’t apply to regular search queries.
To determine the order in which facets are retrieved, see searchForFacetValues.
For performance reasons, the maximum allowed number of returned values is 100. Any value outside the range [1, 100] will be rejected.

Examples

Copy

1
2
3
$index->setSettings([
  'maxFacetHits' => 10
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.maxFacetHits, to: 10)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Copy

1
2
3
$facetValues = $index->searchForFacetValues("category", "phone", [
  'maxFacetHits' => 5
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.maxFacetHits, to: 5)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
index.SearchForFacetValue(new SearchForFacetRequest
{
    FacetName = "category",
    FacetQuery = "phone",
    SearchParameters = new Query("query") { MaxFacetHits = 5 }
});

1
2
3
4
index.searchForFacetValues(new SearchForFacetRequest()
        .setFacetQuery("category")
        .setFacetName("phone")
        .setSearchParameters(new Query().setMaxFacetHits(5L)));

Did you find this page helpful?

maxFacetHits

About this parameter

Usage notes

Examples

Set default number of facet values to return during a search for facet values

Override default number of facet values to return during a search for facet values for the current search

On this page