@google-cloud/discoveryengine 1.3.0 → 1.4.0

package/build/src/v1/search_service_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ class SearchServiceClient {
      *     ```
      */
     constructor(opts, gaxInstance) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         this._terminated = false;
         this.descriptors = {
             page: {},
@@ -82,16 +82,24 @@ class SearchServiceClient {
         };
         // Ensure that options include all the required fields.
         const staticMembers = this.constructor;
-        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
+        if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
+            (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
+            (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
+            throw new Error('Please set either universe_domain or universeDomain, but not both.');
+        }
+        this._universeDomain =
+            (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
+        this._servicePath = 'discoveryengine.' + this._universeDomain;
+        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
         this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
         const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
-        const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
-        const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
+        const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
         // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
-        if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
+        if (servicePath !== this._servicePath && !('scopes' in opts)) {
             opts['scopes'] = staticMembers.scopes;
         }
         // Load google-gax module synchronously if needed
@@ -109,9 +117,9 @@ class SearchServiceClient {
         // Set useJWTAccessWithScope on the auth object.
         this.auth.useJWTAccessWithScope = true;
         // Set defaultServicePath on the auth object.
-        this.auth.defaultServicePath = staticMembers.servicePath;
+        this.auth.defaultServicePath = this._servicePath;
         // Set the default scopes in auth client if needed.
-        if (servicePath === staticMembers.servicePath) {
+        if (servicePath === this._servicePath) {
             this.auth.defaultScopes = staticMembers.scopes;
         }
         this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
@@ -138,16 +146,25 @@ class SearchServiceClient {
         // identifiers to uniquely identify resources within the API.
         // Create useful helper objects for these.
         this.pathTemplates = {
+            enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
+            projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
             projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
             projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
             projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
+            projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
+            projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
+            projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
+            projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
             projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
             projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
             projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
+            projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
         };
         // Some of the methods on this service return "paged" results,
         // (e.g. 50 results at a time, with tokens to get subsequent
@@ -207,19 +224,38 @@ class SearchServiceClient {
     }
     /**
      * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get servicePath() {
+        if (typeof process !== undefined &&
+            typeof process.emitWarning === 'function') {
+            process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
         return 'discoveryengine.googleapis.com';
     }
     /**
-     * The DNS address for this API service - same as servicePath(),
-     * exists for compatibility reasons.
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint() {
+        if (typeof process !== undefined &&
+            typeof process.emitWarning === 'function') {
+            process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
         return 'discoveryengine.googleapis.com';
     }
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint() {
+        return this._servicePath;
+    }
+    get universeDomain() {
+        return this._universeDomain;
+    }
     /**
      * The port for this API service.
      * @returns {number} The default port for this service.
@@ -273,6 +309,8 @@ class SearchServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
+     *   or
      *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
      *   This field is used to identify the serving configuration name, set
      *   of models used to make the search.
@@ -316,11 +354,35 @@ class SearchServiceClient {
      *   expression is case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     *
+     *   Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+     *   key property defined in the Vertex AI Search backend -- this mapping is
+     *   defined by the customer in their schema. For example a media customer might
+     *   have a field 'name' in their schema. In this case the filter would look
+     *   like this: filter --> name:'ANY("king kong")'
+     *
+     *   For more information about filtering including syntax and filter
+     *   operators, see
+     *   [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+     * @param {string} request.canonicalFilter
+     *   The default filter that is applied when a user performs a search without
+     *   checking any filters on the search page.
+     *
+     *   The filter applied to every search request when quality improvement such as
+     *   query expansion is needed. In the case a query does not have a sufficient
+     *   amount of results this filter will be used to determine whether or not to
+     *   enable the query expansion flow. The original filter will still be used for
+     *   the query expanded search.
+     *   This field is strongly recommended to achieve high search quality.
+     *
+     *   For more information about filter syntax, see
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
      * @param {string} request.orderBy
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
      *   Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
+     *   case-sensitive. For more information on ordering, see
+     *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
@@ -335,6 +397,8 @@ class SearchServiceClient {
      *   error is returned.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
+     *   For more information on boosting, see
+     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -342,9 +406,17 @@ class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
+     *      Example:
+     *      user_country_code: "au"
+     *
+     *      For available codes see [Country
+     *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+     *
      *   * `search_type`: double. Default empty. Enables non-webpage searching
-     *     depending on the value. The only valid non-default value is 1,
-     *     which enables image searching.
+     *      depending on the value. The only valid non-default value is 1,
+     *      which enables image searching.
+     *      Example:
+     *      search_type: 1
      * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -423,6 +495,8 @@ class SearchServiceClient {
      *   The request object that will be sent.
      * @param {string} request.servingConfig
      *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
+     *   or
      *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
      *   This field is used to identify the serving configuration name, set
      *   of models used to make the search.
@@ -466,11 +540,35 @@ class SearchServiceClient {
      *   expression is case-sensitive.
      *
      *   If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+     *
+     *   Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+     *   key property defined in the Vertex AI Search backend -- this mapping is
+     *   defined by the customer in their schema. For example a media customer might
+     *   have a field 'name' in their schema. In this case the filter would look
+     *   like this: filter --> name:'ANY("king kong")'
+     *
+     *   For more information about filtering including syntax and filter
+     *   operators, see
+     *   [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+     * @param {string} request.canonicalFilter
+     *   The default filter that is applied when a user performs a search without
+     *   checking any filters on the search page.
+     *
+     *   The filter applied to every search request when quality improvement such as
+     *   query expansion is needed. In the case a query does not have a sufficient
+     *   amount of results this filter will be used to determine whether or not to
+     *   enable the query expansion flow. The original filter will still be used for
+     *   the query expanded search.
+     *   This field is strongly recommended to achieve high search quality.
+     *
+     *   For more information about filter syntax, see
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
      * @param {string} request.orderBy
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
      *   Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive.
+     *   case-sensitive. For more information on ordering, see
+     *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
@@ -485,6 +583,8 @@ class SearchServiceClient {
      *   error is returned.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
+     *   For more information on boosting, see
+     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -492,9 +592,17 @@ class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
+     *      Example:
+     *      user_country_code: "au"
+     *
+     *      For available codes see [Country
+     *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+     *
      *   * `search_type`: double. Default empty. Enables non-webpage searching
-     *     depending on the value. The only valid non-default value is 1,
-     *     which enables image searching.
+     *      depending on the value. The only valid non-default value is 1,
+     *      which enables image searching.
+     *      Example:
+     *      search_type: 1
      * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -624,6 +732,120 @@ class SearchServiceClient {
     // --------------------
     // -- Path templates --
     // --------------------
+    /**
+     * Return a fully-qualified engine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @returns {string} Resource name string.
+     */
+    enginePath(project, location, collection, engine) {
+        return this.pathTemplates.enginePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+        });
+    }
+    /**
+     * Parse the project from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).project;
+    }
+    /**
+     * Parse the location from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).location;
+    }
+    /**
+     * Parse the collection from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).collection;
+    }
+    /**
+     * Parse the engine from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).engine;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
      *
@@ -981,6 +1203,315 @@ class SearchServiceClient {
     matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
         return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            target_site: targetSite,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
+    }
+    /**
+     * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
+    }
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
+    }
+    /**
+     * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+            serving_config: servingConfig,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
+    }
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
+    }
+    /**
+     * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
+        return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStorePath(project, location, dataStore) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreBranch resource name string.
      *
@@ -1278,6 +1809,108 @@ class SearchServiceClient {
     matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
         return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            target_site: targetSite,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
+    }
+    /**
+     * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
+    }
     /**
      * Terminate the gRPC channel and close the client.
      *