minProximity

Precision of the Proximity ranking criterion

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(
  "INDEX_NAME",
  new IndexSettings { MinProximity = 1 }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    minProximity: 1,
  ),
);

response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "INDEX_NAME",
  search.NewEmptyIndexSettings().SetMinProximity(1)))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setMinProximity(1));

const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { minProximity: 1 } });

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(minProximity = 1),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['minProximity' => 1,
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "minProximity": 1,
    },
)

response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(min_proximity: 1))

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      minProximity = Some(1)
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(minProximity: 1)
)

Legacy API clients

C#

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

index.SetSettings(settings);

res, err := index.SetSettings(search.Settings{
	MinProximity: opt.MinProximity(1),
})

index.setSettings(
  new IndexSettings()
    .setMinProximity(1)
);

index
  .setSettings({
    minProximity: 1,
  })
  .then(() => {
    // done
  });

val settings = settings {
    minProximity = 1
}

index.setSettings(settings)

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

index.set_settings({"minProximity": 1})

index.set_settings(
  {
    minProximity: 1
  }
)

client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    minProximity = Some(1)
  )
}

let settings = Settings()
  .set(\.minProximity, to: 1)

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