minProximity

Precision of the Proximity ranking criterion

• Type: integer
• Default: 1
• Min: 1
• Max: 7
• Scope: settings,search

Usage

• The Proximity ranking criterion measures how close two matching words are in a search result.
• If you increase minProximity, pairs of matching words up to this distance are considered equally relevant.
• If minProximity is greater than 7, the Proximity ranking criterion is ignored.

Example

Current API clients

C#

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { MinProximity = 1 }
);

Legacy API clients

C#

IndexSettings settings = new IndexSettings();
settings.MinProximity = 1;

index.SetSettings(settings);