couchbase 4.2.9 → 4.2.10

package/dist/vectorsearch.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Specifies how multiple vector searches are combined.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare enum VectorQueryCombination {
+    /**
+     * Indicates that multiple vector queries should be combined with logical AND.
+     */
+    AND = "and",
+    /**
+     * Indicates that multiple vector queries should be combined with logical OR.
+     */
+    OR = "or"
+}
+/**
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export interface VectorSearchOptions {
+    /**
+     * Specifies how multiple vector queries should be combined.
+     */
+    vectorQueryCombination?: VectorQueryCombination;
+}
+/**
+ * Represents a vector query.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare class VectorQuery {
+    private _fieldName;
+    private _vector;
+    private _numCandidates;
+    private _boost;
+    constructor(fieldName: string, vector: number[]);
+    /**
+     * @internal
+     */
+    toJSON(): any;
+    /**
+     * Adds boost option to vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param boost A floating point value.
+     */
+    boost(boost: number): VectorQuery;
+    /**
+     * Adds numCandidates option to vector query. Value must be >= 1.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param numCandidates An integer value.
+     */
+    numCandidates(numCandidates: number): VectorQuery;
+    /**
+     * Creates a vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param fieldName The name of the field in the JSON document that holds the vector.
+     * @param vector List of floating point values that represent the vector.
+     */
+    static create(fieldName: string, vector: number[]): VectorQuery;
+}
+/**
+ * Represents a vector search.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare class VectorSearch {
+    private _queries;
+    private _options;
+    constructor(queries: VectorQuery[], options?: VectorSearchOptions);
+    /**
+     * @internal
+     */
+    get queries(): VectorQuery[];
+    /**
+     * @internal
+     */
+    get options(): VectorSearchOptions | undefined;
+    /**
+     * Creates a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A vectory query that should be a part of the vector search.
+     */
+    static fromVectorQuery(query: VectorQuery): VectorSearch;
+}

package/dist/vectorsearch.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorSearch = exports.VectorQuery = exports.VectorQueryCombination = void 0;
+const errors_1 = require("./errors");
+/**
+ * Specifies how multiple vector searches are combined.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+var VectorQueryCombination;
+(function (VectorQueryCombination) {
+    /**
+     * Indicates that multiple vector queries should be combined with logical AND.
+     */
+    VectorQueryCombination["AND"] = "and";
+    /**
+     * Indicates that multiple vector queries should be combined with logical OR.
+     */
+    VectorQueryCombination["OR"] = "or";
+})(VectorQueryCombination || (exports.VectorQueryCombination = VectorQueryCombination = {}));
+/**
+ * Represents a vector query.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class VectorQuery {
+    constructor(fieldName, vector) {
+        this._fieldName = fieldName;
+        if (!Array.isArray(vector) || vector.length == 0) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided vector must be an array and cannot be empty.'));
+        }
+        this._vector = vector;
+    }
+    /**
+     * @internal
+     */
+    toJSON() {
+        var _a;
+        const output = {
+            field: this._fieldName,
+            vector: this._vector,
+            k: (_a = this._numCandidates) !== null && _a !== void 0 ? _a : 3,
+        };
+        if (this._boost) {
+            output['boost'] = this._boost;
+        }
+        return output;
+    }
+    /**
+     * Adds boost option to vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param boost A floating point value.
+     */
+    boost(boost) {
+        this._boost = boost;
+        return this;
+    }
+    /**
+     * Adds numCandidates option to vector query. Value must be >= 1.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param numCandidates An integer value.
+     */
+    numCandidates(numCandidates) {
+        if (numCandidates < 1) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided value for numCandidates must be >= 1.'));
+        }
+        this._numCandidates = numCandidates;
+        return this;
+    }
+    /**
+     * Creates a vector query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param fieldName The name of the field in the JSON document that holds the vector.
+     * @param vector List of floating point values that represent the vector.
+     */
+    static create(fieldName, vector) {
+        return new VectorQuery(fieldName, vector);
+    }
+}
+exports.VectorQuery = VectorQuery;
+/**
+ * Represents a vector search.
+ *
+ * Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class VectorSearch {
+    constructor(queries, options) {
+        if (!Array.isArray(queries) || queries.length == 0) {
+            throw new errors_1.InvalidArgumentError(new Error('Provided queries must be an array and cannot be empty.'));
+        }
+        if (!queries.every((q) => q instanceof VectorQuery)) {
+            throw new errors_1.InvalidArgumentError(new Error('All provided queries must be a VectorQuery.'));
+        }
+        this._queries = queries;
+        this._options = options;
+    }
+    /**
+     * @internal
+     */
+    get queries() {
+        return this._queries;
+    }
+    /**
+     * @internal
+     */
+    get options() {
+        return this._options;
+    }
+    /**
+     * Creates a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A vectory query that should be a part of the vector search.
+     */
+    static fromVectorQuery(query) {
+        return new VectorSearch([query]);
+    }
+}
+exports.VectorSearch = VectorSearch;

package/package.json

@@ -54,7 +54,7 @@
     "type": "git",
     "url": "http://github.com/couchbase/couchnode.git"
   },
-  "version": "4.2.9",
+  "version": "4.2.10",
   "config": {
     "native": false
   },
@@ -79,12 +79,12 @@
     ]
   },
   "optionalDependencies": {
-    "@couchbase/couchbase-darwin-arm64-napi": "4.2.9",
-    "@couchbase/couchbase-darwin-x64-napi": "4.2.9",
-    "@couchbase/couchbase-linux-arm64-napi": "4.2.9",
-    "@couchbase/couchbase-linuxmusl-x64-napi": "4.2.9",
-    "@couchbase/couchbase-linux-x64-napi": "4.2.9",
-    "@couchbase/couchbase-win32-x64-napi": "4.2.9"
+    "@couchbase/couchbase-darwin-arm64-napi": "4.2.10",
+    "@couchbase/couchbase-darwin-x64-napi": "4.2.10",
+    "@couchbase/couchbase-linux-arm64-napi": "4.2.10",
+    "@couchbase/couchbase-linuxmusl-x64-napi": "4.2.10",
+    "@couchbase/couchbase-linux-x64-napi": "4.2.10",
+    "@couchbase/couchbase-win32-x64-napi": "4.2.10"
   },
   "files": [
     "LICENSE",

package/src/constants.cpp

@@ -1051,6 +1051,17 @@ void Constants::InitAutogen(Napi::Env env, Napi::Object exports)
                              {"three", couchbase::replicate_to::three},
                          }));
 
+    exports.Set(
+        "vector_query_combination",
+        cbppEnumToJs<couchbase::core::vector_query_combination>(
+            env,
+            {
+                {"combination_and",
+                 couchbase::core::vector_query_combination::combination_and},
+                {"combination_or",
+                 couchbase::core::vector_query_combination::combination_or},
+            }));
+
     //#endregion Autogenerated Constants
 }
 

package/src/jstocbpp_autogen.hpp

@@ -1364,7 +1364,7 @@ struct js_to_cbpp_t<
         couchbase::core::topology::collections_manifest::collection cppObj;
         js_to_cbpp<std::uint64_t>(cppObj.uid, jsObj.Get("uid"));
         js_to_cbpp<std::string>(cppObj.name, jsObj.Get("name"));
-        js_to_cbpp<std::uint32_t>(cppObj.max_expiry, jsObj.Get("max_expiry"));
+        js_to_cbpp<std::int32_t>(cppObj.max_expiry, jsObj.Get("max_expiry"));
         js_to_cbpp<std::optional<bool>>(cppObj.history, jsObj.Get("history"));
         return cppObj;
     }
@@ -1377,7 +1377,7 @@ struct js_to_cbpp_t<
         resObj.Set("uid", cbpp_to_js<std::uint64_t>(env, cppObj.uid));
         resObj.Set("name", cbpp_to_js<std::string>(env, cppObj.name));
         resObj.Set("max_expiry",
-                   cbpp_to_js<std::uint32_t>(env, cppObj.max_expiry));
+                   cbpp_to_js<std::int32_t>(env, cppObj.max_expiry));
         resObj.Set("history",
                    cbpp_to_js<std::optional<bool>>(env, cppObj.history));
         return resObj;
@@ -3874,6 +3874,13 @@ struct js_to_cbpp_t<couchbase::core::operations::search_request> {
         js_to_cbpp<std::string>(cppObj.index_name, jsObj.Get("index_name"));
         js_to_cbpp<couchbase::core::json_string>(cppObj.query,
                                                  jsObj.Get("query"));
+        js_to_cbpp<std::optional<bool>>(cppObj.show_request,
+                                        jsObj.Get("show_request"));
+        js_to_cbpp<std::optional<couchbase::core::json_string>>(
+            cppObj.vector_search, jsObj.Get("vector_search"));
+        js_to_cbpp<std::optional<couchbase::core::vector_query_combination>>(
+            cppObj.vector_query_combination,
+            jsObj.Get("vector_query_combination"));
         js_to_cbpp<std::optional<std::uint32_t>>(cppObj.limit,
                                                  jsObj.Get("limit"));
         js_to_cbpp<std::optional<std::uint32_t>>(cppObj.skip,
@@ -3918,6 +3925,16 @@ struct js_to_cbpp_t<couchbase::core::operations::search_request> {
                    cbpp_to_js<std::string>(env, cppObj.index_name));
         resObj.Set("query",
                    cbpp_to_js<couchbase::core::json_string>(env, cppObj.query));
+        resObj.Set("show_request",
+                   cbpp_to_js<std::optional<bool>>(env, cppObj.show_request));
+        resObj.Set("vector_search",
+                   cbpp_to_js<std::optional<couchbase::core::json_string>>(
+                       env, cppObj.vector_search));
+        resObj.Set(
+            "vector_query_combination",
+            cbpp_to_js<
+                std::optional<couchbase::core::vector_query_combination>>(
+                env, cppObj.vector_query_combination));
         resObj.Set("limit",
                    cbpp_to_js<std::optional<std::uint32_t>>(env, cppObj.limit));
         resObj.Set("skip",
@@ -5252,7 +5269,7 @@ struct js_to_cbpp_t<
         js_to_cbpp<std::string>(cppObj.scope_name, jsObj.Get("scope_name"));
         js_to_cbpp<std::string>(cppObj.collection_name,
                                 jsObj.Get("collection_name"));
-        js_to_cbpp<std::uint32_t>(cppObj.max_expiry, jsObj.Get("max_expiry"));
+        js_to_cbpp<std::int32_t>(cppObj.max_expiry, jsObj.Get("max_expiry"));
         js_to_cbpp<std::optional<bool>>(cppObj.history, jsObj.Get("history"));
         js_to_cbpp<std::optional<std::string>>(cppObj.client_context_id,
                                                jsObj.Get("client_context_id"));
@@ -5273,7 +5290,7 @@ struct js_to_cbpp_t<
         resObj.Set("collection_name",
                    cbpp_to_js<std::string>(env, cppObj.collection_name));
         resObj.Set("max_expiry",
-                   cbpp_to_js<std::uint32_t>(env, cppObj.max_expiry));
+                   cbpp_to_js<std::int32_t>(env, cppObj.max_expiry));
         resObj.Set("history",
                    cbpp_to_js<std::optional<bool>>(env, cppObj.history));
         resObj.Set("client_context_id", cbpp_to_js<std::optional<std::string>>(
@@ -7102,8 +7119,8 @@ struct js_to_cbpp_t<
         js_to_cbpp<std::string>(cppObj.scope_name, jsObj.Get("scope_name"));
         js_to_cbpp<std::string>(cppObj.collection_name,
                                 jsObj.Get("collection_name"));
-        js_to_cbpp<std::optional<std::uint32_t>>(cppObj.max_expiry,
-                                                 jsObj.Get("max_expiry"));
+        js_to_cbpp<std::optional<std::int32_t>>(cppObj.max_expiry,
+                                                jsObj.Get("max_expiry"));
         js_to_cbpp<std::optional<bool>>(cppObj.history, jsObj.Get("history"));
         js_to_cbpp<std::optional<std::string>>(cppObj.client_context_id,
                                                jsObj.Get("client_context_id"));
@@ -7123,7 +7140,7 @@ struct js_to_cbpp_t<
                    cbpp_to_js<std::string>(env, cppObj.scope_name));
         resObj.Set("collection_name",
                    cbpp_to_js<std::string>(env, cppObj.collection_name));
-        resObj.Set("max_expiry", cbpp_to_js<std::optional<std::uint32_t>>(
+        resObj.Set("max_expiry", cbpp_to_js<std::optional<std::int32_t>>(
                                      env, cppObj.max_expiry));
         resObj.Set("history",
                    cbpp_to_js<std::optional<bool>>(env, cppObj.history));

package/tools/gen-bindings-json.py

@@ -72,6 +72,7 @@ fileList = [
     "core/scan_options.hxx",
     "core/range_scan_orchestrator_options.hxx",
     "core/query_context.hxx",
+    "core/vector_query_combination.hxx",
 ]
 
 typeList = [
@@ -165,6 +166,7 @@ typeList = [
     "couchbase::core::range_scan_continue_result",
     "couchbase::core::range_scan_cancel_result",
     "couchbase::core::query_context",
+    "couchbase::core::vector_query_combination",
 ]
 
 # end of configurable part