Skip to main content

​
Searching

You can search in a Searchable class using the search method. The search method accepts a single string to search in your Searchable class index:
PHP
$articles = Article::search('Star Trek')->get();
You can also search with pagination, and work with soft deleted models. To learn more, see the Laravel Scout documentation.

​
Search with numerical filters

You can use the where method to filter your search results. With Scout Extended, this method shares the same API as the Laravel Query Builder, so you can filter results either with a comparison or a numerical range:
PHP
$articles = Article::search('Star Trek')->where('views', '>', 100)->get();
$articles = Article::search('Star Trek')->where('created_at', '>=', now()->subDays(7))->get();
$articles = Article::search('Star Trek')->where('views', 100)->get(); // views = 100
The where method supports the following operators: <, <=, =, !=, >=, >.

​
Search with numerical range filters

The whereBetween method filters results for which the provided field falls between the given range:
PHP
$products = Products::search('Star Trek')
    ->whereBetween('price', [100, 200])
    ->get();

​
Search with multiple filter values

The whereIn method filters results for which the value of the provided field is part of the given array:
PHP
$products = Products::search('Star Trek')
    ->whereIn('id', [1, 2])
    ->get();

​
Search with locational filters

The aroundLatLng method adds a geolocation parameter to the search request. You can define a point with its coordinates. This method is syntactic sugar, and you can use the method with to specify more location details such as aroundLatLng and aroundRadius.
PHP
$articles = Article::search('query')
    ->aroundLatLng(48.8588536, 2.3125377)
    ->get();

​
Search with custom search parameters

The with method gives you complete access to customize search API parameters.
PHP
$articles = Article::search('Star Trek')
    ->with([
        'hitsPerPage' => 30,
        'filters' => 'attribute:value',
        'typoTolerance' => false,
    ])->get();

​
Retrieve the number of hits

The count method returns the number of hits the query matches:
PHP
$count = Article::search('Star Trek')->count();

​
Retrieve hit metadata

You can use the scoutMetadata method to retrieve an array with more information about any hit. The key _highlightResult holds all the highlighted attributes. By default, Algolia highlights all the searchable attributes. You can change this with the aroundLatLng parameter.
PHP
$metadata = Article::search('Star Trek')->get()->first()->scoutMetadata();
$highlightResult = $metadata['_highlightResult'];
If you set the getRankingInfo search parameter to true, the getRankingInfo holds detailed ranking information. It lets you see which ranking criteria played a role in selecting each model:
PHP
$metadata = Article::search('Star Trek')->get()->first()->scoutMetadata();
$rankingInfo = $metadata['_rankingInfo'];
⌘I