README

SQL Server 2025 / Azure SQL native vector driver for x-laravel/embedding.

How It Works

Implements SimilarityDriver — registers as the sqlsrv driver, similarity search runs entirely in SQL Server using VECTOR_DISTANCE('cosine', ...)
Implements VectorStore — writes embeddings via MERGE INTO with CAST(? AS VECTOR(n)), reads via a CAST(vector AS NVARCHAR(MAX)) global scope

Requirements

PHP ^8.3 + ext-sqlsrv + ext-pdo_sqlsrv + Microsoft ODBC Driver 18
Laravel ^12.0 | ^13.0
x-laravel/embedding ^1.0
SQL Server 2025 or Azure SQL Database (native VECTOR type required)

Installation

composer require x-laravel/embedding-sqlsrv-driver

The SqlServerEmbeddingServiceProvider is auto-discovered and registers the sqlsrv driver automatically.

Setup

1. Configure x-laravel/embedding

Publish the config if you haven't already:

php artisan vendor:publish --tag=embedding-config

Set the similarity driver and database connection in config/embedding.php:

'database' => [
    'connection' => env('EMBEDDINGS_DATABASE_CONNECTION', env('DB_CONNECTION', 'sqlsrv')),
    'table'      => env('EMBEDDINGS_DB_TABLE', 'embeddings'),
],

'similarity' => [
    'driver' => env('EMBEDDING_SIMILARITY_DRIVER', 'auto'),
],

2. Create the embeddings table

This driver ships its own SQL Server-native migration that replaces the default one from x-laravel/embedding. It creates a VECTOR(n) column.

Run the migration:

php artisan migrate

If you need to customise the DDL, publish the migration first:

php artisan vendor:publish --tag=embedding-sqlsrv-migrations
php artisan migrate

Note: VECTOR_DISTANCE requires SQL Server 2025 or Azure SQL Database. This is not available in SQL Server 2019/2022.

3. Model

Follow the standard x-laravel/embedding setup. No SQL Server-specific changes are needed on your models.

use XLaravel\Embedding\Attributes\EmbedOn;
use XLaravel\Embedding\Concerns\Embeddable;
use XLaravel\Embedding\Contracts\HasEmbeddings;

#[EmbedOn(['title', 'body'])]
class Post extends Model implements HasEmbeddings
{
    use Embeddable;

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

Usage

The driver is transparent — use the standard x-laravel/embedding API:

Post::similarToText('web framework', limit: 10);
Post::similarTo($vector, limit: 10, threshold: 0.8);
Post::rankByRelevance($posts, 'web framework');

$post->mostSimilar(limit: 5);
$post->similarityTo($otherPost);

All methods set a similarity_score float attribute on each returned model.

Testing

# Build first (once per PHP version)
DOCKER_BUILDKIT=0 docker compose --profile php83 build

# Run tests
docker compose --profile php83 up
docker compose --profile php84 up
docker compose --profile php85 up

License

This package is open-sourced software licensed under the MIT license.

x-laravel / embedding-sqlsrv-driver

Maintainers

Package info

Statistics

Security