Merge pull request #14429 from jkorach/gh-14428

Add TypeScript interface for the new PipelineStage - Vector Search - solving issue #14428

Author: vkarpov15

test/types/PipelineStage.test.ts

@@ -520,3 +520,20 @@ function gh12269() {
     }
   };
 }
+const vectorSearchStages: PipelineStage[] = [
+  {
+    $vectorSearch: {
+      index: 'title_vector_index',
+      path: 'embedding',
+      queryVector: [0.522, 0.123, 0.487],
+      limit: 5,
+      numCandidates: 100
+    }
+  },
+  {
+    $project: {
+      title: 1,
+      score: { $meta: 'searchScore' }
+    }
+  }
+];

types/pipelinestage.d.ts

@@ -36,7 +36,8 @@ declare module 'mongoose' {
     | PipelineStage.SortByCount
     | PipelineStage.UnionWith
     | PipelineStage.Unset
-    | PipelineStage.Unwind;
+    | PipelineStage.Unwind
+    | PipelineStage.VectorSearch;
 
   export namespace PipelineStage {
     export interface AddFields {
@@ -308,5 +309,17 @@ declare module 'mongoose' {
       /** [`$unwind` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/) */
       $unwind: string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean }
     }
+    export interface VectorSearch {
+      /** [`$vectorSearch` reference](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/) */
+      $vectorSearch: {
+        index: string,
+        path: string,
+        queryVector: number[],
+        numCandidates: number,
+        limit: number,
+        filter?: Expression,
+      }
+    }
+
   }
 }