@google-cloud/discoveryengine 1.8.0 → 1.9.0

package/build/src/v1beta/rank_service_client.js

@@ -150,9 +150,12 @@ class RankServiceClient {
         // Create useful helper objects for these.
         this.pathTemplates = {
             enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
+            projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
             projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
             projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
             projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
+            projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
             projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
             projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -160,13 +163,16 @@ class RankServiceClient {
             projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
             projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
             projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
+            projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
             projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
             projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
             projectLocationCollectionEngineSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
             projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
             projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
             projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
             projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
+            projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
             projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
             projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -422,6 +428,27 @@ class RankServiceClient {
     matchEngineFromEngineName(engineName) {
         return this.pathTemplates.enginePathTemplate.match(engineName).engine;
     }
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project) {
+        return this.pathTemplates.projectPathTemplate.render({
+            project: project,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectPathTemplate.match(projectName).project;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -560,6 +587,75 @@ class RankServiceClient {
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
     }
+    /**
+     * 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, location, collection, dataStore, control) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            control: control,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).collection;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).data_store;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).control;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
      *
@@ -629,6 +725,75 @@ class RankServiceClient {
     matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
         return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
     }
+    /**
+     * 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, location, collection, dataStore, customTuningModel) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            custom_tuning_model: customTuningModel,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).collection;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).data_store;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).custom_tuning_model;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
      *
@@ -1100,6 +1265,75 @@ class RankServiceClient {
     matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
         return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
     }
+    /**
+     * 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, location, collection, engine, control) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+            control: control,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).collection;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).engine;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).control;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
      *
@@ -1502,6 +1736,63 @@ class RankServiceClient {
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
     }
+    /**
+     * 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, location, dataStore, control) {
+        return this.pathTemplates.projectLocationDataStoreControlPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            control: control,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).data_store;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).control;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreConversation resource name string.
      *
@@ -1559,6 +1850,63 @@ class RankServiceClient {
     matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
         return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
     }
+    /**
+     * 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, location, dataStore, customTuningModel) {
+        return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            custom_tuning_model: customTuningModel,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).data_store;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).custom_tuning_model;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
      *