sumOrFiltersScores

Determines how to calculate the total score for filtering

Controls how filter scores are aggregated when using filter scoring.
Only applies to OR combinations of filters (not AND).

Options

true

The total score is the sum of all matched filter scores.

false

The total score is the maximum score among all matched filters.

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", SumOrFiltersScores = true })
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    sumOrFiltersScores: true,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetSumOrFiltersScores(true))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setSumOrFiltersScores(true),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', sumOrFiltersScores: true },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", sumOrFiltersScores = true),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'sumOrFiltersScores' => true,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "sumOrFiltersScores": True,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", sum_or_filters_scores: true)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        sumOrFiltersScores = Some(true)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        sumOrFiltersScores: true
    ))
)

Legacy API clients

C#

index.Search(new Query("query")
{
    SumOrFiltersScores = true
});

res, err := index.Search(
	"query",
	opt.SumOrFiltersScores(true),
)

index.search(
  new Query("query").setsumOrFiltersScores(true)
);

index
  .search("query", {
    sumOrFiltersScores: true,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    sumOrFiltersScores = true
}

index.search(query)

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

results = index.search("query", {"sumOrFiltersScores": True})

results = index.search(
  "query",
  {
    sumOrFiltersScores: true
  }
)

client.execute {
  search into "myIndex" query Query(
    customParameters = Some(
      Map(
        "sumOrFiltersScores" -> "true"
      )
    )
}

let query = Query("query")
  .set(\.sumOrFiltersScores, to: true)

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