@google-cloud/discoveryengine 2.0.0 → 2.1.0

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

@@ -171,10 +171,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -219,7 +222,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -301,6 +304,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -332,6 +338,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @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.
@@ -405,10 +421,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -453,7 +472,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -535,6 +554,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -566,6 +588,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -634,10 +666,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -682,7 +717,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -764,6 +799,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -795,6 +833,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -875,10 +923,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -923,7 +974,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -1005,6 +1056,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -1036,6 +1090,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @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.
@@ -1109,10 +1173,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -1157,7 +1224,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -1239,6 +1306,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -1270,6 +1340,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -1338,10 +1418,13 @@ export declare class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @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
@@ -1386,7 +1469,7 @@ export declare class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -1468,6 +1551,9 @@ export declare class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -1499,6 +1585,16 @@ export declare class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -2292,6 +2388,57 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
      *
@@ -3162,6 +3309,48 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
      *