@google-cloud/discoveryengine 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.6.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.5.0...discoveryengine-v0.6.0) (2023-05-04)
+
+
+### Features
+
+* [discoveryengine] add document purge API ([#4219](https://github.com/googleapis/google-cloud-node/issues/4219)) ([454fa79](https://github.com/googleapis/google-cloud-node/commit/454fa7943ddf664bc54a67e654d7e8a39ea55fed))
+
+## [0.5.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.4.1...discoveryengine-v0.5.0) (2023-04-24)
+
+
+### Features
+
+* [discoveryengine] add search, autocomplete and schema services ([#4201](https://github.com/googleapis/google-cloud-node/issues/4201)) ([de00e1d](https://github.com/googleapis/google-cloud-node/commit/de00e1d88877dd674dfd20b78a3de4476d65eb29))
+
 ## [0.4.1](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.4.0...discoveryengine-v0.4.1) (2023-04-13)
 
 

package/README.md

@@ -125,13 +125,21 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
+| 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,samples/README.md) |
 | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.create_document.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/document_service.create_document.js,samples/README.md) |
 | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.delete_document.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/document_service.delete_document.js,samples/README.md) |
 | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.get_document.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/document_service.get_document.js,samples/README.md) |
 | Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.import_documents.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/document_service.import_documents.js,samples/README.md) |
 | Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.list_documents.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/document_service.list_documents.js,samples/README.md) |
+| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.purge_documents.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/document_service.purge_documents.js,samples/README.md) |
 | Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.update_document.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/document_service.update_document.js,samples/README.md) |
 | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/recommendation_service.recommend.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/recommendation_service.recommend.js,samples/README.md) |
+| Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.create_schema.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/schema_service.create_schema.js,samples/README.md) |
+| Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.delete_schema.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/schema_service.delete_schema.js,samples/README.md) |
+| Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.get_schema.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/schema_service.get_schema.js,samples/README.md) |
+| Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.list_schemas.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/schema_service.list_schemas.js,samples/README.md) |
+| Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.update_schema.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/schema_service.update_schema.js,samples/README.md) |
+| Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/search_service.search.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/search_service.search.js,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,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,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,samples/README.md) |

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

@@ -42,28 +42,59 @@ option (google.api.resource_definition) = {
   pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
 };
 
+// A floating point interval.
+message Interval {
+  // The lower bound of the interval. If neither of the min fields are
+  // set, then the lower bound is negative infinity.
+  //
+  // This field must be not larger than max.
+  // Otherwise, an `INVALID_ARGUMENT` error is returned.
+  oneof min {
+    // Inclusive lower bound.
+    double minimum = 1;
+
+    // Exclusive lower bound.
+    double exclusive_minimum = 2;
+  }
+
+  // The upper bound of the interval. If neither of the max fields are
+  // set, then the upper bound is positive infinity.
+  //
+  // This field must be not smaller than min.
+  // Otherwise, an `INVALID_ARGUMENT` error is returned.
+  oneof max {
+    // Inclusive upper bound.
+    double maximum = 3;
+
+    // Exclusive upper bound.
+    double exclusive_maximum = 4;
+  }
+}
+
 // A custom attribute that is not explicitly modeled in a resource, e.g.
 // [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent].
 message CustomAttribute {
   // The textual values of this custom attribute. For example, `["yellow",
   // "green"]` when the key is "color".
   //
-  // Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
+  // Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
   // returned.
   //
   // Exactly one of
-  // [text][google.cloud.discoveryengine.v1beta.CustomAttribute.text] or
-  // [numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
-  // should be set. Otherwise, an INVALID_ARGUMENT error is returned.
+  // [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
+  // or
+  // [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
+  // should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
   repeated string text = 1;
 
   // The numerical values of this custom attribute. For example, `[2.3, 15.4]`
   // when the key is "lengths_cm".
   //
   // Exactly one of
-  // [text][google.cloud.discoveryengine.v1beta.CustomAttribute.text] or
-  // [numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
-  // should be set. Otherwise, an INVALID_ARGUMENT error is returned.
+  // [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
+  // or
+  // [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
+  // should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
   repeated double numbers = 2;
 }
 
@@ -79,18 +110,20 @@ message UserInfo {
   // model quality.
   //
   // The field must be a UTF-8 encoded string with a length limit of 128
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   string user_id = 1;
 
   // User agent as included in the HTTP header. Required for getting
   // [SearchResponse.sponsored_results][].
   //
   // The field must be a UTF-8 encoded string with a length limit of 1,000
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   //
   // This should not be set when using the client side event reporting with
   // GTM or JavaScript tag in
   // [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent]
-  // or if [direct_user_request][] is set.
+  // or if
+  // [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
+  // is set.
   string user_agent = 2;
 }

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

@@ -0,0 +1,116 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "CompletionServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Service for Auto-Completion.
+service CompletionService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Completes the specified user input with keyword suggestions.
+  rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{data_store=projects/*/locations/*/dataStores/*}:completeQuery"
+      additional_bindings {
+        get: "/v1beta/{data_store=projects/*/locations/*/collections/*/dataStores/*}:completeQuery"
+      }
+    };
+  }
+}
+
+// Request message for
+// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
+// method.
+message CompleteQueryRequest {
+  // Required. The parent data store resource name for which the completion is
+  // performed, such as
+  // `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+  string data_store = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Required. The typeahead input used to fetch suggestions. Maximum length is
+  // 128 characters.
+  string query = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Selects data model of query suggestions for serving. Currently supported
+  // values:
+  //
+  // * `document` - Using suggestions generated from user-imported documents.
+  // * `search-history` - Using suggestions generated from the past history of
+  // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
+  // API calls. Do not use it when there is no traffic for Search API.
+  // * `user-event` - Using suggestions generated from user-imported search
+  // events.
+  //
+  // Default values:
+  //
+  // * `document` is the default model for regular dataStores.
+  // * `search-history` is the default model for
+  // [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
+  // dataStores.
+  string query_model = 3;
+
+  // A unique identifier for tracking visitors. For example, this could be
+  // implemented with an HTTP cookie, which should be able to uniquely identify
+  // a visitor on a single device. This unique identifier should not change if
+  // the visitor logs in or out of the website.
+  //
+  // This field should NOT have a fixed value such as `unknown_visitor`.
+  //
+  // This should be the same identifier as
+  // [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
+  // and
+  // [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].
+  //
+  // 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 = 4;
+}
+
+// Response message for
+// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
+// method.
+message CompleteQueryResponse {
+  // Suggestions as search queries.
+  message QuerySuggestion {
+    // The suggestion for the query.
+    string suggestion = 1;
+  }
+
+  // Results of the matched query suggestions. The result list is ordered and
+  // the first result is a top suggestion.
+  repeated QuerySuggestion query_suggestions = 1;
+}

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

@@ -38,17 +38,49 @@ message Document {
     pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}"
   };
 
+  // Unstructured data linked to this document.
+  message Content {
+    oneof content {
+      // The content represented as a stream of bytes. The maximum length is
+      // 1,000,000 bytes (1 MB / ~0.95 MiB).
+      //
+      // Note: As with all `bytes` fields, this field is represented as pure
+      // binary in Protocol Buffers and base64-encoded string in JSON. For
+      // example, `abc123!?$*&()'-=@~` should be represented as
+      // `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
+      // https://developers.google.com/protocol-buffers/docs/proto3#json.
+      bytes raw_bytes = 2;
+
+      // The URI of the content. Only Cloud Storage URIs (e.g.
+      // `gs://bucket-name/path/to/file`) are supported. The maximum file size
+      // is 100 MB.
+      string uri = 3;
+    }
+
+    // The MIME type of the content. Supported types:
+    //
+    // * `application/pdf` (PDF)
+    // * `text/html` (HTML)
+    //
+    // See https://www.iana.org/assignments/media-types/media-types.xhtml.
+    string mime_type = 1;
+  }
+
   // Data representation. One of
   // [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
   // [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
-  // be provided otherwise an INVALID_ARGUMENT error is thrown.
+  // be provided otherwise an `INVALID_ARGUMENT` error is thrown.
   oneof data {
     // The structured JSON data for the document. It should conform to the
-    // registered [schema][] or an INVALID_ARGUMENT error is thrown.
+    // registered
+    // [Schema.schema][google.cloud.discoveryengine.v1beta.Schema.schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
     google.protobuf.Struct struct_data = 4;
 
     // The JSON string representation of the document. It should conform to the
-    // registered [schema][] or an INVALID_ARGUMENT error is thrown.
+    // registered
+    // [Schema.schema][google.cloud.discoveryengine.v1beta.Schema.schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
     string json_data = 5;
   }
 
@@ -69,10 +101,20 @@ message Document {
   // The identifier of the schema located in the same data store.
   string schema_id = 3;
 
+  // The unstructured data linked to this document. Content must be set if this
+  // document is under a
+  // `CONTENT_REQUIRED` data store.
+  Content content = 10;
+
   // The identifier of the parent document. Currently supports at most two level
   // document hierarchy.
   //
   // Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
   // standard with a length limit of 63 characters.
   string parent_document_id = 7;
+
+  // Output only. This field is OUTPUT_ONLY.
+  // It contains derived data that are not in the original input document.
+  google.protobuf.Struct derived_struct_data = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }

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

@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/discoveryengine/v1beta/document.proto";
 import "google/cloud/discoveryengine/v1beta/import_config.proto";
+import "google/cloud/discoveryengine/v1beta/purge_config.proto";
 import "google/longrunning/operations.proto";
 import "google/protobuf/empty.proto";
 
@@ -122,6 +123,39 @@ service DocumentService {
       metadata_type: "google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata"
     };
   }
+
+  // Permanently deletes all selected
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
+  //
+  // This process is asynchronous. Depending on the number of
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
+  // this operation can take hours to complete. Before the delete operation
+  // completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
+  // might still be returned by
+  // [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
+  // or
+  // [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
+  //
+  // To get a list of the
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
+  // set
+  // [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
+  // to false.
+  rpc PurgeDocuments(PurgeDocumentsRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse"
+      metadata_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata"
+    };
+  }
 }
 
 // Request message for
@@ -134,10 +168,10 @@ message GetDocumentRequest {
   //
   // If the caller does not have permission to access the
   // [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
-  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  // whether or not it exists, a `PERMISSION_DENIED` error is returned.
   //
   // If the requested [Document][google.cloud.discoveryengine.v1beta.Document]
-  // does not exist, a NOT_FOUND error is returned.
+  // does not exist, a `NOT_FOUND` error is returned.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -157,7 +191,7 @@ message ListDocumentsRequest {
   //
   // If the caller does not have permission to list [Documents][]s under this
   // branch, regardless of whether or not this branch exists, a
-  // PERMISSION_DENIED error is returned.
+  // `PERMISSION_DENIED` error is returned.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -169,7 +203,7 @@ message ListDocumentsRequest {
   // to return. If unspecified, defaults to 100. The maximum allowed value is
   // 1000. Values above 1000 will be coerced to 1000.
   //
-  // If this field is negative, an INVALID_ARGUMENT error is returned.
+  // If this field is negative, an `INVALID_ARGUMENT` error is returned.
   int32 page_size = 2;
 
   // A page token
@@ -181,7 +215,7 @@ message ListDocumentsRequest {
   // When paginating, all other parameters provided to
   // [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
   // must match the call that provided the page token. Otherwise, an
-  // INVALID_ARGUMENT error is returned.
+  // `INVALID_ARGUMENT` error is returned.
   string page_token = 3;
 }
 
@@ -223,16 +257,16 @@ message CreateDocumentRequest {
   //
   // If the caller does not have permission to create the
   // [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
-  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  // whether or not it exists, a `PERMISSION_DENIED` error is returned.
   //
   // This field must be unique among all
   // [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
   // [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
-  // Otherwise, an ALREADY_EXISTS error is returned.
+  // Otherwise, an `ALREADY_EXISTS` error is returned.
   //
   // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
   // standard with a length limit of 63 characters. Otherwise, an
-  // INVALID_ARGUMENT error is returned.
+  // `INVALID_ARGUMENT` error is returned.
   string document_id = 3 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -244,12 +278,12 @@ message UpdateDocumentRequest {
   //
   // If the caller does not have permission to update the
   // [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
-  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  // whether or not it exists, a `PERMISSION_DENIED` error is returned.
   //
   // If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
   // does not exist and
   // [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
-  // is not set, a NOT_FOUND error is returned.
+  // is not set, a `NOT_FOUND` error is returned.
   Document document = 1 [(google.api.field_behavior) = REQUIRED];
 
   // If set to true, and the
@@ -269,10 +303,10 @@ message DeleteDocumentRequest {
   //
   // If the caller does not have permission to delete the
   // [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
-  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  // whether or not it exists, a `PERMISSION_DENIED` error is returned.
   //
   // If the [Document][google.cloud.discoveryengine.v1beta.Document] to delete
-  // does not exist, a NOT_FOUND error is returned.
+  // does not exist, a `NOT_FOUND` error is returned.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {

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

@@ -38,8 +38,11 @@ message GcsSource {
   // Required. Cloud Storage URIs to input files. URI can be up to
   // 2000 characters long. URIs can match the full object path (for example,
   // `gs://bucket/directory/object.json`) or a pattern matching one or more
-  // files, such as `gs://bucket/directory/*.json`. A request can
-  // contain at most 100 files, and each file can be up to 2 GB.
+  // files, such as `gs://bucket/directory/*.json`.
+  //
+  // A request can contain at most 100 files (or 100,000 files if `data_schema`
+  // is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
+  // `content`).
   repeated string input_uris = 1 [(google.api.field_behavior) = REQUIRED];
 
   // The schema to use when parsing the data from the source.
@@ -51,6 +54,12 @@ message GcsSource {
   // document must
   //   have a valid
   //   [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
+  // * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
+  //   `input_uris` will become a document, with the ID set to the first 128
+  //   bits of SHA256(URI) encoded as a hex string.
+  // * `custom`: One custom data JSON per row in arbitrary format that conforms
+  //   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+  //   data store. This can only be used by the GENERIC Data Store vertical.
   //
   // Supported values for user even imports:
   //
@@ -88,14 +97,23 @@ message BigQuerySource {
 
   // The schema to use when parsing the data from the source.
   //
-  // Supported values for imports:
+  // Supported values for user event imports:
   //
-  // * `user_event` (default): One JSON
-  // [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
+  // * `user_event` (default): One
+  // [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per row.
   //
-  // * `document` (default): One JSON
-  // [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
-  // document must have a valid [document.id][].
+  // Supported values for document imports:
+  //
+  // * `document` (default): One
+  // [Document][google.cloud.discoveryengine.v1beta.Document] format per
+  //   row. Each document must have a valid
+  //   [Document.id][google.cloud.discoveryengine.v1beta.Document.id] and one of
+  //   [Document.json_data][google.cloud.discoveryengine.v1beta.Document.json_data]
+  //   or
+  //   [Document.struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data].
+  // * `custom`: One custom data per row in arbitrary format that conforms the
+  //   defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the data
+  //   store. This can only be used by the GENERIC Data Store vertical.
   string data_schema = 6;
 }
 

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

@@ -0,0 +1,86 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "PurgeConfigProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Request message for
+// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+// method.
+message PurgeDocumentsRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Branch"
+    }
+  ];
+
+  // Required. Filter matching documents to purge. Only currently supported
+  // value is
+  // `*` (all items).
+  string filter = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Actually performs the purge. If `force` is set to false, return the
+  // expected purge count without deleting any documents.
+  bool force = 3;
+}
+
+// Response message for
+// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+// method. If the long running operation is successfully done, then this message
+// is returned by the google.longrunning.Operations.response field.
+message PurgeDocumentsResponse {
+  // The total count of documents purged as a result of the operation.
+  int64 purge_count = 1;
+
+  // A sample of document names that will be deleted. Only populated if `force`
+  // is set to false. A max of 100 names will be returned and the names are
+  // chosen at random.
+  repeated string purge_sample = 2 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/Document"
+  }];
+}
+
+// Metadata related to the progress of the PurgeDocuments operation.
+// This will be returned by the google.longrunning.Operation.metadata field.
+message PurgeDocumentsMetadata {
+  // 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;
+}