@google-cloud/discoveryengine 3.1.0 → 3.3.0

package/build/src/v1/search_service_client.d.ts

@@ -198,6 +198,11 @@ export declare 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
@@ -390,6 +395,15 @@ export declare 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
@@ -454,10 +468,6 @@ export declare 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.
      *
@@ -483,6 +493,19 @@ export declare 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 {Promise} - The promise which resolves to an array.
@@ -583,6 +606,11 @@ export declare 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
@@ -775,6 +803,15 @@ export declare 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
@@ -839,10 +876,6 @@ export declare 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.
      *
@@ -868,6 +901,19 @@ export declare 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}
@@ -963,6 +1009,11 @@ export declare 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
@@ -1155,6 +1206,15 @@ export declare 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
@@ -1219,10 +1279,6 @@ export declare 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.
      *
@@ -1248,6 +1304,19 @@ export declare 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}
@@ -1355,6 +1424,11 @@ export declare 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
@@ -1547,6 +1621,15 @@ export declare 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
@@ -1611,10 +1694,6 @@ export declare 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.
      *
@@ -1640,6 +1719,19 @@ export declare 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 {Promise} - The promise which resolves to an array.
@@ -1740,6 +1832,11 @@ export declare 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
@@ -1932,6 +2029,15 @@ export declare 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
@@ -1996,10 +2102,6 @@ export declare 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.
      *
@@ -2025,6 +2127,19 @@ export declare 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}
@@ -2120,6 +2235,11 @@ export declare 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
@@ -2312,6 +2432,15 @@ export declare 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
@@ -2376,10 +2505,6 @@ export declare 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.
      *
@@ -2405,6 +2530,19 @@ export declare 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}