Elastic Scout Driver Plus

https://github.com/babenkoivan/elastic-scout-driver-plus
Admin
Elastic Scout Driver Plus is an extension for Laravel Scout that adds advanced Elasticsearch...
Tokens:29,728
Snippets:380
Trust Score:8.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set starting document offset with from method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the from method to define the starting document offset for pagination. The example starts from the 6th document (offset 5).

```php
$searchResult = Book::searchQuery($query)
    ->from(5)
    ->execute();
```

--------------------------------

### Install project dependencies

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/CONTRIBUTING.md

Use Composer to install the necessary project dependencies.

```bash
composer install
```

--------------------------------

### Start a search with searchQuery

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Starts a new search using the searchQuery method on the model. The query can be a builder or raw array.

```php
$builder = Book::searchQuery($query);
```

--------------------------------

### Get raw highlight

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Shows how to get the raw representation of a highlight.

```php
$raw = $highlight->raw();
```

--------------------------------

### Install elastic-scout-driver-plus via Composer

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/wiki/Lumen-Installation

Run this command to require the package with Composer. This is the first step after installing Elastic Scout Driver.

```bash
composer require babenkoivan/elastic-scout-driver-plus
```

--------------------------------

### Highlight fields with highlight method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the highlight method to get highlighted snippets from one or more fields. The example highlights the title field.

```php
$searchResult = Book::searchQuery($query)
    ->highlight('title')
    ->execute();
```

--------------------------------

### Set search preference with preference()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Defines which nodes and shards are used for the search. The example uses '_local' to prefer local shards.

```php
$searchResult = Book::searchQuery($query)
    ->preference('_local')
    ->execute();
```

--------------------------------

### zeroTermsQuery parameter example

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines what to return if the analyzer removes all tokens. Sets zeroTermsQuery to 'none'.

```php
$query = Query::match()
    ->field('title')
    ->query('My book')  
    ->zeroTermsQuery('none');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Explain score computation with explain method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

When set to true, every hit includes detailed information about score computation. The example shows how to retrieve the explanation and its components.

```php
$searchResult = Book::searchQuery($query)
    ->explain(true)
    ->execute();

$hits = $searchResult->hits();
$explanation = $hits->first()->explanation();

// every explanation includes a value, a description and details
// it is also possible to get its raw representation
$value = $explanation->value();
$description = $explanation->description();
$details = $explanation->details();
$raw = $explanation->raw();
```

--------------------------------

### prefixLength parameter example

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Determines the number of beginning characters left unchanged for fuzzy matching. Used with fuzziness 'AUTO' and prefixLength set to 0.

```php
$query = Query::match()
    ->field('title')
    ->query('My book')
    ->fuzziness('AUTO')
    ->prefixLength(0);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### searchAfter method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use searchAfter to retrieve the next page of hits using sort values from the previous page. The example first executes a query with a point in time, gets the sort values from the last hit, then uses them in a second query.

```php
$firstPage = Book::searchQuery($query)
    ->pointInTime($pit)
    ->execute();

$searchAfter = $firstPage->hits()->last()->sort();

$secondPage = Book::searchQuery($query)
    ->pointInTime($pit)
    ->searchAfter($searchAfter)
    ->execute();
```

--------------------------------

### source method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the source method to select which document fields of the source are returned. The example selects 'title' and 'description' fields.

```php
$searchResult = Book::searchQuery($query)
    ->source(['title', 'description'])
    ->execute();
```

--------------------------------

### Boost results from a specific index with join method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the second argument in the join method to boost results from a specific index. The example boosts Book results with a factor of 2.

```php
$searchResult = Author::searchQuery($query)
    ->join(Book::class, 2)
    ->execute();
```

--------------------------------

### minimumShouldMatch parameter example

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Sets the minimum number of clauses that must match for a document to be returned. Used with operator 'OR' and minimumShouldMatch set to 1.

```php
$query = Query::match()
    ->field('title')
    ->query('My book')
    ->operator('OR')
    ->minimumShouldMatch(1);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Build a Geo-Shape Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/geo-queries.md

Basic example of using Query::geoShape() to search for documents within a specified envelope.

```php
$query = Query::geoShape()
    ->field('location')
    ->shape('envelope', [[13.0, 53.0], [14.0, 52.0]])
    ->relation('within');

$searchResult = Store::searchQuery($query)->execute();
```

--------------------------------

### Fuzzy query prefixLength() method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Sets the number of beginning characters left unchanged when creating expansions using the prefixLength() method. The example uses 0.

```php
$query = Query::fuzzy()
    ->field('title')
    ->value('boko')
    ->prefixLength(0);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### size method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the size method to limit the number of hits to return. The example limits the result to 2 hits.

```php
$searchResult = Book::searchQuery($query)
    ->size(2)
    ->execute();
```

--------------------------------

### suggest method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Uses the suggest method to get similar looking terms based on provided text. Requires a query and a suggestion name with text and term parameters.

```php
$searchResult = Book::searchQuery(Query::matchNone())
    ->suggest('title_suggest', ['text' => 'book', 'term' => ['field' => 'title']])
    ->execute();
```

--------------------------------

### Get highlight for a hit

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Shows how to get the highlight for a specific hit from the search result.

```php
$hits = $searchResult->hits();
$highlight = $hits->first()->highlight();
```

--------------------------------

### Search multiple indices with join method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the join method to enable multi-index search. The example searches for an author named John or a book titled 'The Book' across two indices.

```php
$query = Query::bool()
    ->should(Query::match()->field('name')->query('John'))
    ->should(Query::match()->field('title')->query('The Book'))
    ->minimumShouldMatch(1);

$searchResult = Author::searchQuery($query)
    ->join(Book::class)
    ->execute();
```

--------------------------------

### sort method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the sort method to sort the search results. The example sorts by 'price' in ascending order.

```php
$searchResult = Book::searchQuery($query)
    ->sort('price', 'asc')
    ->execute();
```

--------------------------------

### Get suggestion by name

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Retrieves a specific suggestion collection by its name from the suggestions collection.

```php
$titleSuggestions = $suggestions->get('title_suggest');
```

--------------------------------

### Boost a terms query with ->boost(2)

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds the boost method to the terms query to increase or decrease relevance scores. The example sets a boost of 2 on the same field and values as the basic terms query.

```php
$query = Query::terms()
    ->field('tags')
    ->values(['available', 'new'])
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### operator parameter example

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines the boolean logic used to interpret the query text. Sets the operator to 'OR'.

```php
$query = Query::match()
    ->field('title')
    ->query('My book')
    ->operator('OR');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### sortRaw method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use sortRaw for more advanced sorting algorithms. The example sorts by 'price' ascending and then by 'published' ascending.

```php
$searchResult = Book::searchQuery($query)
    ->sortRaw([['price' => 'asc'], ['published' => 'asc']])
    ->execute();
```

--------------------------------

### Highlight fields with highlightRaw method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the highlightRaw method for more control over highlighting options. The example sets the number of fragments to 3 for the title field.

```php
$searchResult = Book::searchQuery($query)
    ->highlightRaw(['fields' => ['title' => ['number_of_fragments' => 3]]])
    ->execute();
```

--------------------------------

### Build a terms query with Query::terms()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Builds a terms query that matches documents containing one or more exact terms in a provided field. The example uses the 'tags' field with values 'available' and 'new', then executes the query on the Book model.

```php
$query = Query::terms()
    ->field('tags')
    ->values(['available', 'new']);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Eager load relations with load() for multiple indices

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

When searching in multiple indices, you must explicitly define the model for which you want to load relations. This example loads 'author' for Book and 'books' for Author.

```php
$searchResult = Book::searchQuery($query)
    ->join(Author::class)
    ->load(['author'], Book::class)
    ->load(['books'], Author::class)
    ->execute();
```

--------------------------------

### Aggregate data with aggregate method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the aggregate method to add an aggregation to the search query. The example shows a max aggregation on the price field.

```php
$searchResult = Book::searchQuery()
    ->aggregate('max_price', [
        'max' => [
            'field' => 'price',
        ],
    ])
    ->execute();
```

--------------------------------

### Fuzzy query transpositions() method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Allows transpositions of two adjacent characters using the transpositions() method. The example uses true.

```php
$query = Query::fuzzy()
    ->field('title')
    ->value('boko')
    ->transpositions(true);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### fields method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the fields method to retrieve selected fields from a search. The example includes the 'final_price' field in the results, with an alternative commented-out syntax.

```php
$searchResult = Book::searchQuery()
    // include field in the results
    ->fields([
        'final_price',
    ])
    // or
    // ->fields([
    //     [
    //         'field' => 'final_price',
    //     ]
    // ])
    ->execute();
```

--------------------------------

### Fuzzy query fuzziness() method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Sets the maximum edit distance allowed for matching using the fuzziness() method. The example uses 'AUTO'.

```php
$query = Query::fuzzy()
    ->field('title')
    ->value('boko')
    ->fuzziness('AUTO');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Get raw Elasticsearch response

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Executes a search query and returns the raw response from Elasticsearch.

```php
$raw = Book::searchQuery($query)->raw();
```

--------------------------------

### Build a prefix query with Query::prefix()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Builds a prefix query that matches documents whose field starts with the given value. Uses the Query::prefix() method with field() and value() to specify the search field and prefix.

```php
$query = Query::prefix()
    ->field('title')
    ->value('boo');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Fuzzy query rewrite() method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Rewrites the query using the rewrite() method. The example uses 'constant_score'.

```php
$query = Query::fuzzy()
    ->field('title')
    ->value('boko')
    ->rewrite('constant_score');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Boost a term query with boost()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds the `boost` method to a term query to decrease or increase the relevance scores of the query. The boost value is set to 2 in this example.

```php
$query = Query::term()
    ->field('price')
    ->value(300)
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Retrieve suggestions from search result

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Calls the suggestions method on the search result to get a collection of suggestions.

```php
$suggestions = $searchResult->suggestions();
```

--------------------------------

### Modify database query with refineModels() for multiple indices

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

When searching in multiple indices, you must explicitly define the model for which you want to set the callback. This example sets different callbacks for Book and Author.

```php
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;

$models = Book::searchQuery($query)
    ->join(Author::class)
    ->refineModels(function (EloquentBuilder $query) {
        $query->select(['id', 'title', 'description']);
    }, Book::class)
    ->refineModels(function (EloquentBuilder $query) {
        $query->select(['id', 'name', 'last_name']);
    }, Author::class)
    ->execute()
    ->models();
```

--------------------------------

### searchType method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use searchType to define how distributed term frequencies are calculated for relevance scoring. The example sets the search type to 'query_then_fetch'.

```php
$searchResult = Book::searchQuery($query)
    ->searchType('query_then_fetch')
    ->execute();
```

--------------------------------

### Fuzzy query maxExpansions() method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Specifies the maximum number of terms to which the query will expand using the maxExpansions() method. The example uses 50.

```php
$query = Query::fuzzy()
    ->field('title')
    ->value('boko')
    ->maxExpansions(50);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Collapse search results with collapseRaw method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the collapseRaw method to collapse search results using the raw array format. The example collapses on author_id and sorts by price ascending.

```php
$searchResult = Book::searchQuery($query)
    ->collapseRaw(['field' => 'author_id'])
    ->sort('price', 'asc')
    ->execute();
```

--------------------------------

### Collapse search results with collapse method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the collapse method to collapse search results based on a field value. The example collapses on author_id and sorts by published descending.

```php
$searchResult = Book::searchQuery($query)
    ->collapse('author_id')
    ->sort('published', 'desc')
    ->execute();
```

--------------------------------

### Aggregate data with aggregateRaw method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use the aggregateRaw method to add an aggregation using the raw array format. The example shows the same max aggregation as the aggregate method.

```php
$searchResult = Book::searchQuery()
    ->aggregateRaw([
        'max_price' => [
            'max' => [
                'field' => 'price',
            ],
        ],
    ])
    ->execute();
```

--------------------------------

### Run the test suite

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/CONTRIBUTING.md

Execute the test suite using the provided make command.

```bash
make up wait test
```

--------------------------------

### runtimeMappingsRaw method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use runtimeMappingsRaw to define runtime fields with a raw array structure. The example defines a runtime field 'final_price' with type double and a script. It also includes the field in the results.

```php
$searchResult = Book::searchQuery()
    ->runtimeMappingsRaw([
         'final_price' => [
                'type' => 'double',
                'script' => [
                    'lang' => 'painless',
                    'source' => 'doc[params.field] * params.multiplier',
                    'params' => [
                        'field' => 'my_field',
                        'multiplier' => 2,
                    ],
                ],
            ],
    ])
    ->fields([
        'final_price',
    ])
    ->execute();
```

--------------------------------

### runtimeMappings method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use runtimeMappings to define runtime fields in a search request. The example defines a runtime field 'final_price' of type double with a painless script that emits a computed value. It also includes the field in the results using the fields method.

```php
$searchResult = Book::searchQuery()
    ->runtimeMappings('final_price', 'double', [
        'lang' => 'painless',
        'source' => 'emit(doc[params.field].value * params.multiplier)',
        'params' => [
            'field' => 'price',
            'multiplier' => 2,
        ],
    ])
    // include field in the results
    ->fields([
        'final_price',
    ])
    // or
    // ->fields([
    //     [
    //         'field' => 'final_price',
    //     ]
    // ])
    ->execute();
```

--------------------------------

### Use withTrashed to include soft deleted results

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Use withTrashed() on a bool query to include soft deleted results in the search. The example creates a bool query with a must clause, adds withTrashed(), and executes it via Book::searchQuery().

```php
$query = Query::bool()
    ->must($must)
    ->withTrashed();

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Access suggestions

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Retrieves suggestions and demonstrates accessing suggestion details and related models.

```php
$suggestions = $searchResult->suggestions();
$titleSuggestions = $suggestions->get('title_suggest');
```

```php
$firstSuggestion = $titleSuggestions->first();

$text = $firstSuggestion->text();
$offset = $firstSuggestion->offset();
$length = $firstSuggestion->length();
$options = $firstSuggestion->options();
```

```php
$models = $firstSuggestion->models();
```

--------------------------------

### Implement paginated search in BookController

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/wiki/Paginated-Resources

Performs a multi-match search, paginates the results, and prepares the collection for the BookResource.

```php
class BookController extends Controller
{
    public function search(BookSearchRequest $request)
    {
        $search = Book::boolSearch();
        $search->must('multi_match', [
            'type' => 'phrase',
            'query' => $request->input('search'),
            'fields' => ['title^3', 'description']
        ]);
        
        // Paginate
        $books = $search->paginate(10);
        // Important to make BookResource aware of the paginated collection
        $books->setCollection($books->models());
        // If you want to append current query string to links and meta data generated by the Paginator
        $books->appends($request->query());

        return BookResource::collection($books);
    }
}
```

--------------------------------

### Define a query with Query builder or raw array

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Shows two ways to define a query: using the Query::match() builder with fluent methods, or using a raw array. Both produce the same match query with fuzziness set to AUTO.

```php
use Elastic\ScoutDriverPlus\Support\Query;

// using a query builder
$query = Query::match()
    ->field('title')
    ->query('My book')
    ->fuzziness('AUTO');

// using a raw query
$query = [
    'match' => [
        'title' => [
            'query' => 'My book',
            'fuzziness' => 'AUTO'
        ] 
    ]
];
```

--------------------------------

### Enable case-insensitive matching with caseInsensitive()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds the caseInsensitive(true) option to a prefix query to allow ASCII case-insensitive matching. The query is then executed on the Book model.

```php
$query = Query::prefix()
    ->field('title')
    ->value('boo')
    ->caseInsensitive(true);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Build a geo-distance query with Query::geoDistance()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/geo-queries.md

Creates a geo-distance query on the 'location' field with a 200km radius around latitude 40 and longitude -70, then executes it via Store::searchQuery().

```php
$query = Query::geoDistance()
    ->field('location')
    ->distance('200km')
    ->lat(40)
    ->lon(-70);

$searchResult = Store::searchQuery($query)->execute();
```

--------------------------------

### Build a basic nested query with Query::nested()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/joining-queries.md

Creates a nested query that searches for books with an author named 'Steven'. Uses the builder to set the path and match query, then executes the search.

```php
$query = Query::nested()
    ->path('author')
    ->query(Query::match()->field('author.name')->query('Steven'));

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Paginate search results

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Demonstrates how to paginate search results and access models, hits, or documents through the paginator.

```php
$paginator = Book::searchQuery($query)->paginate(10);
```

```php
$models = $paginator->models();
```

```php
// paginate hits
$paginator = Book::searchQuery($query)
    ->paginate(10);

foreach ($paginator as $hit) {
    $model = $hit->model();
}

// paginate models
$paginator = Book::searchQuery($query)
    ->paginate(10)
    ->onlyModels();

foreach ($paginator as $model) {
    $id = $model->id;
}

// paginated documents
$paginator = Book::searchQuery($query)
    ->paginate(10)
    ->onlyDocuments();

foreach ($paginator as $document) {
    $id = $document->id();
}
```

--------------------------------

### Match All Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Builds a query that matches all documents using Query::matchAll().

```php
$query = Query::matchAll();

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Rescore search results with rescore(), rescoreWeights(), and rescoreWindowSize()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Rescores the search results using a match_phrase query. Also sets query_weight, rescore_query_weight, and window_size.

```php
$searchResult = Book::searchQuery($query)
    ->rescore('match_phrase', [
        'message' => [
            'query' => 'the quick brown',
            'slop' => 2,
        ],
    ])
    ->rescoreWeights(0.7, 1.2)
    ->rescoreWindowSize(10)
    ->execute();
```

--------------------------------

### Use point-in-time with pointInTime()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Sets a point in time for the search. Note that join, preference, and routing parameters are ignored when pointInTime is used.

```php
$pit = Book::openPointInTime('1m');

$searchResult = Book::searchQuery($query)
    ->pointInTime($pit, '5m')
    ->execute();
```

--------------------------------

### Access suggestion details

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Shows how to access text, offset, length, options, models, and raw array from a suggestion object.

```php
$firstSuggestion = $titleSuggestions->first();

// the suggestion text
$text = $firstSuggestion->text();
// the start offset and the length of the suggested text
$offset = $firstSuggestion->offset();
$length = $firstSuggestion->length();
// an arbitrary number of options
$options = $firstSuggestion->options();
// related models (only some suggesters support this feature)
$models = $firstSuggestion->models();
// an array representation of the suggestion
$raw = $firstSuggestion->raw();
```

--------------------------------

### Range query with gt

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Builds a range query that matches documents with a price greater than 100. The query is executed via Book::searchQuery().

```php
$query = Query::range()
    ->field('price')
    ->gt(100);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Access script field evaluated value

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Access the evaluated value of a script field from the search result hits. The example retrieves the 'final_price' field from the raw hit data.

```php
$finalPrice = $searchResult->hits()->first()->raw()['fields']['final_price'];
```

--------------------------------

### when method with callback

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Executes the given callback when the first argument evaluates to true.

```php
$searchResult = Book::searchQuery($query)
    ->when($orderBy, function ($builder, $orderBy) {
        return $builder->sort($orderBy, 'asc');
    })
    ->execute();
```

--------------------------------

### suggestRaw method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Alternative to suggest using raw array format for the suggestion definition.

```php
$searchResult = Book::searchQuery(Query::matchNone())
    ->suggestRaw(['title_suggest' => ['text' => 'book', 'term' => ['field' => 'title']]])
    ->execute();
```

--------------------------------

### Build a match phrase query with Query::matchPhrase()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Creates a match phrase query for the 'title' field with the phrase 'My book' and executes it on the Book model.

```php
$query = Query::matchPhrase()
    ->field('title')
    ->query('My book');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### scriptFieldsRaw method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use scriptFieldsRaw to define script fields with a raw array structure. The example defines a script field 'final_price' with a script object containing lang, source, and params.

```php
$searchResult = Book::searchQuery($query)
    ->scriptFieldsRaw([
        'final_price' => [
            'script' => [
                'lang' => 'painless',
                'source' => "doc['price'].value * params.factor",
                'params' => [
                    'factor' => 2,
                ],
            ],
        ],
    ])
    ->execute();
```

--------------------------------

### Boost a wildcard query with boost(2)

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds the boost method to the wildcard query to increase or decrease relevance scores. The boost value of 2 is applied to the query.

```php
$query = Elastic\ScoutDriverPlus\Support\Query::wildcard()
    ->field('title')
    ->value('bo*k')
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Match Phrase Prefix Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Builds a match phrase prefix query that matches documents containing the words of the provided text in the same order.

```php
$query = Query::matchPhrasePrefix()
    ->field('title')
    ->query('My boo');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Retrieve all highlights from search result

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Shows how to retrieve all highlights from the search result using the highlights method.

```php
$highlights = $searchResult->highlights();
```

--------------------------------

### Override toSearchableArray to include related author data

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Use this snippet to index a model with related data by overriding toSearchableArray. The example includes the author's name and phone_number in the searchable array.

```php
class Book extends Model
{
    use Elastic\ScoutDriverPlus\Searchable;
    
    public function toSearchableArray()
    {
        return [
            'title' => $this->title,
            'price' => $this->price,
            'author' => $this->author->only(['name', 'phone_number']),
        ];
    }
}
```

--------------------------------

### Update Elastic Scout Driver via Composer

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Recommended to update Elastic Scout Driver before installing Elastic Scout Driver Plus. This command updates the existing Elastic Scout Driver package.

```bash
composer update babenkoivan/elastic-scout-driver
```

--------------------------------

### Run static code analysis

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/CONTRIBUTING.md

Perform static code analysis to identify potential issues before opening a pull request.

```bash
make static-analysis
```

--------------------------------

### Access highlights

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Retrieves a collection of highlights and demonstrates accessing snippets for a specific field.

```php
$highlights = $searchResult->highlights();
```

```php
$highlight = $highlights->first();
$snippets = $highlight->snippets('title');
```

--------------------------------

### sourceRaw method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use sourceRaw to use a single wildcard pattern, an array of fields, or a boolean value to exclude document source from the result. The example sets sourceRaw to false to exclude the source.

```php
$searchResult = Book::searchQuery($query)
    ->sourceRaw(false)
    ->execute();
```

--------------------------------

### scriptFields method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Use scriptFields to retrieve a script evaluation in a search query. The example defines a script field 'final_price' using painless script that multiplies the price field by a factor parameter.

```php
$searchResult = Book::searchQuery($query)
    ->scriptFields('final_price', [
        'lang' => 'painless',
        'source' => "doc['price'].value * params.factor",
        'params' => [
            'factor' => 2,
        ],
    ])
    ->execute();
```

--------------------------------

### Access documents

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Retrieves a collection of matching documents and demonstrates accessing individual document properties.

```php
$documents = $searchResult->documents();
```

```php
$document = $documents->first();

$id = $document->id();
$content = $document->content();
```

--------------------------------

### Use should clause with builder or raw query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Shows two ways to define a should clause: using the Query::match() builder or a raw array. The should clause should appear in matching documents.

```php
// you can make a query using builder
$should = Query::match()
    ->field('title')
    ->value('The Book');

// or you can define a raw query
$should = [
    'match' => [
        'title' => 'The Book'
    ]
];

$query = Query::bool()->should($should);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Nested query with query method (builder and raw)

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/joining-queries.md

Shows two ways to define the query for a nested query: using the builder or a raw array. Both are executed with Book::searchQuery.

```php
// you can make a query using builder
$query = Query::nested()
    ->path('author')
    ->query(Query::match()->field('author.name')->query('Steven'));

// or you can define a raw query
$query = [
    'nested' => [
        'path' => 'author',
        'query' => [
            'match' => [
               'author.name' => 'Steven'
            ]
        ]
    ]
];

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Run PSR-2 style check

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/CONTRIBUTING.md

Verify that the code adheres to the PSR-2 coding style standard.

```bash
make style-check
```

--------------------------------

### Range query with lt

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Defines a less-than range on the price field. The query is executed via Book::searchQuery().

```php
$query = Query::range()
    ->field('price')
    ->lt(100);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Range query with lte

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Defines a less-than-or-equal-to range on the price field. The query is executed via Book::searchQuery().

```php
$query = Query::range()
    ->field('price')
    ->lte(100);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Search with custom routing using routing()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Specifies custom routing values to control which shards are searched.

```php
$searchResult = Book::searchQuery($query)
    ->routing(['author1', 'author2'])
    ->execute();
```

--------------------------------

### Match Phrase Prefix with analyzer

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Adds an analyzer to convert the query text into tokens.

```php
$query = Query::matchPhrasePrefix()
    ->field('title')
    ->query('My boo')
    ->analyzer('english');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Multi-Match Minimum Should Match

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines the minimum number of clauses that must match for a document to be returned.

```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book')
    ->operator('OR')
    ->minimumShouldMatch(1);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Chain search parameters to the builder

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Chains additional parameters like size and sort to refine the search request.

```php
$builder = Book::searchQuery($query)
    ->size(2)
    ->sort('price', 'asc');
```

--------------------------------

### Use mustRaw method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Builds the same must query using mustRaw with a raw array. Note that mustRaw completely replaces the must clause of the query.

```php
$query = Query::bool()->mustRaw([
    'match' => [
        'title' => 'The Book'
    ]
]);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Range query with boost

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds a boost of 2 to the range query to increase its relevance score. The query is executed via Book::searchQuery().

```php
$query = Query::range()
    ->field('price')
    ->gt(100)
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Match Phrase Prefix with zeroTermsQuery

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines what to return if the analyzer removes all tokens.

```php
$query = Query::matchPhrasePrefix()
    ->field('title')
    ->query('My boo')
    ->zeroTermsQuery('none');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Execute search query for SearchResult

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Executes the query and returns an instance of Elastic\ScoutDriverPlus\Decorators\SearchResult.

```php
$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### when method with fallback closure

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Executes the first callback when the first argument is true, otherwise executes the third closure.

```php
$searchResult = Book::searchQuery($query)
    ->when($orderBy, function ($builder, $orderBy) {
        return $builder->sort($orderBy, 'asc');
    }, function ($builder) {
         return $builder->sort('price', 'asc');
     })
    ->execute();
```

--------------------------------

### Execute the search and retrieve results

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/README.md

Executes the search query and returns a search result object. The result provides access to hits, models, documents, and highlights.

```php
$searchResult = Book::searchQuery($query)->execute();
```

```php
$hits = $searchResult->hits();
$models = $searchResult->models();
$documents = $searchResult->documents();
$highlights = $searchResult->highlights();
```

--------------------------------

### Use shouldRaw method

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Builds the same should query using shouldRaw with a raw array. Note that shouldRaw completely replaces the should clause of the query.

```php
$query = Query::bool()->shouldRaw([
    'match' => [
        'title' => 'The Book'
    ]
]);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Set multi-match prefixLength

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

The prefixLength method determines the number of beginning characters that remain unchanged during fuzzy matching.

```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book')
    ->fuzziness('AUTO')
    ->prefixLength(0);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Register container bindings in bootstrap/app.php

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/wiki/Lumen-Installation

Add this code under the 'Register Container Bindings' section in bootstrap/app.php. It binds the package's service provider bindings and extends the ElasticScoutDriver\Engine with the plus engine.

```php
foreach ((new ElasticScoutDriverPlus\ServiceProvider($app))->bindings as $abstract => $concrete) {
    $app->bind($abstract, $concrete);
}

$app->extend(ElasticScoutDriver\Engine::class, function (Laravel\Scout\Engines\Engine $engine) use ($app) {
    return $app->make(ElasticScoutDriverPlus\Engine::class, compact('engine'));
});
```

--------------------------------

### Build a term query with Query::term()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Builds a term query that matches documents containing an exact term in a provided field. Use the `field` and `value` methods to set the field and term. The query is executed with `Book::searchQuery()`.

```php
$query = Query::term()
    ->field('price')
    ->value(300);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Basic Multi-Match Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Builds a query to match documents containing a value in multiple specified fields.

```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Build a wildcard query with field and value

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Builds a wildcard query that matches documents containing terms matching the pattern 'bo*k' in the 'title' field. The query is executed via Book::searchQuery().

```php
$query = Elastic\ScoutDriverPlus\Support\Query::wildcard()
    ->field('title')
    ->value('bo*k');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Define BookResource class

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/wiki/Paginated-Resources

A basic JsonResource implementation for the Book model to define the API response structure.

```php
class BookResource extends JsonResource
{
    /**
     * @param Request $request
     * @return array
     */
    public function toArray($request): array
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'description' => $this->description,
            'isbn' => $this->isbn
        ];
    }
}
```

--------------------------------

### Access total matching documents

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Returns the total number of matching documents.

```php
$total = $searchResult->total();
```

--------------------------------

### Match Query Builder

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Basic usage of the match query to search for a specific string in a document field.

```php
$query = Query::match()
    ->field('title')
    ->query('My book');

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Enable case-insensitive wildcard matching

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Enables case-insensitive matching for the wildcard query by passing true to caseInsensitive().

```php
$query = Elastic\ScoutDriverPlus\Support\Query::wildcard()
    ->field('title')
    ->value('bo*k')
    ->caseInsensitive(true);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Match None Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Builds a query that matches no documents using Query::matchNone().

```php
$query = Query::matchNone();

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### terminateAfter method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Sets the maximum number of documents to collect for each shard.

```php
$searchResult = Book::searchQuery($query)
    ->terminateAfter(10)
    ->execute();
```

--------------------------------

### Retrieve highlighted snippets from a highlight

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Shows how to retrieve the highlighted snippets for a specific field from a highlight object.

```php
$snippets = $highlight->snippets('title');
```

--------------------------------

### Range query with gte

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Defines a greater-than-or-equal-to range on the price field. The query is executed via Book::searchQuery().

```php
$query = Query::range()
    ->field('price')
    ->gte(100);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### boost

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Sets the boost to decrease or increase the relevance scores of the query.

```APIDOC
## boost

### Description
Sets the boost to decrease or increase the relevance scores of the query.

### Method
boost(float $boost)

### Parameters
- **boost** (float) - Required - The boost value.

### Request Example
```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book')
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```
```

--------------------------------

### Query::multiMatch()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Builds a multi-match query that matches documents containing a provided text, number, date, or boolean value in multiple fields. This is the entry point for creating a multi-match query.

```APIDOC
## Query::multiMatch()

### Description
Builds a multi-match query that matches documents containing a provided text, number, date, or boolean value in multiple fields.

### Method
multiMatch()

### Parameters
None

### Request Example
```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book');

$searchResult = Book::searchQuery($query)->execute();
```

### Response
Returns a query builder instance that can be further configured with fluent methods.
```

--------------------------------

### fields

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines the fields to search in.

```APIDOC
## fields

### Description
Defines the fields to search in.

### Method
fields(array $fields)

### Parameters
- **fields** (array) - Required - The fields to search in.

### Request Example
```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book');

$searchResult = Book::searchQuery($query)->execute();
```
```

--------------------------------

### Multi-Match Auto Generate Synonyms Phrase Query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Defines whether match phrase queries should be automatically created for multi-term synonyms.

```php
$query = Query::multiMatch()
    ->fields(['title', 'description'])
    ->query('My book')
    ->autoGenerateSynonymsPhraseQuery(true);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Access models

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/search-results.md

Retrieves a collection of matching models, which are lazy-loaded from the database.

```php
$models = $searchResult->models();
```

--------------------------------

### Enable case-insensitive matching with caseInsensitive

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/term-queries.md

Adds the caseInsensitive option to the regexp query to allow case-insensitive matching. The query is executed via Book::searchQuery().

```php
$query = Query::regexp()
    ->field('title')
    ->value('b.*k')
    ->caseInsensitive(true);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Rescore search results with rescoreRaw()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Alternative rescoring method that accepts a raw array with the full rescore configuration.

```php
$searchResult = Book::searchQuery($query)
    ->rescoreRaw([
        'window_size' => 50,
        'query' => [
            'rescore_query' => [
                'match_phrase' => [
                    'message' => [
                        'query' => 'the quick brown',
                        'slop' => 2,
                    ],
                ],
            ],
            'query_weight' => 0.7,
            'rescore_query_weight' => 1.2,
        ]
    ])
    ->execute();
```

--------------------------------

### Filter search results with postFilter() using a raw query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Applies a post-filter using a raw array query. This is an alternative to using a Query object.

```php
$searchResult = Book::searchQuery($query)
    ->postFilter(['term' => ['published' => '2020-06-07']])
    ->execute();
```

--------------------------------

### Set minimumShouldMatch for should clauses

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Specifies that at least one of the should queries must match. The minimumShouldMatch value is set to 1.

```php
$query = Query::bool()
    ->should(Query::term()->field('published')->value('2018-04-23'))
    ->should(Query::term()->field('published')->value('2020-03-07'))
    ->minimumShouldMatch(1);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### Use must clause with builder or raw query

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/compound-queries.md

Shows two ways to define a must clause: using the Query::match() builder or a raw array. The must clause must appear in matching documents and contributes to the score.

```php
// you can make a query using builder
$must = Query::match()
    ->field('title')
    ->value('The Book');

// or you can define a raw query
$must = [
    'match' => [
        'title' => 'The Book'
    ]
];

$query = Query::bool()->must($must);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### trackTotalHits method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Controls how the total number of hits should be tracked.

```php
$searchResult = Book::searchQuery($query)
    ->trackTotalHits(true)
    ->execute();
```

--------------------------------

### Enable or disable request cache with requestCache()

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Enables or disables caching per request. Pass true to enable, false to disable.

```php
$searchResult = Book::searchQuery($query)
    ->requestCache(true)
    ->execute();
```

--------------------------------

### Match Boost

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/full-text-queries.md

Increases or decreases the relevance score of the query using the boost method.

```php
$query = Query::match()
    ->field('title')
    ->query('My book')
    ->boost(2);

$searchResult = Book::searchQuery($query)->execute();
```

--------------------------------

### trackScores method usage

Source: https://github.com/babenkoivan/elastic-scout-driver-plus/blob/master/docs/available-methods.md

Forces scores to be computed and tracked.

```php
$searchResult = Book::searchQuery($query)
    ->trackScores(true)
    ->execute();
```
Tokens:
Raw