maxValuesPerFacet

Type: integer

Engine default: 100

Parameter syntax

'maxValuesPerFacet' => max_value

maxValuesPerFacet: max_value

maxValuesPerFacet: max_value

'maxValuesPerFacet': max_value

"maxValuesPerFacet": max_value

maxValuesPerFacet: Int = maxValue

IndexSettings settings = new IndexSettings();
settings.MaxValuesPerFacet = max_value;

.setMaxValuesPerFacet(max_value)

opt.MaxValuesPerFacet(max_value)

maxValuesPerFacet = Some(max_value)

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

See code examples

About this parameter# A

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

If you want to change the number of retrieved facet hits during a search for facet values, see maxFacetHits.

Usage notes#

For performance reasons, the API enforces a hard limit of 1000 on maxValuesPerFacet. Any value above that limit will be interpreted as 1000.

Examples# A

Set default number of facet values to retrieve#

Copy

1
2
3
$index->setSettings([
  'maxValuesPerFacet' => 100
]);

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

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

Override default number of facet values to retrieve for the current search#

Copy

1
2
3
$results = $index->search('query', [
  'maxValuesPerFacet' => 50
]);

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

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

Did you find this page helpful?

maxValuesPerFacet

About this parameter# Found an issue? Edit this parameter A Edit this parameter

Usage notes#

Examples# Found an issue? Edit this parameter A Edit this parameter

Set default number of facet values to retrieve#

Override default number of facet values to retrieve for the current search#

On this page

About this parameter# A

Examples# A