@google-cloud/discoveryengine 1.11.0 → 1.12.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.12.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.11.0...discoveryengine-v1.12.0) (2024-08-09)
+
+
+### Features
+
+* [discoveryengine] Update CompletionService ([#5574](https://github.com/googleapis/google-cloud-node/issues/5574)) ([384096f](https://github.com/googleapis/google-cloud-node/commit/384096fe3bbab56e9f708a2bc422f711cc1d8641))
+* [discoveryengine] Update SearchService ([#5578](https://github.com/googleapis/google-cloud-node/issues/5578)) ([af46d57](https://github.com/googleapis/google-cloud-node/commit/af46d5779f82d7a37c687e1364b8c653bb6369e9))
+
 ## [1.11.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.10.0...discoveryengine-v1.11.0) (2024-07-22)
 
 

package/README.md

@@ -288,7 +288,9 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.purge_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.write_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.complete_query.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Completion_service.import_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.import_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.import_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Completion_service.import_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.import_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.import_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Completion_service.purge_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.purge_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.purge_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Completion_service.purge_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.purge_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/completion_service.purge_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Control_service.create_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/control_service.create_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/control_service.create_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Control_service.delete_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/control_service.delete_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/control_service.delete_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -372,6 +374,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/site_search_engine_service.update_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.purge_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.write_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/quickstart.js,packages/google-cloud-discoveryengine/samples/README.md) |
 

package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto

@@ -188,6 +188,14 @@ message Answer {
           // If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
           // populate chunk info.
           repeated ChunkInfo chunk_info = 5;
+
+          // Data representation.
+          // The structured JSON data for the document.
+          // It's populated from the struct data from the Document
+          // , or the Chunk in
+          // search result
+          // .
+          google.protobuf.Struct struct_data = 6;
         }
 
         // Search results observed by the search action, it can be snippets info
@@ -296,6 +304,12 @@ message Answer {
     // Google skips the answer if there is a potential policy violation
     // detected. This includes content that may be violent or toxic.
     POTENTIAL_POLICY_VIOLATION = 4;
+
+    // The no relevant content case.
+    //
+    // Google skips the answer if there is no relevant content in the
+    // retrieved search results.
+    NO_RELEVANT_CONTENT = 5;
   }
 
   // Immutable. Fully qualified name

package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto

@@ -50,3 +50,34 @@ message SuggestionDenyListEntry {
   // exact phrase, or block any suggestions containing this phrase.
   MatchOperator match_operator = 2 [(google.api.field_behavior) = REQUIRED];
 }
+
+// Autocomplete suggestions that are imported from Customer.
+message CompletionSuggestion {
+  // Ranking metrics of this suggestion.
+  oneof ranking_info {
+    // Global score of this suggestion. Control how this suggestion would be
+    // scored / ranked.
+    double global_score = 2;
+
+    // Frequency of this suggestion. Will be used to rank suggestions when score
+    // is not available.
+    int64 frequency = 3;
+  }
+
+  // Required. The suggestion text.
+  string suggestion = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // BCP-47 language code of this suggestion.
+  string language_code = 4;
+
+  // If two suggestions have the same groupId, they will not be
+  // returned together. Instead the one ranked higher will be returned. This can
+  // be used to deduplicate semantically identical suggestions.
+  string group_id = 5;
+
+  // The score of this suggestion within its group.
+  double group_score = 6;
+
+  // Alternative matching phrases for this suggestion.
+  repeated string alternative_phrases = 7;
+}

package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto

@@ -86,6 +86,44 @@ service CompletionService {
       metadata_type: "google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesMetadata"
     };
   }
+
+  // Imports
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
+  // for a DataStore.
+  rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:import"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:import"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.ImportCompletionSuggestionsResponse"
+      metadata_type: "google.cloud.discoveryengine.v1beta.ImportCompletionSuggestionsMetadata"
+    };
+  }
+
+  // Permanently deletes all
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
+  // for a DataStore.
+  rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:purge"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:purge"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsResponse"
+      metadata_type: "google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsMetadata"
+    };
+  }
 }
 
 // Request message for

package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto

@@ -792,6 +792,25 @@ message AnswerQueryRequest {
   // The field must be a UTF-8 encoded string with a length limit of 128
   // characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
   string user_pseudo_id = 12;
+
+  // 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.
+  map<string, string> user_labels = 13;
 }
 
 // Response message for

package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto

@@ -56,6 +56,9 @@ message CustomTuningModel {
 
     // The model training failed.
     TRAINING_FAILED = 5;
+
+    // The model training finished successfully but metrics did not improve.
+    NO_IMPROVEMENT = 6;
   }
 
   // Required. The fully qualified resource name of the model.
@@ -80,8 +83,11 @@ message CustomTuningModel {
   ModelState model_state = 4;
 
   // Timestamp the Model was created at.
-  google.protobuf.Timestamp create_time = 5;
+  google.protobuf.Timestamp create_time = 5 [deprecated = true];
 
   // Timestamp the model training was initiated.
   google.protobuf.Timestamp training_start_time = 6;
+
+  // The metrics of the trained model.
+  map<string, double> metrics = 7;
 }

package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto

@@ -98,6 +98,9 @@ message DataStore {
   google.protobuf.Timestamp create_time = 4
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Language info for DataStore.
+  LanguageInfo language_info = 14;
+
   // Configuration for Document understanding and enrichment.
   DocumentProcessingConfig document_processing_config = 27;
 
@@ -118,3 +121,23 @@ message DataStore {
   // doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
   Schema starting_schema = 28;
 }
+
+// Language info for DataStore.
+message LanguageInfo {
+  // The language code for the DataStore.
+  string language_code = 1;
+
+  // Output only. This is the normalized form of language_code.
+  // E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb`
+  // will have normalized_language_code of `en-GB`.
+  string normalized_language_code = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Language part of normalized_language_code.
+  // E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
+  string language = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Region part of normalized_language_code, if present.
+  // E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
+  string region = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto

@@ -152,6 +152,16 @@ message CreateDataStoreRequest {
   // search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
   // be ignored.
   bool create_advanced_site_search = 4;
+
+  // A boolean flag indicating whether to skip the default schema creation for
+  // the data store. Only enable this flag if you are certain that the default
+  // schema is incompatible with your use case.
+  //
+  // If set to true, you must manually create a schema for the data store before
+  // any documents can be ingested.
+  //
+  // This flag cannot be specified if `data_store.starting_schema` is specified.
+  bool skip_default_schema_creation = 7;
 }
 
 // Request message for

package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto

@@ -327,6 +327,38 @@ message CloudSqlSource {
   bool offload = 6;
 }
 
+// AlloyDB source import data from.
+message AlloyDbSource {
+  // The project ID that the AlloyDB source is in
+  // with a length limit of 128 characters. If not specified, inherits the
+  // project ID from the parent request.
+  string project_id = 1;
+
+  // Required. The AlloyDB location to copy the data from with a length limit of
+  // 256 characters.
+  string location_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB cluster to copy the data from with a length limit of
+  // 256 characters.
+  string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB database to copy the data from with a length limit of
+  // 256 characters.
+  string database_id = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB table to copy the data from with a length limit of
+  // 256 characters.
+  string table_id = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // Intermediate Cloud Storage directory used for the import with a length
+  // limit of 2,000 characters. Can be specified if one wants to have the
+  // AlloyDB export to a specific Cloud Storage directory.
+  //
+  // Ensure that the AlloyDB service account has the necessary Cloud
+  // Storage Admin permissions to access the specified Cloud Storage directory.
+  string gcs_staging_dir = 6;
+}
+
 // Firestore source import data from.
 message FirestoreSource {
   // The project ID that the Cloud SQL source is in with a length limit of 128
@@ -500,6 +532,9 @@ message ImportDocumentsRequest {
     // Firestore input source.
     FirestoreSource firestore_source = 13;
 
+    // AlloyDB input source.
+    AlloyDbSource alloy_db_source = 14;
+
     // Cloud Bigtable input source.
     BigtableSource bigtable_source = 15;
   }
@@ -665,6 +700,79 @@ message ImportSuggestionDenyListEntriesMetadata {
   google.protobuf.Timestamp update_time = 2;
 }
 
+// Request message for
+// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions]
+// method.
+message ImportCompletionSuggestionsRequest {
+  // The inline source for CompletionSuggestions.
+  message InlineSource {
+    // Required. A list of all denylist entries to import. Max of 1000 items.
+    repeated CompletionSuggestion suggestions = 1
+        [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // The source of the autocomplete suggestions.
+  oneof source {
+    // The Inline source for suggestion entries.
+    InlineSource inline_source = 2;
+
+    // Cloud Storage location for the input content.
+    GcsSource gcs_source = 3;
+
+    // BigQuery input source.
+    BigQuerySource bigquery_source = 4;
+  }
+
+  // Required. The parent data store resource name for which to import customer
+  // autocomplete suggestions.
+  //
+  // Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // The desired location of errors incurred during the Import.
+  ImportErrorConfig error_config = 5;
+}
+
+// Response of the
+// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions]
+// method. If the long running operation is done, this message is returned by
+// the google.longrunning.Operations.response field if the operation is
+// successful.
+message ImportCompletionSuggestionsResponse {
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 1;
+
+  // The desired location of errors incurred during the Import.
+  ImportErrorConfig error_config = 2;
+}
+
+// Metadata related to the progress of the ImportCompletionSuggestions
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message ImportCompletionSuggestionsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
+  // successfully imported.
+  int64 success_count = 3;
+
+  // Count of
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
+  // that failed to be imported.
+  int64 failure_count = 4;
+}
+
 // Request message for
 // [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries]
 // method.

package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto

@@ -30,6 +30,79 @@ option objc_class_prefix = "DISCOVERYENGINE";
 option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
 option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
 
+// Request message for PurgeUserEvents method.
+message PurgeUserEventsRequest {
+  // Required. The resource name of the catalog under which the events are
+  // created. The format is
+  // `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Required. The filter string to specify the events to be deleted with a
+  // length limit of 5,000 characters. The eligible fields for filtering are:
+  //
+  // * `eventType`: Double quoted
+  // [UserEvent.event_type][google.cloud.discoveryengine.v1beta.UserEvent.event_type]
+  // string.
+  // * `eventTime`: in ISO 8601 "zulu" format.
+  // * `userPseudoId`: Double quoted string. Specifying this will delete all
+  //   events associated with a visitor.
+  // * `userId`: Double quoted string. Specifying this will delete all events
+  //   associated with a user.
+  //
+  // Examples:
+  //
+  // * Deleting all events in a time range:
+  //   `eventTime > "2012-04-23T18:25:43.511Z"
+  //   eventTime < "2012-04-23T18:30:43.511Z"`
+  // * Deleting specific eventType:
+  //   `eventType = "search"`
+  // * Deleting all events for a specific visitor:
+  //   `userPseudoId = "visitor1024"`
+  // * Deleting all events inside a DataStore:
+  //   `*`
+  //
+  // The filtering fields are assumed to have an implicit AND.
+  string filter = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // The `force` field is currently not supported. Purge user event requests
+  // will permanently delete all purgeable events. Once the development is
+  // complete:
+  // If `force` is set to false, the method will return the expected
+  // purge count without deleting any user events. This field will default to
+  // false if not included in the request.
+  bool force = 3;
+}
+
+// Response of the PurgeUserEventsRequest. If the long running operation is
+// successfully done, then this message is returned by the
+// google.longrunning.Operations.response field.
+message PurgeUserEventsResponse {
+  // The total count of events purged as a result of the operation.
+  int64 purge_count = 1;
+}
+
+// Metadata related to the progress of the PurgeUserEvents operation.
+// This will be returned by the google.longrunning.Operation.metadata field.
+message PurgeUserEventsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of entries that were deleted successfully.
+  int64 success_count = 3;
+
+  // Count of entries that encountered errors while processing.
+  int64 failure_count = 4;
+}
+
 // Request message for
 // [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
 // method.
@@ -125,3 +198,41 @@ message PurgeSuggestionDenyListEntriesMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 }
+
+// Request message for
+// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions]
+// method.
+message PurgeCompletionSuggestionsRequest {
+  // Required. The parent data store resource name for which to purge completion
+  // suggestions. Follows pattern
+  // projects/*/locations/*/collections/*/dataStores/*.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+}
+
+// Response message for
+// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions]
+// method.
+message PurgeCompletionSuggestionsResponse {
+  // Whether the completion suggestions were successfully purged.
+  bool purge_succeeded = 1;
+
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 2;
+}
+
+// Metadata related to the progress of the PurgeCompletionSuggestions
+// operation. This is returned by the google.longrunning.Operation.metadata
+// field.
+message PurgeCompletionSuggestionsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}