@google-cloud/discoveryengine 3.1.0 → 3.3.0

package/build/src/v1/search_service_client.js

@@ -253,7 +253,7 @@ class SearchServiceClient {
         // and create an API call method for each.
         const searchServiceStubMethods = ['search', 'searchLite'];
         for (const methodName of searchServiceStubMethods) {
-            const callPromise = this.searchServiceStub.then((stub) => (...args) => {
+            const callPromise = this.searchServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -315,7 +315,12 @@ class SearchServiceClient {
      * @returns {string[]} List of default scopes.
      */
     static get scopes() {
-        return ['https://www.googleapis.com/auth/cloud-platform'];
+        return [
+            'https://www.googleapis.com/auth/cloud-platform',
+            'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
+            'https://www.googleapis.com/auth/discoveryengine.readwrite',
+            'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
+        ];
     }
     /**
      * Return the project ID used by this class.
@@ -345,7 +350,7 @@ class SearchServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 serving_config: request.servingConfig ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -443,6 +448,11 @@ class SearchServiceClient {
      *   stores. For engines with a single data store, the specs directly under
      *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
      *   used.
+     * @param {number} [request.numResultsPerDataStore]
+     *   Optional. The maximum number of results to retrieve from each data store.
+     *   If not specified, it will use the
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
+     *   if provided, otherwise there is no limit.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -635,6 +645,15 @@ class SearchServiceClient {
      *     Google model to determine the keyword-based overlap between the query and
      *     the document.
      *     * `base_rank`: the default rank of the result
+     *     * `media_actor_match`: whether the media actor matches the query
+     *     * `media_director_match`: whether the media director matches the query
+     *     * `media_genre_match`: whether the media genre matches the query
+     *     * `media_language_match`: whether the media language matches the query
+     *     * `media_title_match`: whether the media title matches the query
+     *     * `media_prefix_similarity_rank`: prefix similarity rank for media
+     *     results
+     *     * `media_semantic_similarity_rank`: semantic similarity rank for media
+     *     results
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
      *   Optional. The backend to use for the ranking expression evaluation.
      * @param {boolean} request.safeSearch
@@ -699,10 +718,6 @@ class SearchServiceClient {
      *     Call /answer API with the session ID generated in the first call.
      *     Here, the answer generation happens in the context of the search
      *     results from the first search call.
-     *
-     *   Multi-turn Search feature is currently at private GA stage. Please use
-     *   v1alpha or v1beta version instead before we launch this feature to public
-     *   GA. Or ask for allowlisting through Google Support team.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
      *   Session specification.
      *
@@ -728,6 +743,19 @@ class SearchServiceClient {
      *   This feature is currently supported only for custom and site search.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
      *   Optional. The specification for returning the relevance score.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
+     *   Optional. SearchAddonSpec is used to disable add-ons for search as per new
+     *   repricing model.
+     *   This field is only supported for search requests.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
+     *   Optional. Optional configuration for the Custom Ranking feature.
+     * @param {string} [request.entity]
+     *   Optional. The entity for customers that may run multiple different
+     *   entities, domains, sites or regions, for example, "Google US", "Google
+     *   Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
+     *   be exactly matched with
+     *   {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
+     *   search results boosted by entity.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -750,7 +778,7 @@ class SearchServiceClient {
             });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('search stream %j', request);
@@ -839,6 +867,11 @@ class SearchServiceClient {
      *   stores. For engines with a single data store, the specs directly under
      *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
      *   used.
+     * @param {number} [request.numResultsPerDataStore]
+     *   Optional. The maximum number of results to retrieve from each data store.
+     *   If not specified, it will use the
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
+     *   if provided, otherwise there is no limit.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -1031,6 +1064,15 @@ class SearchServiceClient {
      *     Google model to determine the keyword-based overlap between the query and
      *     the document.
      *     * `base_rank`: the default rank of the result
+     *     * `media_actor_match`: whether the media actor matches the query
+     *     * `media_director_match`: whether the media director matches the query
+     *     * `media_genre_match`: whether the media genre matches the query
+     *     * `media_language_match`: whether the media language matches the query
+     *     * `media_title_match`: whether the media title matches the query
+     *     * `media_prefix_similarity_rank`: prefix similarity rank for media
+     *     results
+     *     * `media_semantic_similarity_rank`: semantic similarity rank for media
+     *     results
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
      *   Optional. The backend to use for the ranking expression evaluation.
      * @param {boolean} request.safeSearch
@@ -1095,10 +1137,6 @@ class SearchServiceClient {
      *     Call /answer API with the session ID generated in the first call.
      *     Here, the answer generation happens in the context of the search
      *     results from the first search call.
-     *
-     *   Multi-turn Search feature is currently at private GA stage. Please use
-     *   v1alpha or v1beta version instead before we launch this feature to public
-     *   GA. Or ask for allowlisting through Google Support team.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
      *   Session specification.
      *
@@ -1124,6 +1162,19 @@ class SearchServiceClient {
      *   This feature is currently supported only for custom and site search.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
      *   Optional. The specification for returning the relevance score.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
+     *   Optional. SearchAddonSpec is used to disable add-ons for search as per new
+     *   repricing model.
+     *   This field is only supported for search requests.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
+     *   Optional. Optional configuration for the Custom Ranking feature.
+     * @param {string} [request.entity]
+     *   Optional. The entity for customers that may run multiple different
+     *   entities, domains, sites or regions, for example, "Google US", "Google
+     *   Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
+     *   be exactly matched with
+     *   {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
+     *   search results boosted by entity.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -1147,7 +1198,7 @@ class SearchServiceClient {
             });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('search iterate %j', request);
@@ -1170,7 +1221,7 @@ class SearchServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 serving_config: request.servingConfig ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -1268,6 +1319,11 @@ class SearchServiceClient {
      *   stores. For engines with a single data store, the specs directly under
      *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
      *   used.
+     * @param {number} [request.numResultsPerDataStore]
+     *   Optional. The maximum number of results to retrieve from each data store.
+     *   If not specified, it will use the
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
+     *   if provided, otherwise there is no limit.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -1460,6 +1516,15 @@ class SearchServiceClient {
      *     Google model to determine the keyword-based overlap between the query and
      *     the document.
      *     * `base_rank`: the default rank of the result
+     *     * `media_actor_match`: whether the media actor matches the query
+     *     * `media_director_match`: whether the media director matches the query
+     *     * `media_genre_match`: whether the media genre matches the query
+     *     * `media_language_match`: whether the media language matches the query
+     *     * `media_title_match`: whether the media title matches the query
+     *     * `media_prefix_similarity_rank`: prefix similarity rank for media
+     *     results
+     *     * `media_semantic_similarity_rank`: semantic similarity rank for media
+     *     results
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
      *   Optional. The backend to use for the ranking expression evaluation.
      * @param {boolean} request.safeSearch
@@ -1524,10 +1589,6 @@ class SearchServiceClient {
      *     Call /answer API with the session ID generated in the first call.
      *     Here, the answer generation happens in the context of the search
      *     results from the first search call.
-     *
-     *   Multi-turn Search feature is currently at private GA stage. Please use
-     *   v1alpha or v1beta version instead before we launch this feature to public
-     *   GA. Or ask for allowlisting through Google Support team.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
      *   Session specification.
      *
@@ -1553,6 +1614,19 @@ class SearchServiceClient {
      *   This feature is currently supported only for custom and site search.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
      *   Optional. The specification for returning the relevance score.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
+     *   Optional. SearchAddonSpec is used to disable add-ons for search as per new
+     *   repricing model.
+     *   This field is only supported for search requests.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
+     *   Optional. Optional configuration for the Custom Ranking feature.
+     * @param {string} [request.entity]
+     *   Optional. The entity for customers that may run multiple different
+     *   entities, domains, sites or regions, for example, "Google US", "Google
+     *   Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
+     *   be exactly matched with
+     *   {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
+     *   search results boosted by entity.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -1575,7 +1649,7 @@ class SearchServiceClient {
             });
         const defaultCallSettings = this._defaults['searchLite'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('searchLite stream %j', request);
@@ -1664,6 +1738,11 @@ class SearchServiceClient {
      *   stores. For engines with a single data store, the specs directly under
      *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
      *   used.
+     * @param {number} [request.numResultsPerDataStore]
+     *   Optional. The maximum number of results to retrieve from each data store.
+     *   If not specified, it will use the
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results|SearchRequest.DataStoreSpec.num_results}
+     *   if provided, otherwise there is no limit.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -1856,6 +1935,15 @@ class SearchServiceClient {
      *     Google model to determine the keyword-based overlap between the query and
      *     the document.
      *     * `base_rank`: the default rank of the result
+     *     * `media_actor_match`: whether the media actor matches the query
+     *     * `media_director_match`: whether the media director matches the query
+     *     * `media_genre_match`: whether the media genre matches the query
+     *     * `media_language_match`: whether the media language matches the query
+     *     * `media_title_match`: whether the media title matches the query
+     *     * `media_prefix_similarity_rank`: prefix similarity rank for media
+     *     results
+     *     * `media_semantic_similarity_rank`: semantic similarity rank for media
+     *     results
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
      *   Optional. The backend to use for the ranking expression evaluation.
      * @param {boolean} request.safeSearch
@@ -1920,10 +2008,6 @@ class SearchServiceClient {
      *     Call /answer API with the session ID generated in the first call.
      *     Here, the answer generation happens in the context of the search
      *     results from the first search call.
-     *
-     *   Multi-turn Search feature is currently at private GA stage. Please use
-     *   v1alpha or v1beta version instead before we launch this feature to public
-     *   GA. Or ask for allowlisting through Google Support team.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
      *   Session specification.
      *
@@ -1949,6 +2033,19 @@ class SearchServiceClient {
      *   This feature is currently supported only for custom and site search.
      * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
      *   Optional. The specification for returning the relevance score.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec} [request.searchAddonSpec]
+     *   Optional. SearchAddonSpec is used to disable add-ons for search as per new
+     *   repricing model.
+     *   This field is only supported for search requests.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams} [request.customRankingParams]
+     *   Optional. Optional configuration for the Custom Ranking feature.
+     * @param {string} [request.entity]
+     *   Optional. The entity for customers that may run multiple different
+     *   entities, domains, sites or regions, for example, "Google US", "Google
+     *   Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
+     *   be exactly matched with
+     *   {@link protos.google.cloud.discoveryengine.v1.UserEvent.entity|UserEvent.entity} to get
+     *   search results boosted by entity.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -1972,7 +2069,7 @@ class SearchServiceClient {
             });
         const defaultCallSettings = this._defaults['searchLite'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('searchLite iterate %j', request);
@@ -4676,11 +4773,11 @@ class SearchServiceClient {
      */
     close() {
         if (this.searchServiceStub && !this._terminated) {
-            return this.searchServiceStub.then((stub) => {
+            return this.searchServiceStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close().catch((err) => {
+                this.locationsClient.close().catch(err => {
                     throw err;
                 });
             });

package/build/src/v1/search_tuning_service_client.js

@@ -315,18 +315,14 @@ class SearchTuningServiceClient {
                         {
                             get: '/v1/{name=projects/*/locations/*/collections/*/engines/*}/operations',
                         },
-                        {
-                            get: '/v1/{name=projects/*/locations/*/collections/*}/operations',
-                        },
+                        { get: '/v1/{name=projects/*/locations/*/collections/*}/operations' },
                         {
                             get: '/v1/{name=projects/*/locations/*/dataStores/*/branches/*}/operations',
                         },
                         {
                             get: '/v1/{name=projects/*/locations/*/dataStores/*/models/*}/operations',
                         },
-                        {
-                            get: '/v1/{name=projects/*/locations/*/dataStores/*}/operations',
-                        },
+                        { get: '/v1/{name=projects/*/locations/*/dataStores/*}/operations' },
                         {
                             get: '/v1/{name=projects/*/locations/*/identityMappingStores/*}/operations',
                         },
@@ -383,7 +379,7 @@ class SearchTuningServiceClient {
             'listCustomModels',
         ];
         for (const methodName of searchTuningServiceStubMethods) {
-            const callPromise = this.searchTuningServiceStub.then((stub) => (...args) => {
+            const callPromise = this.searchTuningServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -475,7 +471,7 @@ class SearchTuningServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 data_store: request.dataStore ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listCustomModels request %j', request);
@@ -518,7 +514,7 @@ class SearchTuningServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 data_store: request.dataStore ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -3305,11 +3301,11 @@ class SearchTuningServiceClient {
      */
     close() {
         if (this.searchTuningServiceStub && !this._terminated) {
-            return this.searchTuningServiceStub.then((stub) => {
+            return this.searchTuningServiceStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close().catch((err) => {
+                this.locationsClient.close().catch(err => {
                     throw err;
                 });
                 void this.operationsClient.close();

package/build/src/v1/serving_config_service_client.js

@@ -246,7 +246,7 @@ class ServingConfigServiceClient {
         // and create an API call method for each.
         const servingConfigServiceStubMethods = ['updateServingConfig'];
         for (const methodName of servingConfigServiceStubMethods) {
-            const callPromise = this.servingConfigServiceStub.then((stub) => (...args) => {
+            const callPromise = this.servingConfigServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -338,7 +338,7 @@ class ServingConfigServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 'serving_config.name': request.servingConfig.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('updateServingConfig request %j', request);
@@ -2936,11 +2936,11 @@ class ServingConfigServiceClient {
      */
     close() {
         if (this.servingConfigServiceStub && !this._terminated) {
-            return this.servingConfigServiceStub.then((stub) => {
+            return this.servingConfigServiceStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close().catch((err) => {
+                this.locationsClient.close().catch(err => {
                     throw err;
                 });
             });

package/build/src/v1/session_service_client.js

@@ -256,7 +256,7 @@ class SessionServiceClient {
             'listSessions',
         ];
         for (const methodName of sessionServiceStubMethods) {
-            const callPromise = this.sessionServiceStub.then((stub) => (...args) => {
+            const callPromise = this.sessionServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -348,7 +348,7 @@ class SessionServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('createSession request %j', request);
@@ -391,7 +391,7 @@ class SessionServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('deleteSession request %j', request);
@@ -434,7 +434,7 @@ class SessionServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 'session.name': request.session.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('updateSession request %j', request);
@@ -477,7 +477,7 @@ class SessionServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getSession request %j', request);
@@ -520,7 +520,7 @@ class SessionServiceClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -606,7 +606,7 @@ class SessionServiceClient {
             });
         const defaultCallSettings = this._defaults['listSessions'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listSessions stream %j', request);
@@ -684,7 +684,7 @@ class SessionServiceClient {
             });
         const defaultCallSettings = this._defaults['listSessions'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listSessions iterate %j', request);
@@ -3262,11 +3262,11 @@ class SessionServiceClient {
      */
     close() {
         if (this.sessionServiceStub && !this._terminated) {
-            return this.sessionServiceStub.then((stub) => {
+            return this.sessionServiceStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close().catch((err) => {
+                this.locationsClient.close().catch(err => {
                     throw err;
                 });
             });