README

pgvector 对 PHP 的支持

入门指南

遵循您的数据库库的说明

• Laravel
• PHP

或者查看一些示例

• 与 OpenAI 使用嵌入
• 使用 Disco 进行推荐

Laravel

安装包

composer require ankane/pgvector

启用扩展

php artisan vendor:publish --tag="pgvector-migrations"
php artisan migrate

现在您可以在未来的迁移中使用 vector 类型

Schema::create('items', function (Blueprint $table) {
    $table->vector('embedding', 3);
});

更新您的模型

use Pgvector\Laravel\Vector;

class Item extends Model
{
    use HasNeighbors;

    protected $casts = ['embedding' => Vector::class];
}

插入一个向量

$item = new Item();
$item->embedding = [1, 2, 3];
$item->save();

获取记录的最近邻

use Pgvector\Laravel\Distance;

$neighbors = $item->nearestNeighbors('embedding', Distance::L2)->take(5)->get();

也支持 InnerProduct 和 Cosine 距离

获取向量的最近邻

$neighbors = Item::query()->nearestNeighbors('embedding', [1, 2, 3], Distance::L2)->take(5)->get();

获取距离

$neighbors->pluck('neighbor_distance');

在迁移中添加一个近似索引

public function up()
{
    DB::statement('CREATE INDEX my_index ON items USING ivfflat (embedding vector_l2_ops) WITH (lists = 100)');
    // or
    DB::statement('CREATE INDEX my_index ON items USING hnsw (embedding vector_l2_ops)');
}

public function down()
{
    DB::statement('DROP INDEX my_index');
}

使用 vector_ip_ops 进行内积，使用 vector_cosine_ops 进行余弦距离

PHP

启用扩展

pg_query($db, 'CREATE EXTENSION IF NOT EXISTS vector');

创建一个表

pg_query($db, 'CREATE TABLE items (embedding vector(3))');

插入一个向量

use Pgvector\Vector;

$embedding = new Vector([1, 2, 3]);
pg_query_params($db, 'INSERT INTO items (embedding) VALUES ($1)', [$embedding]);

获取向量的最近邻

$embedding = new Vector([1, 2, 3]);
$result = pg_query_params($db, 'SELECT * FROM items ORDER BY embedding <-> $1 LIMIT 5', [$embedding]);

添加一个近似索引

pg_query($db, 'CREATE INDEX ON items USING ivfflat (embedding vector_l2_ops) WITH (lists = 100)');
// or
pg_query($db, 'CREATE INDEX ON items USING hnsw (embedding vector_l2_ops)');

查看一个 完整示例

历史记录

查看 变更日志

贡献

鼓励每个人帮助改进此项目。以下是一些您可以提供帮助的方式

• 报告错误
• 修复错误并 提交拉取请求
• 编写、澄清或修复文档
• 建议或添加新功能

要开始开发

git clone https://github.com/pgvector/pgvector-php.git
cd pgvector-php
composer install
createdb pgvector_php_test
composer test