[BC BREAK] Extend VectorSearchInterface::query() for a $minScore (#151)

Author: OskarStark

src/Bridge/Azure/Store/SearchStore.php

@@ -34,7 +34,7 @@ public function add(VectorDocument ...$documents): void
         ]);
     }
 
-    public function query(Vector $vector, array $options = []): array
+    public function query(Vector $vector, array $options = [], ?float $minScore = null): array
     {
         $result = $this->request('search', [
             'vectorQueries' => [$this->buildVectorQuery($vector)],

src/Bridge/ChromaDB/Store.php

@@ -34,7 +34,7 @@ public function add(VectorDocument ...$documents): void
         $collection->add($ids, $vectors, $metadata);
     }
 
-    public function query(Vector $vector, array $options = []): array
+    public function query(Vector $vector, array $options = [], ?float $minScore = null): array
     {
         $collection = $this->client->getOrCreateCollection($this->collectionName);
         $queryResponse = $collection->query(

src/Bridge/MongoDB/Store.php

@@ -95,9 +95,9 @@ public function add(VectorDocument ...$documents): void
      *     filter?: array<mixed>
      * } $options
      */
-    public function query(Vector $vector, array $options = []): array
+    public function query(Vector $vector, array $options = [], ?float $minScore = null): array
     {
-        $results = $this->getCollection()->aggregate([
+        $pipeline = [
             [
                 '$vectorSearch' => array_merge([
                     'index' => $this->indexName,
@@ -112,7 +112,20 @@ public function query(Vector $vector, array $options = []): array
                     'score' => ['$meta' => 'vectorSearchScore'],
                 ],
             ],
-        ], ['typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array']]);
+        ];
+
+        if (null !== $minScore) {
+            $pipeline[] = [
+                '$match' => [
+                    'score' => ['$gte' => $minScore],
+                ],
+            ];
+        }
+
+        $results = $this->getCollection()->aggregate(
+            $pipeline,
+            ['typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array']]
+        );
 
         $documents = [];
 

src/Bridge/Pinecone/Store.php

@@ -43,7 +43,7 @@ public function add(VectorDocument ...$documents): void
         $this->getVectors()->upsert($vectors);
     }
 
-    public function query(Vector $vector, array $options = []): array
+    public function query(Vector $vector, array $options = [], ?float $minScore = null): array
     {
         $response = $this->getVectors()->query(
             vector: $vector->getData(),

src/Store/VectorStoreInterface.php

@@ -14,5 +14,5 @@ interface VectorStoreInterface extends StoreInterface
      *
      * @return VectorDocument[]
      */
-    public function query(Vector $vector, array $options = []): array;
+    public function query(Vector $vector, array $options = [], ?float $minScore = null): array;
 }