MLE-15687 : Run auto-generation again to include server side code changes for 12-EA

Author: anu3990

lib/plan-builder-generated.js

@@ -5304,7 +5304,7 @@ class VecExpr {
   constructor() {
   }
   /**
-    *  Provides a client interface to a server function.
+    * Returns the sum of two vectors. The vectors must be of the same dimension. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.add|vec.add}
     * @method planBuilder.vec#add
     * @since 3.5.0
     * @param { VecVector } [vector1] - The first addend vector.
@@ -5321,7 +5321,7 @@ add(...args) {
 
     }
 /**
-    * Constructs a vector result by decoding the base64 binary input. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.base64Decode|vec.base64Decode}
+    * Returns a vector value by decoding the base64 encoded string input. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.base64Decode|vec.base64Decode}
     * @method planBuilder.vec#base64Decode
     * @since 3.5.0
     * @param { XsString } [base64Vector] - The base64 binary encoded string vector to decode.
@@ -5412,7 +5412,7 @@ euclideanDistance(...args) {
     * @method planBuilder.vec#get
     * @since 3.5.0
     * @param { VecVector } [vector1] - The vector to grab the k-th element of.
-    * @param { XsUnsignedInt } [k] - The zero-based index of vector1 to return.
+    * @param { XsUnsignedInt } [k] - The zero-based index of vector1 to return. If k is greater than the number of elements in the vector, throw VEC-OUTOFBOUNDS.
     * @returns { XsFloat }
     */
 get(...args) {
@@ -5449,7 +5449,7 @@ normalize(...args) {
     return new types.VecVector('vec', 'normalize', checkedArgs);
     }
 /**
-    *  Provides a client interface to a server function.
+    * Returns the difference of two vectors. The vectors must be of the same dimension. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.subtract|vec.subtract}
     * @method planBuilder.vec#subtract
     * @since 3.5.0
     * @param { VecVector } [vector1] - The minuend vector.
@@ -5466,28 +5466,28 @@ subtract(...args) {
 
     }
 /**
-    * Returns a subvector of the input vector, starting at the specified index and with the specified length. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.subvector|vec.subvector}
+    * Returns a subvector of the input vector, starting at the specified index, with the specified length (optional). Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.subvector|vec.subvector}
     * @method planBuilder.vec#subvector
     * @since 3.5.0
     * @param { VecVector } [vector] - The input vector.
-    * @param { XsUnsignedInt } [start] - The starting index of the subvector (inclusive).
-    * @param { XsUnsignedInt } [length] - The length of the subvector.
+    * @param { XsUnsignedInt } [start] - The zero-based index of the input vector from which to start (inclusive).
+    * @param { XsUnsignedInt } [length] - The length of the subvector. If not provided, returns a subvector beginning from index at start to the end of the input vector. If length is greater than the number of elements left in the input vector, throw VEC-OUTOFBOUNDS.
     * @returns { VecVector }
     */
 subvector(...args) {
     const namer = bldrbase.getNamer(args, 'vector');
     const paramdefs = [['vector', [types.VecVector, PlanColumn, PlanParam], true, false], ['start', [types.XsUnsignedInt, PlanColumn, PlanParam], true, false], ['length', [types.XsUnsignedInt, PlanColumn, PlanParam], false, false]];
     const checkedArgs = (namer !== null) ?
-        bldrbase.makeNamedArgs(namer, 'vec.subvector', 3, new Set(['vector', 'start', 'length']), paramdefs, args) :
-        bldrbase.makePositionalArgs('vec.subvector', 3, false, paramdefs, args);
+        bldrbase.makeNamedArgs(namer, 'vec.subvector', 2, new Set(['vector', 'start', 'length']), paramdefs, args) :
+        bldrbase.makePositionalArgs('vec.subvector', 2, false, paramdefs, args);
     return new types.VecVector('vec', 'subvector', checkedArgs);
 
     }
 /**
     * Returns a vector value. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.vector|vec.vector}
     * @method planBuilder.vec#vector
     * @since 3.5.0
-    * @param { XsAnyAtomicType } [values] - The values to create the vector from. Can be a sequence or json:array of integer or floating-point numbers.
+    * @param { XsAnyAtomicType } [values] - The value(s) to create the vector from. Can be a sequence or json:array of integer or floating-point numbers. Also accepts a string that has the format of a JSON array of Numbers. Also accepts a string that was created by vec:base64-encode().
     * @returns { VecVector }
     */
 vector(...args) {
@@ -5496,12 +5496,12 @@ vector(...args) {
     return new types.VecVector('vec', 'vector', checkedArgs);
     }
 /**
-    * A helper function that returns the hybrid score using a cts:score and a vector similarity function. You can tune the effect of the vector similarity on the score using the "similarity-weight" option. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.vectorScore|vec.vectorScore}
+    * A helper function that returns a hybrid score using a cts score and a vector similarity calculation result. You can tune the effect of the vector similarity on the score using the similarityWeight option. The ideal value for similarityWeight depends on your application. Provides a client interface to a server function. See {@link http://docs.marklogic.com/vec.vectorScore|vec.vectorScore}
     * @method planBuilder.vec#vectorScore
     * @since 3.5.0
     * @param { XsUnsignedInt } [score] - The cts:score of the matching document.
-    * @param { XsDouble } [similarity] - The similarity between the vector in the matching document and the query vector. The result of a call to ovec:cosine-similarity() or op.vec.cosineSimilarity(). In the case that the vectors are normalized, pass ovec:dot-product() or op.vec.dotProduct(). Note that vec:euclideanDistance() should not be used here.
-    * @param { XsDouble } [similarityWeight] - The weight of the vector similarity on the score. The default value is 1.0. Values less than or equal to zero have no effect.
+    * @param { XsDouble } [similarity] - The similarity between the vector in the matching document and the query vector. The result of a call to ovec:cosine-similarity(). In the case that the vectors are normalized, pass ovec:dot-product(). Note that vec:euclidean-distance() should not be used here.
+    * @param { XsDouble } [similarityWeight] - The weight of the vector similarity on the score. The default value is 0.1. If 0.0 is passed in, vector similarity has no effect. If passed a value less than 0.0 or greater than 1.0, throw VEC-VECTORSCORE.
     * @returns { XsUnsignedLong }
     */
 vectorScore(...args) {
@@ -8513,7 +8513,7 @@ viewCol(...args) {
     * Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples. The only use for the fragment id is joining other rows from the same document, the document uri, or the document content. The fragment id is only useful during execution of the query and not after. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.fragmentIdCol|op.fragmentIdCol}
     * @method planBuilder#fragmentIdCol
     * @since 2.1.1
-    * @param { XsString } [column] - 
+    * @param { XsString } [column] - The name of the fragment ID column.
     * @returns { planBuilder.PlanSystemColumn }
     */
 fragmentIdCol(...args) {
@@ -8695,6 +8695,7 @@ fromSQL(...args) {
     * @since 2.1.1
     * @param { PlanSearchQuery } [query] - Qualifies and establishes the scores for a set of documents. The query can be a cts:query or a string as a shortcut for a cts:word-query.
     * @param { XsString } [qualifierName] - Specifies a name for qualifying the column names.
+    * @param { PlanSearchOption } [option] - Similar to the options of cts:search, supplies the 'scoreMethod' key with a value of 'logtfidf', 'logtf', 'simple', 'zero', 'random', or 'bm25' to specify the method for assigning a score to matched documents or supplies the 'qualityWeight' key with a numeric value to specify a multiplier for the quality contribution to the score. Specify a value between 0 (exclusive) and 1 (inclusive) for bm25LengthWeight if 'bm25' scoring method is used.
     * @returns { planBuilder.AccessPlan }
     */
 fromSearchDocs(...args) {

test-basic/plan-builder-generated.js

@@ -952,8 +952,8 @@ describe('plan builder', function() {
     }); 
     it('geo.geohashNeighbors#1', function(done) {
         testPlan([p.xs.string("s01mtw")], p.geo.geohashNeighbors(p.col("1")))
-          .then(function(response) { 
-            should(getResult(response).value).eql({"NE":"s01mtz", "S":"s01mtt", "E":"s01mty", "W":"s01mtq", "N":"s01mtx", "SW":"s01mtm", "SE":"s01mtv", "NW":"s01mtr"});
+          .then(function(response) {
+            should(getResult(response).value).eql({"NE":"s01mtz", "S":"s01mtt", "E":"s01mty", "W":"s01mtq", "SW":"s01mtm", "N":"s01mtx", "SE":"s01mtv", "NW":"s01mtr"});
             done();
         }).catch(done);
     }); 
@@ -972,9 +972,8 @@ describe('plan builder', function() {
           .then(function(response) { 
             should(getResult(response).value).eql(["s01mtw0", "s01mtw1", "s01mtw2", "s01mtw3", "s01mtw4", "s01mtw5", "s01mtw6", "s01mtw7", "s01mtw8", "s01mtw9", "s01mtwb", "s01mtwc", "s01mtwd", "s01mtwe", "s01mtwf", "s01mtwg", "s01mtwh", "s01mtwj", "s01mtwk", "s01mtwm", "s01mtwn", "s01mtwp", "s01mtwq", "s01mtwr", "s01mtws", "s01mtwt", "s01mtwu", "s01mtwv", "s01mtww", "s01mtwx", "s01mtwy", "s01mtwz"]);
             done();
-        }).catch(done)
-            .catch(error => done(error));
-    }); 
+        }).catch(error => done(error));
+    });
     it('geo.geohashSubhashes#2', function(done) {
         testPlan([p.xs.string("s01mtw"), p.xs.string("S")], p.geo.geohashSubhashes(p.col("1"), p.col("2")))
           .then(function(response) {