Skip to content

[Store] Fix CacheStore and InMemoryStore to return similarity scores #856

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
merged 1 commit into from
Nov 12, 2025
Merged

[Store] Fix CacheStore and InMemoryStore to return similarity scores #856

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 src/store/src/Bridge/Local/DistanceCalculator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function calculate(array $documents, Vector $vector, ?int $maxItems = nul
}

return array_map(
static fn (array $embedding): VectorDocument => $embedding['document'],
static fn (array $embedding): VectorDocument => $embedding['document']->withScore($embedding['distance']),
$currentEmbeddings,
);
}
Expand Down
13 changes: 13 additions & 0 deletions src/store/src/Document/VectorDocument.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,17 @@ public function __construct(
public readonly ?float $score = null,
) {
}

/**
* Returns a new instance with the given score.
*/
public function withScore(float $score): self
{
return new self(
id: $this->id,
vector: $this->vector,
metadata: $this->metadata,
score: $score,
);
}
}
33 changes: 23 additions & 10 deletions src/store/tests/Bridge/Local/DistanceCalculatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,12 @@ public function testAngularDistanceCalculation()
$result = $calculator->calculate([$orthogonalDoc, $parallelDoc], $queryVector);

// Parallel vector should be first (smaller angular distance)
$this->assertSame($parallelDoc, $result[0]);
$this->assertSame($orthogonalDoc, $result[1]);
$this->assertEquals($parallelDoc->id, $result[0]->id);
$this->assertEquals($parallelDoc->vector, $result[0]->vector);
$this->assertNotNull($result[0]->score);
$this->assertEquals($orthogonalDoc->id, $result[1]->id);
$this->assertEquals($orthogonalDoc->vector, $result[1]->vector);
$this->assertNotNull($result[1]->score);
}

#[TestDox('Calculates Chebyshev distance using maximum absolute difference')]
Expand All @@ -176,9 +180,12 @@ public function testChebyshevDistanceCalculation()
$result = $calculator->calculate([$doc1, $doc2, $doc3], $queryVector);

// doc1 should be first (distance 0), doc2 second (max diff 0.5), doc3 last (max diff 3.0)
$this->assertSame($doc1, $result[0]);
$this->assertSame($doc2, $result[1]);
$this->assertSame($doc3, $result[2]);
$this->assertEquals($doc1->id, $result[0]->id);
$this->assertNotNull($result[0]->score);
$this->assertEquals($doc2->id, $result[1]->id);
$this->assertNotNull($result[1]->score);
$this->assertEquals($doc3->id, $result[2]->id);
$this->assertNotNull($result[2]->score);
}

#[TestDox('Returns empty array when no documents are provided')]
Expand All @@ -201,7 +208,9 @@ public function testSingleDocument()
$result = $calculator->calculate([$doc], new Vector([0.0, 0.0, 0.0]));

$this->assertCount(1, $result);
$this->assertSame($doc, $result[0]);
$this->assertEquals($doc->id, $result[0]->id);
$this->assertEquals($doc->vector, $result[0]->vector);
$this->assertNotNull($result[0]->score);
}

#[TestDox('Handles high-dimensional vectors correctly')]
Expand All @@ -222,8 +231,10 @@ public function testHighDimensionalVectors()
$result = $calculator->calculate([$doc1, $doc2], $queryVector);

// doc1 should be closer to query vector (0.15 is closer to 0.1 than to 0.2)
$this->assertSame($doc1, $result[0]);
$this->assertSame($doc2, $result[1]);
$this->assertEquals($doc1->id, $result[0]->id);
$this->assertNotNull($result[0]->score);
$this->assertEquals($doc2->id, $result[1]->id);
$this->assertNotNull($result[1]->score);
}

#[TestDox('Handles negative vector components correctly')]
Expand All @@ -240,7 +251,8 @@ public function testNegativeVectorComponents()
$result = $calculator->calculate([$doc1, $doc2, $doc3], $queryVector);

// doc1 should be first (identical to query)
$this->assertSame($doc1, $result[0]);
$this->assertEquals($doc1->id, $result[0]->id);
$this->assertNotNull($result[0]->score);
}

#[TestDox('Returns all documents when maxItems exceeds document count')]
Expand Down Expand Up @@ -271,7 +283,8 @@ public function testManhattanDistanceWithMixedSigns()
$result = $calculator->calculate([$doc1, $doc2, $doc3], $queryVector);

// doc3 has smallest Manhattan distance (2.0), then doc1 and doc2 (both 4.0)
$this->assertSame($doc3, $result[0]);
$this->assertEquals($doc3->id, $result[0]->id);
$this->assertNotNull($result[0]->score);
}

#[TestDox('Uses cosine distance as default strategy')]
Expand Down