minimumAroundRadius
null
'minimumAroundRadius' => radius
Can be used in these methods:
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse,
searchForFacetValues
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
searchAsync,
browseAsync,
searchForFacetValues
Search,
Browse,
SearchForFacetValues,
GenerateSecuredApiKey,
AddApiKey,
UpdateApiKey
Search,
browse,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
Search,
BrowseObjects,
SearchForFacetValues,
GenerateSecuredAPIKey,
AddAPIKey,
UpdateAPIKey
search,
browse index,
search into facet values,
generateSecuredApiKey,
add key,
update key
About this parameter
Minimum radius (in meters) used for a geo search when aroundRadius is not set.
When a radius is automatically generated, the area of the circle might be too small to include enough records. This setting allows you to increase the size of the circle, thus ensuring sufficient coverage.
Usage notes:
-
This setting only works within the context of a circular geo search, enabled by aroundLatLng or aroundLatLngViaIP.
-
This parameter is ignored when
aroundRadiusis set.
Examples
Set minimum geo search radius
1
2
3
$results = $index->search('query', [
'minimumAroundRadius' => 1000 // 1km
]);
