@google-cloud/discoveryengine 1.7.0 → 1.9.0

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

@@ -123,12 +123,30 @@ export declare class GroundedGenerationServiceClient {
      *   Required. The resource name of the grounding config, such as
      *   `projects/* /locations/global/groundingConfigs/default_grounding_config`.
      * @param {string} request.answerCandidate
-     *   Answer candidate to check.
+     *   Answer candidate to check. Can have a maximum length of 1024 characters.
      * @param {number[]} request.facts
      *   List of facts for the grounding check.
      *   We support up to 200 facts.
      * @param {google.cloud.discoveryengine.v1beta.CheckGroundingSpec} request.groundingSpec
      *   Configuration of the grounding check.
+     * @param {number[]} request.userLabels
+     *   The user labels applied to a resource must meet the following requirements:
+     *
+     *   * Each resource can have multiple labels, up to a maximum of 64.
+     *   * Each label must be a key-value pair.
+     *   * Keys have a minimum length of 1 character and a maximum length of 63
+     *     characters and cannot be empty. Values can be empty and have a maximum
+     *     length of 63 characters.
+     *   * Keys and values can contain only lowercase letters, numeric characters,
+     *     underscores, and dashes. All characters must use UTF-8 encoding, and
+     *     international characters are allowed.
+     *   * The key portion of a label must be unique. However, you can use the same
+     *     key with multiple resources.
+     *   * Keys must start with a lowercase letter or international character.
+     *
+     *   See [Google Cloud
+     *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+     *   for more details.
      * @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.
@@ -271,6 +289,21 @@ export declare class GroundedGenerationServiceClient {
      * @returns {string} A string representing the grounding_config.
      */
     matchGroundingConfigFromGroundingConfigName(groundingConfigName: 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.
      *
@@ -373,6 +406,57 @@ export declare class GroundedGenerationServiceClient {
      * @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.
      *
@@ -424,6 +508,57 @@ export declare class GroundedGenerationServiceClient {
      * @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.
      *
@@ -772,6 +907,57 @@ export declare class GroundedGenerationServiceClient {
      * @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.
      *
@@ -1069,6 +1255,48 @@ export declare class GroundedGenerationServiceClient {
      * @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.
      *
@@ -1111,6 +1339,48 @@ export declare class GroundedGenerationServiceClient {
      * @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.
      *