Laravel Scout

composer require laravel/scout

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

<?php

namespace App\Models;

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

class Post extends Model
{
    use Searchable;
}

'queue' => true,

'queue' => [
    'connection' => 'redis',
    'queue' => 'scout'
],

php artisan queue:work redis --queue=scout

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

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

composer require algolia/algoliasearch-client-php

ALGOLIA_APP_ID=your-app-id
ALGOLIA_SECRET=your-secret-key

use App\Models\User;

'algolia' => [
    'id' => env('ALGOLIA_APP_ID', ''),
    'secret' => env('ALGOLIA_SECRET', ''),
    'index-settings' => [
        User::class => [
            'searchableAttributes' => ['id', 'name', 'email'],
            'attributesForFaceting' => ['filterOnly(email)'],
        ],
    ],
],

php artisan scout:sync-index-settings

# Laravel Sail을 사용하는 경우
./vendor/bin/sail up -d meilisearch

docker run -it --rm \
    -p 7700:7700 \
    getmeili/meilisearch:latest \
    meilisearch --master-key="masterKey"

composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle

SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey

use App\Models\User;

'meilisearch' => [
    'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
    'key' => env('MEILISEARCH_KEY', null),
    'index-settings' => [
        User::class => [
            'filterableAttributes' => ['id', 'name', 'email'],
            'sortableAttributes' => ['created_at'],
        ],
    ],
],

public function toSearchableArray(): array
{
    return [
        'id' => (int) $this->id,
        'name' => $this->name,
        'price' => (float) $this->price,
    ];
}

php artisan scout:sync-index-settings

'meilisearch' => [
    'index-settings' => [
        Article::class => [
            'embedders' => [
                'default' => [
                    'source' => 'userProvided',
                    'dimensions' => 1536,
                ],
            ],
        ],
    ],
    'model-settings' => [
        Article::class => [
            'embedding' => [
                'embedder' => 'default',
                'dimensions' => 1536,
            ],
        ],
    ],
],

composer require typesense/typesense-php

SCOUT_DRIVER=typesense
TYPESENSE_API_KEY=masterKey
TYPESENSE_HOST=localhost
TYPESENSE_PORT=8108
TYPESENSE_PATH=
TYPESENSE_PROTOCOL=http

public function toSearchableArray(): array
{
    return array_merge($this->toArray(), [
        'id' => (string) $this->id,
        'created_at' => $this->created_at->timestamp,
    ]);
}

use App\Models\Article;

'model-settings' => [
    Article::class => [
        'collection-schema' => [
            'fields' => [
                ['name' => 'title', 'type' => 'string'],
                ['name' => 'embedding', 'type' => 'float[]', 'num_dim' => 1536],
            ],
        ],
        'search-parameters' => ['query_by' => 'title'],
        'embedding' => [
            'attribute' => 'embedding',
            'dimensions' => 1536,
        ],
    ],
],

public function toSearchableEmbedding(): string|array
{
    return $this->title.' '.$this->body;
}

SCOUT_DRIVER=turbopuffer
TURBOPUFFER_API_KEY=tpuf_...
TURBOPUFFER_REGION=gcp-us-central1

SCOUT_DRIVER=database

Schema::ensureVectorExtensionExists();

Schema::table('articles', function (Blueprint $table) {
    $table->vector('embedding', dimensions: 1536)->nullable();
    $table->vectorIndex('embedding');
    $table->fullText(['title', 'body']);
});

SCOUT_DRIVER=collection

'turbopuffer' => [
    'model-settings' => [
        Article::class => [
            'searchable-attributes' => [
                'title' => 3,
                'body' => 1,
            ],
            'schema' => [
                'title' => ['type' => 'string', 'full_text_search' => true],
                'body' => ['type' => 'string', 'full_text_search' => true],
                'status' => ['type' => 'string'],
            ],
        ],
    ],
],

'embedding' => [
    'attribute' => 'embedding',
    'dimensions' => 1536,
],

'schema' => [
    'embedding' => ['type' => '[1536]f32', 'ann' => true],
],

'embedding' => [
    'driver' => 'turbopuffer',
    'attribute' => 'embedding_text',
],

<?php

namespace App\Models;

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

class Post extends Model
{
    use Searchable;

    /**
     * 모델의 인덱스 가능한 데이터 배열을 취득합니다.
     *
     * @return array<string, mixed>
     */
    public function toSearchableArray(): array
    {
        $array = $this->toArray();

        // 데이터를 커스터마이즈...

        return $array;
    }
}

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

use Laravel\Scout\Attributes\SearchUsingFullText;
use Laravel\Scout\Attributes\SearchUsingPrefix;

#[SearchUsingPrefix(['id', 'email'])]
#[SearchUsingFullText(['bio'])]
public function toSearchableArray(): array
{
    return [
        'id' => $this->id,
        'name' => $this->name,
        'email' => $this->email,
        'bio' => $this->bio,
    ];
}

/**
 * 이 모델을 검색 가능하게 해야 할지 판단합니다.
 */
public function shouldBeSearchable(): bool
{
    return $this->isPublished();
}

php artisan scout:import "App\Models\Post"

php artisan scout:queue-import "App\Models\Post" --chunk=500

php artisan scout:flush "App\Models\Post"

use App\Models\Order;

Order::withoutSyncingToSearch(function () {
    // 이 안의 모델 조작은 검색 인덱스에 동기되지 않는다
});

// 쿼리 결과를 추가
Order::where('price', '>', 100)->searchable();

// 릴레이션 경유로 추가
$user->orders()->searchable();

Order::where('price', '>', 100)->unsearchable();

use App\Models\Order;

$orders = Order::search('Star Trek')->get();

use Illuminate\Http\Request;

Route::get('/search', function (Request $request) {
    return Order::search($request->search)->get();
});

$orders = Order::search('Star Trek')->raw();

$articles = Article::search('전기 없이 집을 쾌적하게 유지하는 방법')
    ->semantic()
    ->get();

$articles = Article::search('재생 에너지의 저장')
    ->semantic(minSimilarity: 0.6)
    ->get();

$articles = Article::search('재생 에너지의 저장')
    ->hybrid(textWeight: 1, semanticWeight: 2)
    ->get();

$orders = Order::search('Star Trek')->paginate();

// 1페이지당 건수를 지정
$orders = Order::search('Star Trek')->paginate(15);

$orders = Order::search('Star Trek')->simplePaginate(15);

<div class="container">
    @foreach ($orders as $order)
        {{ $order->price }}
    @endforeach
</div>

{{ $orders->links() }}

use App\Models\Order;

// 등가 필터
$orders = Order::search('Star Trek')->where('user_id', 1)->get();

// 배열 내의 어느 하나에 일치
$orders = Order::search('Star Trek')->whereIn('status', ['open', 'paid'])->get();

// 배열 내의 어느 것에도 일치하지 않음
$orders = Order::search('Star Trek')->whereNotIn('status', ['closed'])->get();

use Illuminate\Database\Eloquent\Builder;

$orders = Order::search('Star Trek')
    ->query(fn (Builder $query) => $query->with('invoices'))
    ->get();

use App\Models\Order;
use Illuminate\Database\Eloquent\Builder;

$orders = Order::search('Star Trek')
    ->query(fn (Builder $query) => $query->with(['invoices', 'user']))
    ->get();

use Illuminate\Database\Eloquent\Builder;

protected function makeAllSearchableUsing(Builder $query): Builder
{
    return $query->with('author');
}

'soft_delete' => true,

// 삭제된 것을 포함해 검색
$orders = Order::search('Star Trek')->withTrashed()->get();

// 삭제된 것만 검색
$orders = Order::search('Star Trek')->onlyTrashed()->get();

use Laravel\Scout\Builder;

abstract public function update($models);
abstract public function delete($models);
abstract public function search(Builder $builder);
abstract public function paginate(Builder $builder, $perPage, $page);
abstract public function mapIds($results);
abstract public function map(Builder $builder, $results, $model);
abstract public function getTotalCount($results);
abstract public function flush($model);

use App\ScoutExtensions\MySqlSearchEngine;
use Laravel\Scout\EngineManager;

public function boot(): void
{
    resolve(EngineManager::class)->extend('mysql', function () {
        return new MySqlSearchEngine;
    });
}

'driver' => 'mysql',