@google-cloud/discoveryengine 3.2.0 → 3.3.1

package/build/src/v1/search_service_client.js

@@ -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.
@@ -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}
@@ -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}
@@ -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}
@@ -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}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",
@@ -67,10 +67,5 @@
   },
   "overrides": {
     "@sinonjs/fake-timers": "15.2.1"
-  },
-  "pnpm": {
-    "overrides": {
-      "@sinonjs/fake-timers": "15.2.1"
-    }
   }
 }