sumOrFiltersScores

Type: boolean

Engine default: false

Parameter syntax

'sumOrFiltersScores' => true|false

sumOrFiltersScores: true|false

sumOrFiltersScores: true|false

'sumOrFiltersScores': True|False

sumOrFiltersScores = true|false

sumOrFiltersScores: Boolean = true|false

SumOrFiltersScores: true|false

.addCustomParameter("sumOrFiltersScores", "true|false")

opt.SumOrFiltersScores(true|false)

"sumOrFiltersScores" -> "true|false"

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

See code examples

About this parameter# A

Determines how to calculate the total score for filtering.

When using filter scoring to rank filtered records, you can control how scores are calculated.

Usage notes#

This feature only applies to OR boolean operators in your filters (ie. not AND).
When sumOrFiltersScores is false, max score will be kept.
When sumOrFiltersScores is true, score will be summed.
Just to be clear: False means that the total score of a record is the maximum score of an individual filter. Setting it to true changes the total score by adding together the scores of each matched filter.

Examples# A

Apply optional filters on a search query#

Copy

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

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

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

Did you find this page helpful?

sumOrFiltersScores

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

Apply optional filters on a search query#

On this page

About this parameter# A

Examples# A