ritey/laravel-manticore

Laravel Scout driver for Manticore Search with support for vector search, hybrid queries, and JSON filters.

v2.0.4 2025-04-16 22:29 UTC

Requires

• php: ^7.4|^8.0
• laravel/scout: ^9.0|^10.0|^11.0
• manticoresoftware/manticoresearch-php: ^4.0

Requires (Dev)

• orchestra/testbench: ^7.0
• phpunit/phpunit: ^9.0

MIT

• David Wright

• json
• search
• laravel
• nlp
• vector
• ai
• scout
• manticore

README

A Laravel Scout engine for Manticore Search, supporting:

• ✅ Full-text search
• ✅ Vector similarity search
• ✅ JSON field filters
• ✅ Field boosting
• ✅ Hybrid search (vector + full-text)
• ✅ Pagination and sorting
• ✅ Artisan commands to manage Manticore indexes

🔧 Installation

composer require ritey/laravel-manticore

Publish the config file (optional):

php artisan vendor:publish --tag=config

⚙️ Configuration

In config/scout.php:

'driver' => 'manticore',

In .env or config/laravel_manticore.php:

LARAVEL_MANTICORE_HOST=127.0.0.1
LARAVEL_MANTICORE_PORT=9308
LARAVEL_MANTICORE_DEBUG=true

🏗 Making a Model Searchable

use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

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

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

🛠 Index Management

Run once per model to initialize index:

php artisan manticore:create-index "App\Models\Post"

To sync field types after changes:

php artisan manticore:sync-index "App\Models\Post"

// Before running search, make sure your index is populated: php artisan scout:import "App\Models\Post"

🔍 Basic Search Example

Post::search('open education')->get();

🚀 Advanced Search

With vector + filters

use Ritey\LaravelManticore\FilterBuilder;

$filters = (new FilterBuilder)
    ->where('metadata.topic', 'ai')
    ->whereRange('score', ['gte' => 0.6]);

Post::search('ai in education')
    ->tap(function ($builder) use ($filters, $vector) {
        $builder->vector = $vector;
        $builder->filterBuilder = $filters;
        $builder->similarity = 'cosine';
    })
    ->get();

Sorting

Post::search('ai')
    ->tap(fn($b) => $b->sort = [['score' => 'desc']])
    ->get();

Boosting Fields

Post::search('language learning')
    ->tap(fn($b) => $b->boosts = ['title' => 2.0, 'body' => 1.0])
    ->get();

📊 Facets

Post::search('climate')
    ->tap(fn($b) => $b->facets = ['metadata.topic'])
    ->get();

💡 Highlighting (Default Enabled)

Results include highlighting in highlight key.

🧪 Debugging

Enable logging by setting:

LARAVEL_MANTICORE_DEBUG=true

Laravel will log connection config to the default logger.

📄 License

MIT License. (c) Ritey

🛠 Programmatic Index Management (Scout 10+)

In addition to Artisan commands, indexes can be created or deleted via Laravel Scout:

use Laravel\Scout\EngineManager;

$engine = resolve(EngineManager::class)->engine('manticore');
$engine->createIndex('posts_index');
$engine->deleteIndex('posts_index');