embedding-oracle-plugin maintained by x-laravel
X-Laravel/Embedding — Oracle 26ai Plugin
Oracle 26ai native vector similarity driver for x-laravel/embedding.
How It Works
- Implements the
SimilarityDriverinterface — registers automatically as theoracledriver - Similarity search runs entirely in Oracle using
VECTOR_DISTANCE— no PHP-side computation
Requirements
- PHP ^8.3
- Laravel ^12.0 | ^13.0
x-laravel/embedding ^1.0- Oracle Database 26ai (Free or Enterprise)
Installation
composer require x-laravel/embedding-oracle-plugin
The OracleEmbeddingServiceProvider is auto-discovered and registers the oracle 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', 'oracle-26ai'),
'table' => env('EMBEDDINGS_DB_TABLE', 'embeddings'),
],
'similarity' => [
'driver' => env('EMBEDDING_SIMILARITY_DRIVER', 'oracle'),
],
2. Create the embeddings table
This plugin ships its own Oracle-native migration that replaces the default one from x-laravel/embedding. It creates a VECTOR(1536, FLOAT32) column.
Run the migration:
php artisan migrate
If you need to customise the DDL (e.g. tablespace, index parameters), publish the migration first:
php artisan vendor:publish --tag=embedding-oracle-migrations
php artisan migrate
Note:
VECTOR_DISTANCEworks without an index (sequential scan). If you have the Oracle In-Memory option, add aCREATE VECTOR INDEX ... ORGANIZATION INMEMORY NEIGHBOR GRAPHstatement after publishing the migration.
3. Model
Follow the standard x-laravel/embedding setup. No Oracle-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.