@google-cloud/discoveryengine 1.8.0 → 1.9.0

package/build/src/v1alpha/document_service_client.d.ts

@@ -164,8 +164,8 @@ export declare class DocumentServiceClient {
      *   create.
      * @param {string} request.documentId
      *   Required. The ID to use for the
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, which will
-     *   become the final component of the
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, which becomes
+     *   the final component of the
      *   {@link protos.google.cloud.discoveryengine.v1alpha.Document.name|Document.name}.
      *
      *   If the caller does not have permission to create the
@@ -213,13 +213,13 @@ export declare class DocumentServiceClient {
      *   {@link protos.google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing|allow_missing}
      *   is not set, a `NOT_FOUND` error is returned.
      * @param {boolean} request.allowMissing
-     *   If set to true, and the
+     *   If set to `true` and the
      *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} is not found, a
-     *   new {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} will be
+     *   new {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} is be
      *   created.
      * @param {google.protobuf.FieldMask} request.updateMask
      *   Indicates which fields in the provided imported 'document' to update. If
-     *   not set, will by default update all fields.
+     *   not set, by default updates all fields.
      * @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.
@@ -308,7 +308,7 @@ export declare class DocumentServiceClient {
     /**
      * Bulk import of multiple
      * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Request
-     * processing may be synchronous. Non-existing items will be created.
+     * processing may be synchronous. Non-existing items are created.
      *
      * Note: It is possible for a subset of the
      * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to be
@@ -523,7 +523,7 @@ export declare class DocumentServiceClient {
      *   Maximum number of
      *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
      *   unspecified, defaults to 100. The maximum allowed value is 1000. Values
-     *   above 1000 will be coerced to 1000.
+     *   above 1000 are set to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
@@ -574,7 +574,7 @@ export declare class DocumentServiceClient {
      *   Maximum number of
      *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
      *   unspecified, defaults to 100. The maximum allowed value is 1000. Values
-     *   above 1000 will be coerced to 1000.
+     *   above 1000 are set to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
@@ -620,7 +620,7 @@ export declare class DocumentServiceClient {
      *   Maximum number of
      *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
      *   unspecified, defaults to 100. The maximum allowed value is 1000. Values
-     *   above 1000 will be coerced to 1000.
+     *   above 1000 are set to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
@@ -1121,6 +1121,57 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the chunk.
      */
     matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: 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.
      *
@@ -1172,6 +1223,57 @@ export declare class DocumentServiceClient {
      * @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.
      *
@@ -1520,6 +1622,57 @@ export declare class DocumentServiceClient {
      * @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.
      *
@@ -1919,6 +2072,48 @@ export declare class DocumentServiceClient {
      * @returns {string} A string representing the chunk.
      */
     matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: 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.
      *
@@ -1961,6 +2156,48 @@ export declare class DocumentServiceClient {
      * @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.
      *