couchbase 4.2.9 → 4.2.10

package/deps/couchbase-cxx-client/couchbase/vector_query.hxx

@@ -0,0 +1,99 @@
+#include <utility>
+
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+namespace couchbase
+{
+/**
+ * @since 1.0.0
+ * @volatile
+ */
+class vector_query
+{
+  public:
+    /**
+     * Creates a vector query
+     *
+     * @param vector_field_name the document field that contains the vector
+     * @param vector_query the vector query to run. Cannot be empty.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    vector_query(std::string vector_field_name, std::vector<double> vector_query)
+      : vector_field_name_{ std::move(vector_field_name) }
+      , vector_query_{ std::move(vector_query) }
+    {
+        if (vector_query_.empty()) {
+            throw std::invalid_argument("the vector_query cannot be empty");
+        }
+    }
+
+    /**
+     * The number of results that will be returned from this vector query. Defaults to 3.
+     *
+     * @param num_candidates the number of results returned
+     *
+     * @return this vector_query for chaining purposes
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto num_candidates(std::uint32_t num_candidates) -> vector_query&
+    {
+        if (num_candidates < 1) {
+            throw std::invalid_argument("The num_candidates cannot be less than 1");
+        }
+        num_candidates_ = num_candidates;
+        return *this;
+    }
+
+    /**
+     * The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight
+     * (with a boost between 0 and 1).
+     *
+     * @param boost boost value
+     *
+     * @return this vector_query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto boost(double boost) -> vector_query&
+    {
+        boost_ = boost;
+        return *this;
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query;
+
+  private:
+    std::string vector_field_name_;
+    std::vector<double> vector_query_;
+    std::uint32_t num_candidates_{ 3 };
+    std::optional<double> boost_{};
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/vector_search.hxx

@@ -0,0 +1,85 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <couchbase/vector_query.hxx>
+#include <couchbase/vector_search_options.hxx>
+
+namespace couchbase
+{
+/**
+ * A vector_search allows one or more @ref vector_query to be executed.
+ *
+ * @since 1.0.0
+ * @volatile
+ */
+class vector_search
+{
+  public:
+    /**
+     * Will execute all of the provided vector_queries, using the specified options
+     *
+     * @param vector_queries vector queries to be run
+     * @param options options to use on the vector queries
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit vector_search(std::vector<vector_query> vector_queries, vector_search_options options = {})
+      : vector_queries_{ std::move(vector_queries) }
+      , options_{ options.build() }
+    {
+    }
+
+    /**
+     * Will execute a singe vector_query, using default options
+     *
+     * @param query the query to be run
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit vector_search(vector_query query)
+      : vector_queries_{ std::vector<vector_query>{ std::move(query) } }
+    {
+    }
+
+    /**
+     * Fetches the vector_search_options
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] vector_search_options::built options() const
+    {
+        return options_;
+    }
+
+    /**
+     * @return encoded representation of the vector_search.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query;
+
+  private:
+    std::vector<vector_query> vector_queries_;
+    vector_search_options::built options_{};
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/vector_search_options.hxx

@@ -0,0 +1,76 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+namespace couchbase
+{
+enum class vector_query_combination { combination_and, combination_or };
+
+/**
+ * Options related to executing a @ref vector_search
+ *
+ * @since 1.0.0
+ * @volatile
+ */
+struct vector_search_options {
+
+    /**
+     * Immutable value object representing consistent options
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    struct built {
+        std::optional<vector_query_combination> combination;
+    };
+
+    /**
+     * Validates options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto build() const -> built
+    {
+        return { combination_ };
+    }
+
+    /**
+     * Sets how the vector query results are combined.
+     *
+     * @param combination @ref vector_query_combination
+     * @return this for chaining purposes
+     *
+     * @since 1.0.0
+     * @volatile
+     *
+     */
+    auto query_combination(vector_query_combination combination) -> vector_search_options&
+    {
+        combination_ = combination;
+        return *this;
+    }
+
+  private:
+    std::optional<vector_query_combination> combination_{};
+};
+} // namespace couchbase

package/dist/binding.d.ts

@@ -131,6 +131,8 @@ export declare enum CppPersistTo {
 }
 export declare enum CppReplicateTo {
 }
+export declare enum CppVectorQueryCombination {
+}
 export interface CppManagementAnalyticsDataset {
     name: string;
     dataverse_name: string;
@@ -858,6 +860,9 @@ export interface CppSearchResponseSearchFacetNumericRangeFacet {
 export interface CppSearchRequest {
     index_name: string;
     query: CppJsonString;
+    show_request?: boolean;
+    vector_search?: CppJsonString;
+    vector_query_combination?: CppVectorQueryCombination;
     limit?: number;
     skip?: number;
     explain?: boolean;
@@ -2461,6 +2466,10 @@ export interface CppBindingAutogen {
         two: CppReplicateTo;
         three: CppReplicateTo;
     };
+    vector_query_combination: {
+        combination_and: CppVectorQueryCombination;
+        combination_or: CppVectorQueryCombination;
+    };
 }
 export type CppErrc = CppErrcCommon | CppErrcKeyValue | CppErrcQuery | CppErrcAnalytics | CppErrcSearch | CppErrcView | CppErrcManagement | CppErrcFieldLevelEncryption | CppErrcNetwork;
 export declare enum CppTxnFailureType {

package/dist/binding.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
+exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppVectorQueryCombination = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
 /*
 eslint
 jsdoc/require-jsdoc: off,
@@ -147,6 +147,9 @@ var CppPersistTo;
 var CppReplicateTo;
 (function (CppReplicateTo) {
 })(CppReplicateTo || (exports.CppReplicateTo = CppReplicateTo = {}));
+var CppVectorQueryCombination;
+(function (CppVectorQueryCombination) {
+})(CppVectorQueryCombination || (exports.CppVectorQueryCombination = CppVectorQueryCombination = {}));
 var CppTxnFailureType;
 (function (CppTxnFailureType) {
 })(CppTxnFailureType || (exports.CppTxnFailureType = CppTxnFailureType = {}));

package/dist/bindingutilities.d.ts

@@ -1,5 +1,5 @@
 import { AnalyticsScanConsistency, AnalyticsStatus } from './analyticstypes';
-import { CppAnalyticsResponseAnalyticsStatus, CppAnalyticsScanConsistency, CppDiagEndpointState, CppDiagPingState, CppDurabilityLevel, CppError, CppManagementClusterBucketCompression, CppManagementClusterBucketConflictResolution, CppManagementClusterBucketEvictionPolicy, CppManagementClusterBucketStorageBackend, CppManagementClusterBucketType, CppMutationState, CppPersistTo, CppPrefixScan, CppQueryProfile, CppQueryScanConsistency, CppRangeScan, CppReplicateTo, CppSamplingScan, CppSearchHighlightStyle, CppSearchScanConsistency, CppServiceType, CppStoreSemantics, CppTxnExternalException, CppTxnOpException, CppViewScanConsistency, CppViewSortOrder } from './binding';
+import { CppAnalyticsResponseAnalyticsStatus, CppAnalyticsScanConsistency, CppDiagEndpointState, CppDiagPingState, CppDurabilityLevel, CppError, CppManagementClusterBucketCompression, CppManagementClusterBucketConflictResolution, CppManagementClusterBucketEvictionPolicy, CppManagementClusterBucketStorageBackend, CppManagementClusterBucketType, CppMutationState, CppPersistTo, CppPrefixScan, CppQueryProfile, CppQueryScanConsistency, CppRangeScan, CppReplicateTo, CppSamplingScan, CppSearchHighlightStyle, CppSearchScanConsistency, CppServiceType, CppStoreSemantics, CppTxnExternalException, CppTxnOpException, CppVectorQueryCombination, CppViewScanConsistency, CppViewSortOrder } from './binding';
 import { BucketType, CompressionMode, ConflictResolutionType, EvictionPolicy, StorageBackend } from './bucketmanager';
 import { EndpointState, PingState } from './diagnosticstypes';
 import { ErrorContext } from './errorcontexts';
@@ -8,6 +8,7 @@ import { MutationState } from './mutationstate';
 import { QueryProfileMode, QueryScanConsistency } from './querytypes';
 import { PrefixScan, RangeScan, SamplingScan } from './rangeScan';
 import { HighlightStyle, SearchScanConsistency } from './searchtypes';
+import { VectorQueryCombination } from './vectorsearch';
 import { ViewOrdering, ViewScanConsistency } from './viewtypes';
 /**
  * @internal
@@ -141,3 +142,7 @@ export declare function bucketConflictResolutionTypeToCpp(type: ConflictResoluti
  * @internal
  */
 export declare function bucketConflictResolutionTypeFromCpp(type: CppManagementClusterBucketConflictResolution): ConflictResolutionType | undefined;
+/**
+ * @internal
+ */
+export declare function vectorQueryCombinationToCpp(combination: VectorQueryCombination | undefined): CppVectorQueryCombination;

package/dist/bindingutilities.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bucketConflictResolutionTypeFromCpp = exports.bucketConflictResolutionTypeToCpp = exports.bucketStorageBackendFromCpp = exports.bucketStorageBackendToCpp = exports.bucketEvictionPolicyFromCpp = exports.bucketEvictionPolicyToCpp = exports.bucketCompressionModeFromCpp = exports.bucketCompressionModeToCpp = exports.bucketTypeFromCpp = exports.bucketTypeToCpp = exports.scanTypeToCpp = exports.errorFromCpp = exports.contextFromCpp = exports.pingStateFromCpp = exports.txnOpExeptionFromCpp = exports.txnExternalExceptionStringFromCpp = exports.endpointStateFromCpp = exports.serviceTypeFromCpp = exports.serviceTypeToCpp = exports.mutationStateToCpp = exports.searchHighlightStyleToCpp = exports.searchScanConsistencyToCpp = exports.analyticsStatusFromCpp = exports.analyticsScanConsistencyToCpp = exports.queryProfileToCpp = exports.queryScanConsistencyToCpp = exports.viewOrderingToCpp = exports.viewScanConsistencyToCpp = exports.storeSemanticToCpp = exports.replicateToToCpp = exports.persistToToCpp = exports.durabilityFromCpp = exports.durabilityToCpp = void 0;
+exports.vectorQueryCombinationToCpp = exports.bucketConflictResolutionTypeFromCpp = exports.bucketConflictResolutionTypeToCpp = exports.bucketStorageBackendFromCpp = exports.bucketStorageBackendToCpp = exports.bucketEvictionPolicyFromCpp = exports.bucketEvictionPolicyToCpp = exports.bucketCompressionModeFromCpp = exports.bucketCompressionModeToCpp = exports.bucketTypeFromCpp = exports.bucketTypeToCpp = exports.scanTypeToCpp = exports.errorFromCpp = exports.contextFromCpp = exports.pingStateFromCpp = exports.txnOpExeptionFromCpp = exports.txnExternalExceptionStringFromCpp = exports.endpointStateFromCpp = exports.serviceTypeFromCpp = exports.serviceTypeToCpp = exports.mutationStateToCpp = exports.searchHighlightStyleToCpp = exports.searchScanConsistencyToCpp = exports.analyticsStatusFromCpp = exports.analyticsScanConsistencyToCpp = exports.queryProfileToCpp = exports.queryScanConsistencyToCpp = exports.viewOrderingToCpp = exports.viewScanConsistencyToCpp = exports.storeSemanticToCpp = exports.replicateToToCpp = exports.persistToToCpp = exports.durabilityFromCpp = exports.durabilityToCpp = void 0;
 const analyticstypes_1 = require("./analyticstypes");
 const binding_1 = __importDefault(require("./binding"));
 const bucketmanager_1 = require("./bucketmanager");
@@ -38,6 +38,7 @@ const querytypes_1 = require("./querytypes");
 const rangeScan_1 = require("./rangeScan");
 const searchtypes_1 = require("./searchtypes");
 const utilities_1 = require("./utilities");
+const vectorsearch_1 = require("./vectorsearch");
 const viewtypes_1 = require("./viewtypes");
 /**
  * @internal
@@ -1011,3 +1012,16 @@ function bucketConflictResolutionTypeFromCpp(type) {
     throw new errs.InvalidArgumentError();
 }
 exports.bucketConflictResolutionTypeFromCpp = bucketConflictResolutionTypeFromCpp;
+/**
+ * @internal
+ */
+function vectorQueryCombinationToCpp(combination) {
+    if (combination === vectorsearch_1.VectorQueryCombination.AND) {
+        return binding_1.default.vector_query_combination.combination_and;
+    }
+    else if (combination === vectorsearch_1.VectorQueryCombination.OR) {
+        return binding_1.default.vector_query_combination.combination_or;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized VectorQueryCombination.'));
+}
+exports.vectorQueryCombinationToCpp = vectorQueryCombinationToCpp;

package/dist/cluster.d.ts

@@ -10,7 +10,7 @@ import { QueryIndexManager } from './queryindexmanager';
 import { QueryMetaData, QueryOptions, QueryResult } from './querytypes';
 import { SearchIndexManager } from './searchindexmanager';
 import { SearchQuery } from './searchquery';
-import { SearchMetaData, SearchQueryOptions, SearchResult, SearchRow } from './searchtypes';
+import { SearchMetaData, SearchQueryOptions, SearchRequest, SearchResult, SearchRow } from './searchtypes';
 import { StreamableRowPromise } from './streamablepromises';
 import { Transactions, TransactionsConfig } from './transactions';
 import { Transcoder } from './transcoders';
@@ -300,6 +300,17 @@ export declare class Cluster {
      * @param callback A node-style callback to be invoked after execution.
      */
     searchQuery(indexName: string, query: SearchQuery, options?: SearchQueryOptions, callback?: NodeCallback<SearchResult>): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
+    /**
+     * Executes a search query against the cluster.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param indexName The name of the index to query.
+     * @param request The SearchRequest describing the search to execute.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    search(indexName: string, request: SearchRequest, options?: SearchQueryOptions, callback?: NodeCallback<SearchResult>): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
     /**
      * Returns a diagnostics report about the currently active connections with the
      * cluster.  Includes information about remote and local addresses, last activity,

package/dist/cluster.js

@@ -317,6 +317,28 @@ class Cluster {
         const options_ = options;
         return utilities_1.PromiseHelper.wrapAsync(() => exec.query(indexName, query, options_), callback);
     }
+    /**
+     * Executes a search query against the cluster.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param indexName The name of the index to query.
+     * @param request The SearchRequest describing the search to execute.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    search(indexName, request, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[2];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const exec = new searchexecutor_1.SearchExecutor(this);
+        const options_ = options;
+        return utilities_1.PromiseHelper.wrapAsync(() => exec.query(indexName, request, options_), callback);
+    }
     /**
      * Returns a diagnostics report about the currently active connections with the
      * cluster.  Includes information about remote and local addresses, last activity,

package/dist/couchbase.d.ts

@@ -70,6 +70,7 @@ export * from './streamablepromises';
 export * from './transactions';
 export * from './transcoders';
 export * from './usermanager';
+export * from './vectorsearch';
 export * from './viewexecutor';
 export * from './viewindexmanager';
 export * from './viewtypes';

package/dist/couchbase.js

@@ -99,6 +99,7 @@ __exportStar(require("./streamablepromises"), exports);
 __exportStar(require("./transactions"), exports);
 __exportStar(require("./transcoders"), exports);
 __exportStar(require("./usermanager"), exports);
+__exportStar(require("./vectorsearch"), exports);
 __exportStar(require("./viewexecutor"), exports);
 __exportStar(require("./viewindexmanager"), exports);
 __exportStar(require("./viewtypes"), exports);

package/dist/searchexecutor.d.ts

@@ -1,6 +1,6 @@
 import { Cluster } from './cluster';
 import { SearchQuery } from './searchquery';
-import { SearchMetaData, SearchQueryOptions, SearchResult, SearchRow } from './searchtypes';
+import { SearchMetaData, SearchQueryOptions, SearchRequest, SearchResult, SearchRow } from './searchtypes';
 import { StreamableRowPromise } from './streamablepromises';
 /**
  * @internal
@@ -14,5 +14,5 @@ export declare class SearchExecutor {
     /**
      * @internal
      */
-    query(indexName: string, query: SearchQuery, options: SearchQueryOptions): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
+    query(indexName: string, query: SearchQuery | SearchRequest, options: SearchQueryOptions): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
 }

package/dist/searchexecutor.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchExecutor = void 0;
 /* eslint jsdoc/require-jsdoc: off */
 const bindingutilities_1 = require("./bindingutilities");
+const searchquery_1 = require("./searchquery");
 const searchtypes_1 = require("./searchtypes");
 const streamablepromises_1 = require("./streamablepromises");
 /**
@@ -25,11 +26,16 @@ class SearchExecutor {
                 meta: meta,
             });
         });
+        const searchQuery = query instanceof searchquery_1.SearchQuery
+            ? JSON.stringify(query)
+            : query.searchQuery
+                ? JSON.stringify(query.searchQuery)
+                : JSON.stringify(new searchquery_1.MatchNoneSearchQuery());
         const timeout = options.timeout || this._cluster.searchTimeout;
-        this._cluster.conn.search({
+        const request = {
             timeout,
             index_name: indexName,
-            query: JSON.stringify(query),
+            query: searchQuery,
             limit: options.limit,
             skip: options.skip,
             explain: options.explain || false,
@@ -59,7 +65,17 @@ class SearchExecutor {
                     .map(([k, v]) => [k, JSON.stringify(v)]))
                 : {},
             body_str: '',
-        }, (cppErr, resp) => {
+        };
+        if (query instanceof searchtypes_1.SearchRequest) {
+            request.show_request = false;
+            if (query.vectorSearch) {
+                request.vector_search = JSON.stringify(query.vectorSearch.queries);
+                if (query.vectorSearch.options && query.vectorSearch.options.vectorQueryCombination) {
+                    request.vector_query_combination = (0, bindingutilities_1.vectorQueryCombinationToCpp)(query.vectorSearch.options.vectorQueryCombination);
+                }
+            }
+        }
+        this._cluster.conn.search(request, (cppErr, resp) => {
             const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
             if (err) {
                 emitter.emit('error', err);

package/dist/searchtypes.d.ts

@@ -1,6 +1,8 @@
 import { MutationState } from './mutationstate';
 import { SearchFacet } from './searchfacet';
+import { SearchQuery } from './searchquery';
 import { SearchSort } from './searchsort';
+import { VectorSearch } from './vectorsearch';
 /**
  * SearchMetaData represents the meta-data available from a search query.
  * This class is currently incomplete and must be casted to `any` in
@@ -145,3 +147,47 @@ export interface SearchQueryOptions {
      */
     timeout?: number;
 }
+/**
+ *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.
+ *
+ *  Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+export declare class SearchRequest {
+    private _searchQuery;
+    private _vectorSearch;
+    constructor(query: SearchQuery | VectorSearch);
+    /**
+     * @internal
+     */
+    get searchQuery(): SearchQuery | undefined;
+    /**
+     * @internal
+     */
+    get vectorSearch(): VectorSearch | undefined;
+    /**
+     * Adds a search query to the request if the request does not already have a search query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A SearchQuery to add to the request.
+     */
+    withSearchQuery(query: SearchQuery): SearchRequest;
+    /**
+     * Adds a vector search to the request if the request does not already have a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param search A VectorSearch to add to the request.
+     */
+    withVectorSearch(search: VectorSearch): SearchRequest;
+    /**
+     * Creates a search request.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query Either a SearchQuery or VectorSearch to add to the search request.
+     */
+    static create(query: SearchQuery | VectorSearch): SearchRequest;
+}

package/dist/searchtypes.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchScanConsistency = exports.HighlightStyle = exports.SearchResult = exports.SearchRow = exports.SearchMetaData = void 0;
+exports.SearchRequest = exports.SearchScanConsistency = exports.HighlightStyle = exports.SearchResult = exports.SearchRow = exports.SearchMetaData = void 0;
+const errors_1 = require("./errors");
+const searchquery_1 = require("./searchquery");
+const vectorsearch_1 = require("./vectorsearch");
 /**
  * SearchMetaData represents the meta-data available from a search query.
  * This class is currently incomplete and must be casted to `any` in
@@ -67,3 +70,80 @@ var SearchScanConsistency;
      */
     SearchScanConsistency["NotBounded"] = "not_bounded";
 })(SearchScanConsistency || (exports.SearchScanConsistency = SearchScanConsistency = {}));
+/**
+ *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.
+ *
+ *  Volatile: This API is subject to change at any time.
+ *
+ * @category Full Text Search
+ */
+class SearchRequest {
+    constructor(query) {
+        if (query instanceof searchquery_1.SearchQuery) {
+            this._searchQuery = query;
+        }
+        else if (query instanceof vectorsearch_1.VectorSearch) {
+            this._vectorSearch = query;
+        }
+        else {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide either a SearchQuery or VectorSearch when creating SearchRequest.'));
+        }
+    }
+    /**
+     * @internal
+     */
+    get searchQuery() {
+        return this._searchQuery;
+    }
+    /**
+     * @internal
+     */
+    get vectorSearch() {
+        return this._vectorSearch;
+    }
+    /**
+     * Adds a search query to the request if the request does not already have a search query.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query A SearchQuery to add to the request.
+     */
+    withSearchQuery(query) {
+        if (!(query instanceof searchquery_1.SearchQuery)) {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide a SearchQuery.'));
+        }
+        if (this._searchQuery) {
+            throw new errors_1.InvalidArgumentError(new Error('Request already has a SearchQuery.'));
+        }
+        this._searchQuery = query;
+        return this;
+    }
+    /**
+     * Adds a vector search to the request if the request does not already have a vector search.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param search A VectorSearch to add to the request.
+     */
+    withVectorSearch(search) {
+        if (!(search instanceof vectorsearch_1.VectorSearch)) {
+            throw new errors_1.InvalidArgumentError(new Error('Must provide a VectorSearch.'));
+        }
+        if (this._vectorSearch) {
+            throw new errors_1.InvalidArgumentError(new Error('Request already has a VectorSearch.'));
+        }
+        this._vectorSearch = search;
+        return this;
+    }
+    /**
+     * Creates a search request.
+     *
+     * Volatile: This API is subject to change at any time.
+     *
+     * @param query Either a SearchQuery or VectorSearch to add to the search request.
+     */
+    static create(query) {
+        return new SearchRequest(query);
+    }
+}
+exports.SearchRequest = SearchRequest;