Laravel Scout

https://github.com/laravel/scout
Admin
Laravel Scout provides a driver-based solution for adding full-text search capabilities to Eloquent...
Tokens:99,722
Snippets:848
Trust Score:9.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example config/scout.php

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/configuration.md

Example configuration array for Scout. It uses environment variables for driver, prefix, queue connection/name, and identify. The chunk sizes are 500 for both searchable and unsearchable. The after_commit and soft_delete options are set to false. The comment indicates additional engine sections follow.

```php
return [
    'driver' => env('SCOUT_DRIVER', 'meilisearch'),
    'prefix' => env('SCOUT_PREFIX', ''),
    'queue' => [
        'connection' => env('SCOUT_QUEUE_CONNECTION', 'redis'),
        'queue' => env('SCOUT_QUEUE_NAME', 'search'),
    ],
    'after_commit' => false,
    'chunk' => ['searchable' => 500, 'unsearchable' => 500],
    'soft_delete' => false,
    'identify' => env('SCOUT_IDENTIFY', false),
    // ... engine sections
];
```

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

### Configure job options in config/scout.php

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Example configuration for job options in the scout config file, setting tries, backoff, and max_exceptions values.

```php
'jobs' => [
    'tries' => 3,
    'backoff' => [1, 5, 10],
    'max_exceptions' => 2,
],
```

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

### Basic search with filter, limit, and order

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Example of a search query with where, whereIn, take, and orderByDesc clauses.

```php
use App\Models\Post;

$posts = Post::search('laravel')
    ->where('published', true)
    ->whereIn('category_id', [1, 2, 3])
    ->take(20)
    ->orderByDesc('created_at')
    ->get();
```

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

### Paginating results for a controller

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Example of using paginate with perPage and pageName parameters.

```php
$results = Product::search($request->input('q'))
    ->query(fn ($query) => $query->with('category'))
    ->paginate(perPage: 25, pageName: 'p');
```

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

### Semantic / hybrid search with error handling

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Example of hybrid search with try-catch for NotSupportedException and ScoutException.

```php
use Laravel\Scout\Exceptions\ScoutException;
use Laravel\Scout\Exceptions\NotSupportedException;

try {
    // Hybrid full-text + vector search (requires an engine implementing SupportsSemanticSearch).
    $results = Post::search('quantum computing')
        ->hybrid(textWeight: 2, semanticWeight: 1, minSimilarity: 0.7)
        ->take(10)
        ->get();
} catch (NotSupportedException $e) {
    // The configured engine does not support semantic search.
} catch (ScoutException $e) {
    // Empty query or invalid weights.
}
```

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

### Listening to ModelsImported and ModelsFlushed events

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Events.md

This example shows how to register listeners for both events using Event::listen. It logs the count of imported models and the keys of flushed models, and triggers a batch import with Post::makeAllSearchable().

```php
use App\Models\Post;
use Illuminate\Support\Facades\Event;
use Laravel\Scout\Events\ModelsImported;
use Laravel\Scout\Events\ModelsFlushed;

Event::listen(ModelsImported::class, function (ModelsImported $event) {
    logger('Imported chunk', ['count' => $event->models->count()]);
});

Post::makeAllSearchable();

Event::listen(ModelsFlushed::class, function (ModelsFlushed $event) {
    logger('Flushed chunk', ['ids' => $event->models->modelKeys()]);
});
```

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

### Scout usage examples

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

A set of bash commands demonstrating common Scout operations: importing with `--fresh`, queueing a chunked import with range and order, creating an index, syncing index settings, flushing, and deleting indexes.

```bash
# Import a model, flushing first.
php artisan scout:import "App\Models\Post" --fresh
```

```bash
# Queue a chunked import with explicit range and order.
php artisan scout:queue-import "App\Models\Post" --min=1 --max=100000 --chunk=1000 --order=desc
```

```bash
# Create an index for a model and apply configured settings.
php artisan scout:index "App\Models\Post"
```

```bash
# Sync index settings declared in scout.meilisearch.index-settings.
php artisan scout:sync-index-settings
```

```bash
# Flush / delete operations.
php artisan scout:flush "App\Models\Post"
php artisan scout:delete-index "posts"
php artisan scout:delete-all-indexes
```

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

### get()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Returns a collection of models from the engine's search results.

```APIDOC
## get()

### Description
Returns a collection of models via `$this->engine()->get($this)`.

### Method
get

### Signature
public function get()

### Returns
`\Illuminate\Database\Eloquent\Collection<int, TModel>` - Collection of models.
```

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

### Configure Meilisearch in config/scout.php

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Example configuration for the Meilisearch engine in config/scout.php, including host, key, index settings, and model-specific embedding settings. The embedding driver can be 'laravel-ai' or 'meilisearch' for native embeddings, with dimensions required when not native.

```php
'meilisearch' => [
    'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
    'key' => env('MEILISEARCH_KEY'),
    'index-settings' => [
        'users' => [
            'filterableAttributes' => ['id', 'name', 'email'],
        ],
    ],
    'model-settings' => [
        \App\Models\User::class => [
            'embedding' => [
                'embedder' => 'default',
                'driver' => 'laravel-ai', // or 'meilisearch' for native embeddings
                'dimensions' => 1536,
            ],
        ],
    ],
],
```

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

### createAlgoliaDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Instantiates an Algolia engine driver, choosing between Algolia3Engine and Algolia4Engine based on the installed Algolia client version.

```APIDOC
## createAlgoliaDriver()

### Description
Instantiates an Algolia engine driver. Selects `Algolia3Engine` or `Algolia4Engine` depending on the installed Algolia client version (`Algolia::VERSION >= 4.0.0`).

### Method
`createAlgoliaDriver`

### Signature
`public function createAlgoliaDriver()`

### Returns
- **\Laravel\Scout\Engines\AlgoliaEngine** - The Algolia engine instance.

### Configuration Details
- Uses `configureAlgolia3Driver()` or `configureAlgolia4Driver()` which call `Algolia*Engine::make(config: config('scout.algolia'), headers: ..., softDelete: config('scout.soft_delete'))`.
- The user-agent registers `Laravel Scout` + version.
- `defaultAlgoliaHeaders()` returns `[]` unless `config('scout.identify')` is truthy; it then adds `X-Forwarded-For` (only when `app.debug` is off and the request IP is a valid non-private/reserved IP) and `X-Algolia-UserToken` (the authenticated user's `getKey()`).
```

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

### Registering listener in EventServiceProvider

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Events.md

This example shows how to register a listener for ModelsImported using the $listen property of an EventServiceProvider. The listener class is specified as App\Listeners\HandleSearchIndexImported.

```php
use Illuminate\Foundation\Support\Providers\EventServiceProvider;
use Laravel\Scout\Events\ModelsImported;
use App\Listeners\HandleSearchIndexImported;

class EventServiceProvider extends EventServiceProvider
{
    protected $listen = [
        ModelsImported::class => [HandleSearchIndexImported::class],
    ];
}
```

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

### Applying SearchUsingPrefix to toSearchableArray

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Attributes.md

Example of using the SearchUsingPrefix attribute on the toSearchableArray method to enable prefix matching on the 'username' column.

```php
use Laravel\Scout\Attributes\SearchUsingPrefix;

#[SearchUsingPrefix('username')]
public function toSearchableArray(): array
{
    return ['id' => $this->id, 'username' => $this->username];
}
```

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

### Intercepting raw engine results before hydration

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Example of using withRawResults to inspect or modify raw engine output before hydration.

```php
$raw = Post::search('laravel')
    ->withRawResults(fn ($results) => $results) // inspect/modify raw engine output
    ->raw();
```

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

### Basic model setup with Searchable trait

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Use the Searchable trait in an Eloquent model. Define toSearchableArray() to specify the fields indexed and searchableAs() to set the index name.

```php
use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    public function toSearchableArray(): array
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'body' => $this->body,
            'author' => $this->author->name,
        ];
    }

    public function searchableAs(): string
    {
        return 'posts_index';
    }
}
```

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

### MakeRangeSearchable constructor signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Constructor signature for MakeRangeSearchable, accepting the model class name and inclusive start and end IDs.

```php
public function __construct($class, $start, $end)
```

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

### Search, Semantic Search, and Hybrid Search with Turbopuffer

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Turbopuffer.md

Examples of using Laravel Scout's search method with Turbopuffer. Includes basic search with filters, semantic search with a similarity threshold, and hybrid search with RRF weights.

```php
use App\Models\Product;

$products = Product::search('wireless mouse')
    ->where('price', '<=', 50)
    ->take(10)
    ->get();

// Semantic search.
$products = Product::search('ergonomic keyboard')->semantic(0.8)->get();

// Hybrid search with RRF weights.
$products = Product::search('mechanical keyboard')
    ->hybrid(textWeight: 1, semanticWeight: 2, minSimilarity: 0.6)
    ->paginate(20);
```

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

### Search with filters, ordering, semantic and hybrid modes

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Examples of using Laravel Scout's search builder with filters, ordering, semantic search, hybrid search, and pre-computed query vectors. The semantic method accepts a threshold, hybrid uses text and semantic weights, and options can supply a vector.

```php
use App\Models\User;

$users = User::search('taylor')
    ->where('active', true)
    ->whereIn('team_id', [1, 2])
    ->orderByDesc('created_at')
    ->take(20)
    ->get();

// Semantic search.
$users = User::search('senior backend engineer')->semantic(0.75)->get();

// Hybrid search (semanticRatio derived from weights).
$users = User::search('backend engineer')
    ->hybrid(textWeight: 3, semanticWeight: 1)
    ->paginate(15);

// Supplying a pre-computed query vector.
$users = User::search('query text')
    ->options(['vector' => [0.1, 0.2, /* ... 1536 dims ... */]])
    ->semantic()
    ->get();
```

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

### Scoped import with ModelsImported

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Events.md

This example shows a scoped import that filters models by status and uses a chunk size of 200. Each chunk fires ModelsImported with up to 200 models.

```php
Post::where('status', 'published')->searchable(200);

// Each chunk fires ModelsImported with up to 200 models.
```

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

### Custom Engine Implementation (MyEngine)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine.md

Extend Laravel\Scout\Engines\Engine and implement all abstract methods. The search() method should return a raw result array with 'hits' and 'total' keys, which the base get()/cursor() methods will map. Register the engine by adding a create<Driver>Driver() method to a custom manager or by extending EngineManager and overriding getDefaultDriver().

```php
use Laravel\Scout\Builder;
use Laravel\Scout\Engines\Engine;
use Illuminate\Support\Collection;

class MyEngine extends Engine
{
    public function update($models) { /* index $models */ }
    public function delete($models) { /* remove $models */ }

    public function search(Builder $builder)
    {
        // Return a raw result array; the base get()/cursor() will map it via map().
        return ['hits' => [...], 'total' => ...];
    }

    public function paginate(Builder $builder, $perPage, $page) { /* raw paged results */ }
    public function mapIds($results) { return collect($results['hits'])->pluck('id'); }
    public function map(Builder $builder, $results, $model) { /* hydrate models */ }
    public function lazyMap(Builder $builder, $results, $model) { /* lazy hydrate */ }
    public function getTotalCount($results) { return $results['total']; }
    public function flush($model) { /* drop all docs */ }
    public function createIndex($name, array $options = []) { /* create index */ }
    public function deleteIndex($name) { /* delete index */ }
}
```

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

### Constructor

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Initializes the Meilisearch engine with a Meilisearch client, soft-delete flag, and configuration array.

```APIDOC
## Constructor

### Description
Initializes the Meilisearch engine with a Meilisearch client, soft-delete flag, and configuration array.

### Method
`__construct`

### Signature
```php
public function __construct(MeilisearchClient $meilisearch, $softDelete = false, array $config = [])
```

### Parameters
- **$meilisearch** (Meilisearch\Client) - Required - Meilisearch client (container singleton).
- **$softDelete** (bool) - Optional - Default: `false` - Whether Scout soft-delete metadata is pushed.
- **$config** (array) - Optional - Default: `[]` - The `scout.meilisearch` config (used for `model-settings`).

### Return
- `void`
```

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

### make(array $config, array $headers, bool $softDelete = false)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Static factory method to create an Algolia3Engine instance with the given configuration, headers, and soft-delete flag.

```APIDOC
## make(array $config, array $headers, bool $softDelete = false)

### Description
Creates a new Algolia3Engine instance using the provided configuration and headers. The configuration should contain the Algolia application ID and secret, and optionally timeout and batch size settings.

### Method
static

### Endpoint
N/A (PHP method)

### Parameters
- **$config** (array) - Required - The `scout.algolia` configuration array containing `id`, `secret`, and optional `connect_timeout`, `read_timeout`, `write_timeout`, `batch_size`.
- **$headers** (array) - Required - Default headers (identity headers from `EngineManager`).
- **$softDelete** (bool) - Optional - Default: `false` - Soft-delete flag.

### Returns
- **static** - A new instance of Algolia3Engine.

### Example
```php
$engine = Algolia3Engine::make($config, $headers, $softDelete);
```
```

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

### Batch import and flush with makeAllSearchable and removeAllFromSearch

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Import all posts into the index in chunks of 500 by default, queue the full import if a queue driver is configured, or remove all posts from the index.

```php
// Import all posts into the index (chunked by 500 by default).
Post::makeAllSearchable();

// Queue the full import instead (queue driver must be configured).
Post::makeAllSearchableQuery()->searchable();

// Remove every post from the index.
Post::removeAllFromSearch();
```

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

### Algolia4Engine::make

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Static factory method to create an Algolia4Engine instance with configuration, headers, and optional soft delete support.

```APIDOC
## `make(array $config, array $headers, bool $softDelete = false)`

### Description
Creates a new Algolia4Engine instance using the provided configuration and headers. It constructs an Algolia4SearchConfig with the app ID and API key from the config, applies default headers and optional timeouts, and creates an Algolia4SearchClient via `createWithConfig`.

### Method
Static method

### Signature
`public static function make(array $config, array $headers, bool $softDelete = false)`

### Parameters
- **$config** (array) - Required - Configuration array containing 'id' (app ID) and 'secret' (API key).
- **$headers** (array) - Required - Additional headers to pass to the Algolia client.
- **$softDelete** (bool) - Optional - Whether to enable soft delete support. Defaults to false.

### Returns
- **Algolia4Engine** - The created engine instance.
```

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

### Constructor

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Turbopuffer.md

Creates a new TurbopufferEngine instance with the given Turbopuffer client, configuration, and soft-delete flag.

```APIDOC
## Constructor

### Description
Creates a new TurbopufferEngine instance.

### Parameters
- `$turbopuffer` (TurbopufferClient) - Required - HTTP client (container singleton).
- `$config` (array) - Optional - `scout.turbopuffer` config (model-settings). Default: `[]`.
- `$softDelete` (bool) - Optional - Whether soft-delete metadata is pushed. Default: `false`.

### Example
```php
new TurbopufferEngine($turbopuffer, $config, $softDelete)
```
```

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

### deleteAllIndexes()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Deletes all indexes whose UID starts with the configured Scout prefix. Returns an array of delete task results.

```APIDOC
## deleteAllIndexes()

### Description
Deletes all indexes whose UID starts with the configured Scout prefix. Returns an array of delete task results.

### Method
deleteAllIndexes

### Signature
`public function deleteAllIndexes()`

### Parameters
None

### Returns
- **array** - Array of delete task results.
```

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

### Direct usage of TurbopufferClient

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/TurbopufferServices.md

Shows how to access the client via the container and perform query, write (upsert/delete), and delete operations on a namespace.

```php
use Laravel\Scout\Services\Turbopuffer\TurbopufferClient;

$client = app(TurbopufferClient::class);

// Query a namespace.
$results = $client->namespace('products')->query([
    'rank_by' => [['title', 'BM25', 'wireless mouse']],
    'limit' => 10,
]);

// Upsert rows / delete rows.
$client->namespace('products')->write([
    'upsert_rows' => [['id' => 1, 'title' => 'Wireless Mouse']],
]);
$client->namespace('products')->write(['deletes' => [1, 2]]);

// Delete the whole namespace.
$client->namespace('products')->delete();
```

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

### Search with filters, semantic, and hybrid search

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Typesense.md

Shows how to use the Book model's search method with where, whereIn, orderByDesc, and paginate. Also demonstrates semantic search with a native embedder and hybrid search with textWeight, semanticWeight, and minSimilarity parameters.

```php
use App\Models\Book;

$books = Book::search('sci-fi')
    ->where('rating', '>=', 4.5)
    ->whereIn('genre', ['fiction', 'space-opera'])
    ->orderByDesc('created_at')
    ->paginate(20);

// Semantic search (native embedder: Typesense embeds the query itself).
$books = Book::search('space adventure')->semantic(0.7)->get();

// Hybrid search.
$books = Book::search('space adventure')
    ->hybrid(textWeight: 1, semanticWeight: 2, minSimilarity: 0.6)
    ->take(25)
    ->get();
```

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

### Swap unique job classes in a service provider

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

In a service provider's boot method, use Scout::makeSearchableUsing and Scout::removeFromSearchUsing to swap in unique job classes for searchable and removal operations.

```php
use Illuminate\Support\ServiceProvider;
use Laravel\Scout\Scout;
use Laravel\Scout\Jobs\MakeSearchableUniquely;
use Laravel\Scout\Jobs\RemoveFromSearchUniquely;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Scout::makeSearchableUsing(MakeSearchableUniquely::class);
        Scout::removeFromSearchUsing(RemoveFromSearchUniquely::class);
    }
}
```

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

### MakeRangeSearchable class definition

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Defines the MakeRangeSearchable job with properties for class, start, end, and failOnTimeout. It implements ShouldQueue and uses the Queueable trait.

```php
class MakeRangeSearchable implements ShouldQueue
{
    use Queueable;

    public $class; // string
    public $start; // int
    public $end;   // int
    public $failOnTimeout = true;
}
```

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

### Resolve an engine directly with Scout::engine

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Use Scout::engine('meilisearch') to resolve an engine instance. The example checks that the returned engine is an instance of MeilisearchEngine.

```php
use Laravel\Scout\Scout;
use Laravel\Scout\Engines\MeilisearchEngine;

$engine = Scout::engine('meilisearch');
// $engine instanceof MeilisearchEngine
```

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

### make method signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Static factory method that creates an Algolia3Engine instance from configuration, headers, and optional soft delete flag.

```php
public static function make(array $config, array $headers, bool $softDelete = false)
```

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

### Applying SearchUsingFullText to toSearchableArray

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Attributes.md

Example of using the SearchUsingFullText attribute on the toSearchableArray method to enable full-text search on the 'body' column with phrase mode and English language.

```php
use Laravel\Scout\Attributes\SearchUsingFullText;

#[SearchUsingFullText(['body'], ['mode' => 'phrase', 'language' => 'english'])]
public function toSearchableArray(): array
{
    return ['id' => $this->id, 'title' => $this->title, 'body' => $this->body];
}
```

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

### scout:sync-index-settings command signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

Reads scout.<driver>.index-settings and calls updateIndexSettings() for each entry. Errors out when the engine does not implement UpdatesIndexSettings.

```bash
scout:sync-index-settings {--driver= : Engine driver (defaults to scout.driver)}
```

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

### searchableUsing() Hook

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Returns the engine instance from the EngineManager.

```php
public function searchableUsing()
```

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

### Using where with comparison operator in Scout 11

Source: https://github.com/laravel/scout/blob/11.x/UPGRADE.md

In Scout 11.x, the where method supports comparison operators like '>', '<', '>=', '<=', and '!='. This example searches all users and filters those with age greater than 30.

```php
User::search('*')->where('age', '>', 30)->get();
```

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

### createDatabaseDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Creates a Database engine driver by instantiating a new DatabaseEngine.

```APIDOC
## createDatabaseDriver()

### Description
Creates a Database engine driver by instantiating a new `DatabaseEngine`.

### Method
`createDatabaseDriver`

### Signature
`public function createDatabaseDriver()`

### Returns
- **\Laravel\Scout\Engines\DatabaseEngine** - The Database engine instance.
```

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

### Search and temporarily disable auto-syncing with withoutSyncingToSearch

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Perform a search using the search() method and get results. Use withoutSyncingToSearch() to temporarily disable auto-syncing during a bulk operation.

```php
$results = Post::search('scout')->get();

// Temporarily disable auto-syncing around a bulk operation.
Post::withoutSyncingToSearch(function () {
    Post::query()->update(['status' => 'draft']);
});
```

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

### modelSettings($model)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Typesense.md

Returns the model-specific settings from the configuration array.

```APIDOC
## modelSettings($model)

### Description
Returns the model-specific settings from the configuration array.

### Method
modelSettings

### Signature
`protected function modelSettings($model): array`

### Parameters
- **$model** (mixed) - Required - The model to retrieve settings for.

### Return Value
- **array** - The model settings, or an empty array if not found.

### Implementation
`$this->config['model-settings'][get_class($model)] ?? []`

```

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

### Sync index settings from service provider or tinker

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Example of updating Meilisearch index settings programmatically using Scout::engine('meilisearch')->updateIndexSettings, including filterable attributes and embedder configuration.

```php
use Laravel\Scout\Scout;

Scout::engine('meilisearch')->updateIndexSettings('users', [
    'filterableAttributes' => ['id', 'name', 'email'],
    'embedders' => [
        'default' => ['source' => 'userProvided', 'dimensions' => 1536],
    ],
]);
```

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

### TypesenseEngine constructor signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Typesense.md

Constructor accepts a Typesense client, max total results (from scout.typesense.max_total_results, default 1000), and optional config array. The maxPerPage is fixed at 250.

```php
public function __construct(Typesense $typesense, int $maxTotalResults, array $config = [])
```

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

### scout:queue-import command signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

Command signature for chunked, queued import. Options include --min/--max for ID range, --chunk for records per job, --order (asc/desc), and --queue. Throws ScoutException if model not found, prints errors for non-numeric primary key and info for no records or inverted range.

```bash
scout:queue-import {model} {--min= : Minimum ID} {--max= : Maximum ID} {--c|chunk= : Records per job (defaults to scout.chunk.searchable)} {--order=asc : 'asc' or 'desc'} {--queue= : Queue (defaults to scout.queue.queue)}
```

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

### scout:index command signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

Creates an index and syncs its settings. The name argument can be an index name or a model class name. The --key option sets the primary key passed to createIndex().

```bash
scout:index {name} {--k|key= : The name of the primary key}
```

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

### Search with collection engine

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Collection-Null.md

Demonstrates using the collection engine for in-memory searching. The first query performs a substring match with filters and ordering; the second returns all filtered models ordered by key descending.

```php
use App\Models\Post;

// Substring match against every scalar value in toSearchableArray().
$posts = Post::search('laravel')
    ->where('published', true)
    ->whereIn('status', ['draft', 'published'])
    ->orderByDesc('id')
    ->take(10)
    ->get();

// Empty query returns all (filtered) models ordered by key desc.
$all = Post::search('*')->get();
```

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

### AlgoliaEngine::createIndex

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Throws NotSupportedException because Algolia indexes are created automatically.

```APIDOC
## AlgoliaEngine::createIndex

### Description
Throws NotSupportedException because Algolia indexes are created automatically.

### Method
`public function createIndex($name, array $options = [])`

### Parameters
- **$name** (string) - Required - The index name.
- **$options** (array) - Optional - Default: `[]` - Additional options.

### Throws
`NotSupportedException` - Always thrown.

```

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

### createCollectionDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Creates a Collection engine driver by instantiating a new CollectionEngine.

```APIDOC
## createCollectionDriver()

### Description
Creates a Collection engine driver by instantiating a new `CollectionEngine`.

### Method
`createCollectionDriver`

### Signature
`public function createCollectionDriver()`

### Returns
- **\Laravel\Scout\Engines\CollectionEngine** - The Collection engine instance.
```

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

### bootSearchable() method signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Static method that registers the global SearchableScope and attaches a ModelObserver when the model is booted. Auto-invoked by Eloquent's trait booting convention.

```php
public static function bootSearchable()
```

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

### Configure database driver in config/scout.php

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Database.md

Sets the Scout driver to 'database' via the SCOUT_DRIVER environment variable.

```php
'driver' => env('SCOUT_DRIVER', 'database'),
```

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

### first()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Returns the first model from the search results, or null if none.

```APIDOC
## first()

### Description
Returns the first model of `$this->get()`.

### Method
first

### Signature
public function first()

### Returns
`TModel` or `null` - The first model.
```

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

### AlgoliaEngine::__construct

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Creates a new AlgoliaEngine instance with the given Algolia client and soft-delete flag.

```APIDOC
## AlgoliaEngine::__construct

### Description
Creates a new AlgoliaEngine instance with the given Algolia client and soft-delete flag.

### Method
Constructor

### Signature
`public function __construct($algolia, $softDelete = false)`

### Parameters
- **$algolia** (TAlgoliaClient) - Required - Algolia search client.
- **$softDelete** (bool) - Optional - Default: `false` - Whether soft-delete metadata is pushed.

```

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

### Configure Typesense engine in config/scout.php

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Typesense.md

Defines the 'typesense' engine configuration in config/scout.php, including client settings, max_total_results, model-settings for the Book model, and import_action. The model-settings include collection-schema, search-parameters, and embedding configuration.

```php
'typesense' => [
    'client-settings' => [
        'api_key' => env('TYPESENSE_API_KEY', 'xyz'),
        'nodes' => [
            ['host' => env('TYPESENSE_HOST', 'localhost'), 'port' => env('TYPESENSE_PORT', '8108'),
             'path' => '', 'protocol' => 'http'],
        ],
        // ...
    ],
    'max_total_results' => 1000,
    'model-settings' => [
        \App\Models\Book::class => [
            'collection-schema' => [
                'fields' => [
                    ['name' => 'id', 'type' => 'string'],
                    ['name' => 'title', 'type' => 'string'],
                ],
                'default_sorting_field' => 'created_at',
            ],
            'search-parameters' => ['query_by' => 'title'],
            'embedding' => ['attribute' => 'embedding', 'driver' => 'laravel-ai', 'dimensions' => 1536],
        ],
    ],
    'import_action' => 'upsert',
],
```

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

### scout:index

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

Creates a search index and syncs its settings. Accepts an index name or model class name, and an optional primary key option.

```APIDOC
## scout:index

### Description
Creates a search index and syncs its settings.

### Command
`scout:index {name} {--k|key= : The name of the primary key}`

### Arguments
- **name** (string) - Required - Index name or model class name.

### Options
- **-k, --key** (string) - Optional - Primary key passed as `['primaryKey' => ...]` to `createIndex()`.

### Behavior
Resolves the fully-qualified index name via `indexName()`: a model class name becomes `(new $name)->indexableAs()`, otherwise the `scout.prefix` is prepended (unless already present). Calls `createIndex()` (which swallows `NotSupportedException`), then, when the engine implements `UpdatesIndexSettings`, applies `scout.<driver>.index-settings.<name>` / `.<class>` (with the soft-delete filter appended via `configureSoftDeleteFilter()` when enabled and the model uses soft deletes).
```

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

### hybrid($textWeight = 1, $semanticWeight = 1, $minSimilarity = null)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Enables hybrid search combining full-text and semantic legs with configurable weights and optional minimum similarity. Throws exceptions for empty queries or invalid weights.

```APIDOC
## hybrid($textWeight = 1, $semanticWeight = 1, $minSimilarity = null)

### Description
Enables hybrid search combining full-text and semantic legs with configurable weights and optional minimum similarity. Throws exceptions for empty queries or invalid weights.

### Method
`hybrid($textWeight = 1, $semanticWeight = 1, $minSimilarity = null)`

### Parameters
- `$textWeight` (int|float) - Optional - Default: `1`. Weight of the full-text leg.
- `$semanticWeight` (int|float) - Optional - Default: `1`. Weight of the semantic leg.
- `$minSimilarity` (int|float|null) - Optional - Default: `null`. Minimum similarity threshold.

### Return Value
Returns `$this` (Builder instance).

### Exceptions
- `ScoutException` - Thrown when the query is empty with message "Hybrid searches require a non-empty query."
- `ScoutException` - Thrown when either weight is not numeric or is `<= 0` with message "Hybrid search weights must be positive numbers."
```

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

### options(array $options)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Replaces the engine-specific options for the search request. Returns the Builder instance.

```APIDOC
## options(array $options)

### Description
Replaces the engine-specific options for the search request. Returns the Builder instance.

### Method
`options(array $options)`

### Parameters
- `$options` (array) - Required - Engine-specific options merged into the search request (e.g. `vector`, `filters`, `rank_by`).

### Return Value
Returns `$this` (Builder instance).
```

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

### makeAllSearchable($chunk = null)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Makes all models searchable by chunking the query and importing each chunk. Returns void.

```APIDOC
## makeAllSearchable($chunk = null)

### Description
Makes all models searchable by chunking the query and importing each chunk. Returns void.

### Method
Static method

### Signature
```php
public static function makeAllSearchable($chunk = null)
```

### Parameters
- **$chunk** (int|null) - Default: `null` - Chunk size; defaults to `config('scout.chunk.searchable', 500)`.

### Returns
`void` - Calls `static::makeAllSearchableQuery()->searchable($chunk)` (the `searchable` macro installed by `SearchableScope`), chunking by primary key and importing each chunk.
```

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

### createMeilisearchDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Creates a Meilisearch engine driver using the container-bound Meilisearch\Client.

```APIDOC
## createMeilisearchDriver()

### Description
Creates a Meilisearch engine driver using the container-bound `Meilisearch\Client`.

### Method
`createMeilisearchDriver`

### Signature
`public function createMeilisearchDriver()`

### Returns
- **\Laravel\Scout\Engines\MeilisearchEngine** - The Meilisearch engine instance.

### Configuration Details
- Passes the container `Meilisearch\Client`, `config('scout.soft_delete', false)`, and `config('scout.meilisearch', [])`.
```

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

### TurbopufferEngine class definition

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Turbopuffer.md

Shows the class declaration and constructor signature. The constructor accepts a TurbopufferClient, optional config array, and soft delete flag.

```php
class TurbopufferEngine extends Engine implements SupportsSemanticSearch
{
    public function __construct(
        protected TurbopufferClient $turbopuffer,
        protected array $config = [],
        protected bool $softDelete = false
    ) { /* ... */ }
    // ...
}
```

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

### semantic($minSimilarity = null)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Enables semantic search with an optional minimum similarity threshold. Throws an exception if the query is empty.

```APIDOC
## semantic($minSimilarity = null)

### Description
Enables semantic search with an optional minimum similarity threshold. Throws an exception if the query is empty.

### Method
`semantic($minSimilarity = null)`

### Parameters
- `$minSimilarity` (int|float|null) - Optional - Default: `null`. Minimum similarity threshold for results.

### Return Value
Returns `$this` (Builder instance).

### Exceptions
- `Laravel\Scout\Exceptions\ScoutException` - Thrown when `trim($this->query) === ''` with message "Semantic searches require a non-empty query."
```

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

### syncWithSearchUsing() Hook

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Returns the queue connection name for syncing, using the scout.queue.connection config or the default queue connection.

```php
public function syncWithSearchUsing()
```

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

### TurbopufferClient class constructor

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/TurbopufferServices.md

Constructor for TurbopufferClient, which wraps Illuminate\Http\Client\Factory and accepts the scout.turbopuffer config array. Registered as a container singleton by ScoutServiceProvider::register().

```php
class TurbopufferClient
{
    public function __construct(
        protected Factory $http,
        protected array $config
    ) { /* ... */ }
    // ...
}
```

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

### Queue full import via artisan command

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Command to queue a full import of a model using the scout:queue-import artisan command with specified options for range, chunk size, and order.

```bash
php artisan scout:queue-import "App\Models\Post" --min=1 --max=100000 --chunk=1000 --order=desc
```

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

### Publish Scout Config with artisan vendor:publish

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/configuration.md

Run this Artisan command to publish the Scout configuration file to config/scout.php. The --provider flag specifies the Laravel\Scout\ScoutServiceProvider.

```bash
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
```

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

### take($limit)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Builder.md

Sets the maximum number of results to return. Returns the Builder instance for chaining.

```APIDOC
## take($limit)

### Description
Sets the maximum number of results to return. Returns the Builder instance for chaining.

### Method
`take($limit)`

### Parameters
- `$limit` (int) - Required - Maximum number of results.

### Return Value
Returns `$this` (Builder instance).
```

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

### Configure collection engine as default driver

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Collection-Null.md

Sets the default Scout driver to the collection engine via the SCOUT_DRIVER environment variable, with 'collection' as the fallback.

```php
// config/scout.php
'driver' => env('SCOUT_DRIVER', 'collection'),
```

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

### Enable unique job variants in a service provider

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Use this in a service provider to replace the default searchable and removal jobs with their unique variants. Requires importing the Scout facade and the two job classes.

```php
use Laravel\Scout\Scout;
use Laravel\Scout\Jobs\MakeSearchableUniquely;
use Laravel\Scout\Jobs\RemoveFromSearchUniquely;

Scout::makeSearchableUsing(MakeSearchableUniquely::class);
Scout::removeFromSearchUsing(RemoveFromSearchUniquely::class);
```

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

### createNullDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Creates a Null engine driver by instantiating a new NullEngine.

```APIDOC
## createNullDriver()

### Description
Creates a Null engine driver by instantiating a new `NullEngine`.

### Method
`createNullDriver`

### Signature
`public function createNullDriver()`

### Returns
- **\Laravel\Scout\Engines\NullEngine** - The Null engine instance.
```

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

### createIndex($name, array $options = [])

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Typesense.md

Attempts to create an index but always throws NotSupportedException because Typesense indexes are created automatically upon adding objects.

```APIDOC
## createIndex($name, array $options = [])

### Description
Throws NotSupportedException because Typesense indexes are created automatically upon adding objects.

### Method
createIndex

### Signature
`public function createIndex($name, array $options = [])`

### Parameters
- **$name** (string) - Required - The name of the index.
- **$options** (array) - Optional - Additional options for index creation.

### Exceptions
- `NotSupportedException`

```

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

### searchableUsing()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Returns the engine instance used for searching.

```APIDOC
## searchableUsing()

### Description
Returns the engine instance used for searching.

### Method
searchableUsing()

### Signature
`public function searchableUsing()`

### Returns
mixed - `app(EngineManager::class)->engine()`.
```

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

### AlgoliaEngine constructor

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Algolia.md

Constructor for AlgoliaEngine. Accepts the Algolia client and an optional soft-delete flag (default false).

```php
public function __construct($algolia, $softDelete = false)
```

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

### createTurbopufferDriver()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Scout.md

Creates a Turbopuffer engine driver using the container-bound TurbopufferClient.

```APIDOC
## createTurbopufferDriver()

### Description
Creates a Turbopuffer engine driver using the container-bound `TurbopufferClient`.

### Method
`createTurbopufferDriver`

### Signature
`public function createTurbopufferDriver()`

### Returns
- **\Laravel\Scout\Engines\TurbopufferEngine** - The Turbopuffer engine instance.
```

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

### scout:sync-index-settings

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Console.md

Syncs index settings for all configured indexes. Reads settings from configuration and calls updateIndexSettings() for each entry.

```APIDOC
## scout:sync-index-settings

### Description
Syncs index settings for all configured indexes.

### Command
`scout:sync-index-settings {--driver= : Engine driver (defaults to scout.driver)}`

### Options
- **--driver** (string) - Optional - Engine driver (defaults to `scout.driver`).

### Behavior
Reads `scout.<driver>.index-settings` and calls `updateIndexSettings()` for each entry. Index names that are model classes resolve via `indexableAs()`; soft-delete filters are appended for soft-delete models.

### Errors
Errors out when the engine does not implement `UpdatesIndexSettings`.
```

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

### search($query = '', $callback = null)

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Performs a search query against the search engine. Returns a Scout Builder instance configured with the model, query, callback, and soft delete setting.

```APIDOC
## search($query = '', $callback = null)

### Description
Performs a search query against the search engine. Returns a Scout Builder instance configured with the model, query, callback, and soft delete setting.

### Method
Static method

### Signature
```php
public static function search($query = '', $callback = null)
```

### Parameters
- **$query** (string) - Default: `''` - The query expression.
- **$callback** (\Closure|null) - Default: `null` - Engine search callback.

### Returns
`\Laravel\Scout\Builder<static>` - Resolves `static::$scoutBuilder ?? Builder::class` from the container with `model` (new static), `query`, `callback`, and `softDelete` (`usesSoftDelete() && config('scout.soft_delete', false)`).
```

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

### createIndex($name, array $options = [])

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Creates a new index with the given name and options, or returns the existing index if it already exists.

```APIDOC
## createIndex($name, array $options = [])

### Description
Creates a new index with the given name and options, or returns the existing index if it already exists.

### Method
createIndex

### Signature
`public function createIndex($name, array $options = [])`

### Parameters
- **$name** (string) - Required - The name of the index.
- **$options** (array) - Optional - Additional options for index creation.

### Returns
- **mixed** - The created index or existing index.

### Throws
- **\Meilisearch\Exceptions\ApiException** - Thrown for errors other than 404 (which is swallowed).
```

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

### MeilisearchEngine constructor signature

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Engine-Meilisearch.md

Constructor signature for the engine. Accepts a Meilisearch client, an optional soft-delete flag, and an optional config array for model settings.

```php
public function __construct(MeilisearchClient $meilisearch, $softDelete = false, array $config = [])
```

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

### searchableSync()

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Searchable.md

Synchronously indexes the current model instance using the searchableSync macro.

```APIDOC
## searchableSync()

### Description
Synchronously indexes the current model instance using the searchableSync macro.

### Method
searchableSync()

### Signature
`public function searchableSync()`

### Returns
void
```

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

### MakeSearchable handle method

Source: https://github.com/laravel/scout/blob/11.x/_autodocs/api-reference/Jobs.md

Handle method for MakeSearchable that returns void. It no-ops on empty collections, otherwise it calls makeSearchableUsing and searchableUsing to update the index.

```php
public function handle()
```
Tokens:
Raw