Skip to content

PHPLIB-1733: Support nested fields in vectorSearch #1912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulinevos merged 1 commit into from
Jun 9, 2026
Merged

PHPLIB-1733: Support nested fields in vectorSearch #1912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion generator/mql-specifications
Open in desktop
Submodule mql-specifications updated 1 files
+58 −1 definitions/stage/vectorSearch.yaml
1 change: 1 addition & 0 deletions psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@
<file src="src/Builder/Stage/VectorSearchStage.php">
<MixedArgumentTypeCoercion>
<code><![CDATA[$filter]]></code>
<code><![CDATA[$parentFilter]]></code>
</MixedArgumentTypeCoercion>
</file>
<file src="src/Builder/Type/CombinedFieldQuery.php">
Expand Down
8 changes: 6 additions & 2 deletions src/Builder/Stage/FactoryTrait.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions src/Builder/Stage/FluentFactoryTrait.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 23 additions & 2 deletions src/Builder/Stage/VectorSearchStage.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

94 changes: 94 additions & 0 deletions tests/Builder/Stage/Pipelines.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 35 additions & 1 deletion tests/Builder/Stage/VectorSearchStageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

namespace MongoDB\Tests\Builder\Stage;

use DateTimeImmutable;
use DateTimeZone;
use MongoDB\Builder\Pipeline;
use MongoDB\Builder\Query;
use MongoDB\Builder\Stage;
Expand Down Expand Up @@ -83,11 +85,44 @@ public function testENN(): void
$this->assertSamePipeline(Pipelines::VectorSearchENN, $pipeline);
}

public function testNestedField(): void
{
$pipeline = new Pipeline(
Stage::vectorSearch(
index: 'vector_index',
limit: 5,
path: 'reviews.comments_embedding',
queryVector: [0.010745884850621223, -0.035673413425683975, -0.09298479557037354],
filter: Query::query(...['reviews.date' => Query::gte(new DateTimeImmutable('2000-01-01', new DateTimeZone('UTC')))]),
numCandidates: 100,
nestedOptions: ['scoreMode' => 'avg'],
parentFilter: Query::query(
...['address.country' => Query::in(['United States'])],
bedrooms: [Query::gte(2), Query::lte(3)],
property_type: Query::in(['House', 'Apartment']),
),
),
Stage::project(
...['reviews.comments' => 1],
_id: 0,
name: 1,
address: 1,
neighborhood_overview: 1,
bedrooms: 1,
property_type: 1,
score: ['$meta' => 'vectorSearchScore'],
),
);

$this->assertSamePipeline(Pipelines::VectorSearchNestedField, $pipeline);
}

public function testStoredSource(): void
{
$pipeline = new Pipeline(
Stage::vectorSearch(
index: 'vector_index',
limit: 10,
path: 'plot_embedding',
queryVector: [-0.03994801267981529, -0.016522614285349846, -0.008775344118475914],
filter: Query::and(
Expand All @@ -101,7 +136,6 @@ public function testStoredSource(): void
genres: Query::in(['Action', 'Drama', 'Comedy']),
),
),
limit: 10,
numCandidates: 1000,
returnStoredSource: true,
),
Expand Down
Loading