API Reference / API Parameters / minProximity

Jan. 14, 2021

minProximity

Type: integer

Engine default: 1

Parameter syntax

'minProximity' => integer // from 1 to 7

minProximity: integer # from 1 to 7

minProximity: integer // from 1 to 7

'minProximity': integer # from 1 to 7

minProximity = integer // from 1 to 7

minProximity: Int = integer // from 1 to 7

new JSONObject().put("minProximity", integer) // from 1 to 7

IndexSettings settings = new IndexSettings();
settings.MinProximity = integer # from 1 to 7;

.setMinProximity(integer) // from 1 to 7

opt.MinProximity(integer) // from 1 to 7

minProximity = Some(integer) // from 1 to 7

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

Precision of the proximity ranking criterion.

Usage notes:

The minimum (and best) proximity value between two matching words is 1. This is the engine default.
Setting it to 2 (respectively N) would allow 1 (respectively N-1) additional word(s) to be found between two matching words without degrading the proximity ranking value.
For example, consider the query “javascript framework”. If you set minProximity to 2, two records containing respectively “JavaScript framework” and “JavaScript charting framework” will get the same proximity score, even if the latter contains an additional word between the two matching words.
The maximum value for minProximity is 7. Any higher value will disable the proximity criterion in the ranking formula.

Examples

Set default min proximity

Copy

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

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

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

Override default min proximity for the current search

Copy

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

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

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

minProximity

About this parameter

Usage notes:

Examples

Set default min proximity

Override default min proximity for the current search

Did you find this page helpful?

On this page