MongoDB ベクトル検索クエリを実行する

Overview

このガイドでは、MongoDB ベクトル検索機能を使用して、ドキュメントに対して検索する方法を学べます。PHPライブラリでは、集計ビルダを使用してMongoDBベクトル検索クエリを実行できます。

MongoDB ベクトル検索の詳細については、MongoDB ベクトル検索概要を参照してください。PHPライブラリのMongoDBベクトル検索の実装は、クエリを実行するために内部的に $vectorSearch 集計演算子を使用します。この演算子の詳細については、Atlas ドキュメントの $vectorSearch 参照を参照してください。

ベクトル検索集計ステージ

集計ビルダを使用してMongoDB検索クエリを実行するには、次のクラスをアプリケーションにインポートします。

use MongoDB\Builder\Pipeline;
use MongoDB\Builder\Stage;

集計パイプラインに $vectorSearch ステージを作成するには、次のアクションを実行します。

1. パイプラインステージを保存するには、Pipelineインスタンスを作成します。

2. MongoDB ベクトル検索ステージを作成するには、Stage::vectorSearch() メソッドを呼び出します。

3. vectorSearch() メソッドの本体内で、ベクトルクエリの基準を指定します。

次のコードは、基本的なMongoDB ベクトル検索検索クエリを構築するためのテンプレートを示しています。

$pipeline = new Pipeline(
    Stage::vectorSearch(
        /* MongoDB Vector Search query specifications
        index: '<index name>',
        path: '<path to embeddings>', ...*/
    ),
);

次のパラメータをvectorSearch()メソッドに渡す必要があります。

ベクトル検索クエリの例

このセクションでは、集計ビルダを使用してMongoDBベクトル検索検索クエリを実行する方法を学びます。このセクションの例では、 sample_mflix.embedded_moviesコレクションのサンプルデータを使用します。

$pipeline = new Pipeline(
    Stage::vectorSearch(
        index: 'vector',
        path: 'plot_embedding',
        queryVector: [-0.0016261312, -0.028070757, -0.011342932],
        numCandidates: 150,
        limit: 5,
    ),
    Stage::project(
        _id: 0,
        title: 1,
    ),
);
$cursor = $collection->aggregate($pipeline);
foreach ($cursor as $doc) {
    echo json_encode($doc), PHP_EOL;
}

{"title":"Thrill Seekers"}
{"title":"About Time"}
{"title":"Timecop"}
// Results truncated

$pipeline = new Pipeline(
    Stage::vectorSearch(
        index: 'vector',
        path: 'plot_embedding',
        queryVector: [-0.0016261312, -0.028070757, -0.011342932],
        numCandidates: 150,
        limit: 5,
    ),
    Stage::project(
        _id: 0,
        title: 1,
        score: ['$meta' => 'vectorSearchScore'],
    ),
);
$cursor = $collection->aggregate($pipeline);
foreach ($cursor as $doc) {
    echo json_encode($doc), PHP_EOL;
}

{"title":"Thrill Seekers","score":0.927734375}
{"title":"About Time","score":0.925750732421875}
{"title":"Timecop","score":0.9241180419921875}
// Results truncated

ベクトル検索オプション

vectorSearch() メソッドを使用して、さまざまなタイプのMongoDB ベクトル検索の検索クエリを実行できます。ご希望のクエリに応じて、次の任意パラメータを vectorSearch() に渡すことができます。

これらのパラメータの詳細については、Atlas ドキュメントの $vectorSearch 演算子参照の「フィールド」セクションを参照してください。