API Reference / API Parameters / relevancyStrictness

Jan. 14, 2021

relevancyStrictness

Type: integer

Engine default: 100

Parameter syntax

'relevancyStrictness' => relevancy_strictness

relevancyStrictness: relevancy_strictness

relevancyStrictness: relevancy_strictness

'relevancyStrictness': relevancy_strictness

relevancyStrictness = relevancy_strictness

relevancyStrictness: Int = relevancy_strictness

new JSONObject()
  .put("relevancyStrictness", relevancy_strictness)

var settings = new IndexSettings();
settings.RelevancyStrictness = relevancy_strictness;

.setRelevancyStrictness(relevancy_strictness)

opt.RelevancyStrictness(relevancy_strictness)

relevancyStrictness = Some(relevancy_strictness)

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 searchAsync, setSettingsAsync, browseAsync, searchForFacetValues 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

Controls the relevancy threshold below which less relevant results aren’t included in the results.

Usage notes:

relevancyStrictness is available on applications having the Relevant sort feature enabled.
You can set relevancyStrictness on virtual replicas only.
The value must be an integer between 0 and 100 (inclusive).

By default, this parameter is set to 100, which is the maximum value to offer a relevant sort. If this behavior isn’t suited for you and to know what value works best for your use-case, you can:

Test your top queries with different values of relevancyStrictness until you’re satisfied with the balance between the relevancy of results and the number of returned hits.
If you have enough traffic on your sort, you can start an A/B test to test different values of relevancyStrictness and see which one works best.

Options:

100: The default value of 100 means that the engine only returns and sorts the top relevant results.
90: Returns hits with 90% similarity as compared to the most relevant hit.
0: The engine doesn’t consider relevancy and sorts results only on the attributes you list in the Relevant sort customRanking. It returns results up to paginationLimitedTo.

Examples

Set the default relevancy strictness for an index with Relevant sort

Copy

1
2
3
$index->setSettings([
  'relevancyStrictness' => 90
]);

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

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

Override the default relevancy strictness for the current search

Copy

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

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

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

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

relevancyStrictness

About this parameter

Usage notes:

Options:

Examples

Set the default relevancy strictness for an index with Relevant sort

Override the default relevancy strictness for the current search

Did you find this page helpful?

On this page