@google-cloud/discoveryengine 1.8.0 → 1.9.0

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

@@ -167,7 +167,10 @@ export declare class SearchServiceClient {
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {number[]} request.dataStoreSpecs
-     *   A list of data store specs to apply on a search call.
+     *   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.
      * @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
@@ -201,7 +204,9 @@ export declare class SearchServiceClient {
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive. For more information on ordering, see
+     *   case-sensitive.
+     *
+     *   For more information on ordering for retail search, see
      *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -218,7 +223,7 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
      *   For more information on boosting, see
-     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+     *   [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -226,8 +231,7 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
-     *      Example:
-     *      user_country_code: "au"
+     *      For example, `user_country_code: "au"`
      *
      *      For available codes see [Country
      *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -235,8 +239,7 @@ export declare class SearchServiceClient {
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *      depending on the value. The only valid non-default value is 1,
      *      which enables image searching.
-     *      Example:
-     *      search_type: 1
+     *      For example, `search_type: 1`
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -382,7 +385,10 @@ export declare class SearchServiceClient {
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {number[]} request.dataStoreSpecs
-     *   A list of data store specs to apply on a search call.
+     *   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.
      * @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
@@ -416,7 +422,9 @@ export declare class SearchServiceClient {
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive. For more information on ordering, see
+     *   case-sensitive.
+     *
+     *   For more information on ordering for retail search, see
      *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -433,7 +441,7 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
      *   For more information on boosting, see
-     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+     *   [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -441,8 +449,7 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
-     *      Example:
-     *      user_country_code: "au"
+     *      For example, `user_country_code: "au"`
      *
      *      For available codes see [Country
      *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -450,8 +457,7 @@ export declare class SearchServiceClient {
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *      depending on the value. The only valid non-default value is 1,
      *      which enables image searching.
-     *      Example:
-     *      search_type: 1
+     *      For example, `search_type: 1`
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -592,7 +598,10 @@ export declare class SearchServiceClient {
      *
      *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      * @param {number[]} request.dataStoreSpecs
-     *   A list of data store specs to apply on a search call.
+     *   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.
      * @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
@@ -626,7 +635,9 @@ export declare class SearchServiceClient {
      *   The order in which documents are returned. Documents can be ordered by
      *   a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
      *   object. Leave it unset if ordered by relevance. `order_by` expression is
-     *   case-sensitive. For more information on ordering, see
+     *   case-sensitive.
+     *
+     *   For more information on ordering for retail search, see
      *   [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
      *
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -643,7 +654,7 @@ export declare class SearchServiceClient {
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
      *   Boost specification to boost certain documents.
      *   For more information on boosting, see
-     *   [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+     *   [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      * @param {number[]} request.params
      *   Additional search parameters.
      *
@@ -651,8 +662,7 @@ export declare class SearchServiceClient {
      *
      *   * `user_country_code`: string. Default empty. If set to non-empty, results
      *      are restricted or boosted based on the location provided.
-     *      Example:
-     *      user_country_code: "au"
+     *      For example, `user_country_code: "au"`
      *
      *      For available codes see [Country
      *      Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -660,8 +670,7 @@ export declare class SearchServiceClient {
      *   * `search_type`: double. Default empty. Enables non-webpage searching
      *      depending on the value. The only valid non-default value is 1,
      *      which enables image searching.
-     *      Example:
-     *      search_type: 1
+     *      For example, `search_type: 1`
      * @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
      *   The query expansion specification that specifies the conditions under which
      *   query expansion occurs.
@@ -844,6 +853,21 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project: string): string;
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -997,6 +1021,57 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreControlPath(project: string, location: string, collection: string, dataStore: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationCollectionDataStoreControl resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreControlName
+     *   A fully-qualified path representing project_location_collection_data_store_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
      *
@@ -1048,6 +1123,57 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} custom_tuning_model
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the custom_tuning_model.
+     */
+    matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
      *
@@ -1396,6 +1522,57 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the target_site.
      */
     matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineControlPath(project: string, location: string, collection: string, engine: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationCollectionEngineControl resource.
+     *
+     * @param {string} projectLocationCollectionEngineControlName
+     *   A fully-qualified path representing project_location_collection_engine_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
      *
@@ -1735,6 +1912,48 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreControl resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} control
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreControlPath(project: string, location: string, dataStore: string, control: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
+    /**
+     * Parse the control from ProjectLocationDataStoreControl resource.
+     *
+     * @param {string} projectLocationDataStoreControlName
+     *   A fully-qualified path representing project_location_data_store_control resource.
+     * @returns {string} A string representing the control.
+     */
+    matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreConversation resource name string.
      *
@@ -1777,6 +1996,48 @@ export declare class SearchServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} custom_tuning_model
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
+    /**
+     * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
+     *
+     * @param {string} projectLocationDataStoreCustomTuningModelName
+     *   A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
+     * @returns {string} A string representing the custom_tuning_model.
+     */
+    matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
      *