@mongodb-js/mongodb-constants - npm Package Compare versions

Comparing version 0.6.11 to 0.7.0

dist/stage-operators.d.ts

@@ -434,2 +434,18 @@ declare const STAGE_OPERATORS: readonly [{
 }, {
+    readonly name: "$vectorSearch";
+    readonly value: "$vectorSearch";
+    readonly label: "$vectorSearch";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas"];
+    readonly meta: "stage";
+    readonly version: "7.0.2";
+    readonly apiVersions: readonly [];
+    readonly namespaces: readonly ["coll"];
+    readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.";
+    readonly comment: "/**\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n * index: Name of the Atlas Search index to use. If omitted, defaults to `default`. (Optional)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * path: The field to search. (Required)\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector `dimensions` specified in the index for the field. (Required)\n */\n";
+    readonly snippet: "{\n  queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n  path: ${3:string},\n  numCandidates: ${4:numCandidates},\n  limit: ${5:limit},\n  index: ${6:string},\n  filter: {}\n}";
+}, {
     readonly name: "$set";
@@ -611,3 +627,3 @@ readonly value: "$set";
 }];
-declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$collStats" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$redact" | "$replaceWith" | "$replaceRoot" | "$sample" | "$search" | "$searchMeta" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$changeStream" | "$currentOp" | "$listLocalSessions")[];
+declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$collStats" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$redact" | "$replaceWith" | "$replaceRoot" | "$sample" | "$search" | "$searchMeta" | "$vectorSearch" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$changeStream" | "$currentOp" | "$listLocalSessions")[];
 declare const OUT_STAGES: ({
@@ -776,2 +792,18 @@ readonly name: "$merge";
 } | {
+    readonly name: "$vectorSearch";
+    readonly value: "$vectorSearch";
+    readonly label: "$vectorSearch";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas"];
+    readonly meta: "stage";
+    readonly version: "7.0.2";
+    readonly apiVersions: readonly [];
+    readonly namespaces: readonly ["coll"];
+    readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.";
+    readonly comment: "/**\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n * index: Name of the Atlas Search index to use. If omitted, defaults to `default`. (Optional)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * path: The field to search. (Required)\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector `dimensions` specified in the index for the field. (Required)\n */\n";
+    readonly snippet: "{\n  queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n  path: ${3:string},\n  numCandidates: ${4:numCandidates},\n  limit: ${5:limit},\n  index: ${6:string},\n  filter: {}\n}";
+} | {
     readonly name: "$changeStream";
@@ -778,0 +810,0 @@ readonly value: "$changeStream";

dist/stage-operators.js

@@ -767,2 +767,34 @@ "use strict";
     {
+        name: '$vectorSearch',
+        value: '$vectorSearch',
+        label: '$vectorSearch',
+        outputStage: false,
+        fullScan: false,
+        firstStage: true,
+        score: 1,
+        env: [env_1.ATLAS],
+        meta: 'stage',
+        version: '7.0.2',
+        apiVersions: [],
+        namespaces: [ns_1.COLLECTION],
+        description: 'Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.',
+        comment: `/**
+ * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)
+ * index: Name of the Atlas Search index to use. If omitted, defaults to \`default\`. (Optional)
+ * limit: Number (of type \`int\` only) of documents to return in the results. (Required)
+ * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (\`limit\`) to increase accuracy. (Required)
+ * path: The field to search. (Required)
+ * queryVector: Array of numbers of BSON types \`int\` or \`double\` that represent the query vector. The array size must match the number of vector \`dimensions\` specified in the index for the field. (Required)
+ */
+`,
+        snippet: `{
+  queryVector: [\${1:dimension1}, \${2:dimension2}, ...],
+  path: \${3:string},
+  numCandidates: \${4:numCandidates},
+  limit: \${5:limit},
+  index: \${6:string},
+  filter: {}
+}`,
+    },
+    {
         name: '$set',
@@ -769,0 +801,0 @@ value: '$set',

package.json

@@ -16,3 +16,3 @@ {
   "homepage": "https://github.com/mongodb-js/devtools-shared",
-  "version": "0.6.11",
+  "version": "0.7.0",
   "repository": {
@@ -72,3 +72,3 @@ "type": "git",
   },
-  "gitHead": "0ac5d5a2aad1459afe34a31686301b00044cb589"
+  "gitHead": "ec0dbea4c882e191ebed5bc69298776b5ae9a924"
 }

No alert changes

Improved metrics

Total package byte prevSize

346184

increased by2.05%

Lines of code

8197

increased by1.06%

No dependency changes