@google-cloud/discoveryengine 0.5.0 → 0.7.0

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

@@ -269,6 +269,60 @@ message ImportDocumentsRequest {
   // be imported. Defaults to
   // [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
   ReconciliationMode reconciliation_mode = 6;
+
+  // Whether to automatically generate IDs for the documents if absent.
+  //
+  // If set to `true`,
+  // [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s are
+  // automatically generated based on the hash of the payload, where IDs may not
+  // be consistent during multiple imports. In which case
+  // [ReconciliationMode.FULL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL]
+  // is highly recommended to avoid duplicate contents. If unset or set to
+  // `false`, [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s
+  // have to be specified using
+  // [id_field][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field],
+  // otherwises, documents without IDs will fail to be imported.
+  //
+  // Only set this field when using
+  // [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
+  // [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
+  // when
+  // [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
+  // or
+  // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
+  // is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+  bool auto_generate_ids = 8;
+
+  // The field in the Cloud Storage and BigQuery sources that indicates the
+  // unique IDs of the documents.
+  //
+  // For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the
+  // key of the JSON field. For instance, `my_id` for JSON `{"my_id":
+  // "some_uuid"}`. For
+  // [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource] it is
+  // the column name of the BigQuery table where the unique ids are stored.
+  //
+  // The values of the JSON field or the BigQuery column will be used as the
+  // [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON
+  // field or the BigQuery column must be of string type, and the values must be
+  // set as valid strings conform to
+  // [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
+  // Otherwise, documents without valid IDs will fail to be imported.
+  //
+  // Only set this field when using
+  // [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
+  // [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
+  // when
+  // [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
+  // or
+  // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
+  // is `custom`. And only set this field when
+  // [auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids]
+  // is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
+  //
+  // If it is unset, a default value `_id` is used when importing from the
+  // allowed data sources.
+  string id_field = 9;
 }
 
 // Response of the

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;
+}

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

@@ -382,6 +382,11 @@ message SearchRequest {
   // If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
   string order_by = 8;
 
+  // Information about the end user.
+  // Highly recommended for analytics. The user_agent string in UserInfo will
+  // be used to deduce device_type for analytics.
+  UserInfo user_info = 21;
+
   // Facet specifications for faceted search. If empty, no facets are returned.
   //
   // A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
@@ -393,16 +398,13 @@ message SearchRequest {
 
   // Additional search parameters.
   //
-  // For
-  // [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
-  // vertical, supported values are:
+  // For public website search only, supported values are:
   //
   // * `user_country_code`: string. Default empty. If set to non-empty, results
   //    are restricted or boosted based on the location provided.
   // * `search_type`: double. Default empty. Enables non-webpage searching
   //   depending on the value. The only valid non-default value is 1,
   //   which enables image searching.
-  // This field is ignored for other verticals.
   map<string, google.protobuf.Value> params = 11;
 
   // The query expansion specification that specifies the conditions under which
@@ -432,6 +434,29 @@ message SearchRequest {
   // The content search spec that configs the desired behavior of content
   // search.
   ContentSearchSpec content_search_spec = 24;
+
+  // Whether to turn on safe search. This is only supported for
+  // [ContentConfig.PUBLIC_WEBSITE][].
+  bool safe_search = 20;
+
+  // 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 = 22;
 }
 
 // Response message for

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

@@ -114,17 +114,19 @@ message UserEvent {
   // Token to attribute an API response to user action(s) to trigger the event.
   //
   // Highly recommended for user events that are the result of
-  // [PredictionService.Predict][]. This field enables accurate attribution of
-  // recommendation model performance.
+  // [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
+  // This field enables accurate attribution of recommendation model
+  // performance.
   //
   // The value must be one of:
   //
   // * [PredictResponse.attribution_token][] for events that are the result of
-  // [PredictionService.Predict][].
+  // [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
   // * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
   // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search].
   // * [CompleteQueryResponse.attribution_token][] for events that are the
-  // result of [SearchService.CompleteQuery][].
+  // result of
+  // [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery].
   //
   // This token enables us to accurately attribute page view or conversion
   // completion back to the event and the particular predict response containing
@@ -138,14 +140,15 @@ message UserEvent {
   // predicate from one or more fields of the documents being filtered.
   //
   // One example is for `search` events, the associated
-  // [SearchService.SearchRequest][] may contain a filter expression in
-  // [SearchService.SearchRequest.filter][] conforming to
-  // https://google.aip.dev/160#filtering.
+  // [SearchRequest][google.cloud.discoveryengine.v1beta.SearchRequest] may
+  // contain a filter expression in
+  // [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
+  // conforming to https://google.aip.dev/160#filtering.
   //
   // Similarly, for `view-item-list` events that are generated from a
-  // [PredictionService.PredictRequest][], this field may be populated directly
-  // from [PredictionService.PredictRequest.filter][] conforming to
-  // https://google.aip.dev/160#filtering.
+  // [RecommendationService.RecommendRequest][], this field may be populated
+  // directly from [RecommendationService.RecommendRequest.filter][] conforming
+  // to https://google.aip.dev/160#filtering.
   //
   // The value must be a UTF-8 encoded string with a length limit of 1,000
   // characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -284,9 +287,10 @@ message SearchInfo {
   //
   // At least one of
   // [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
-  // or [page_categories][] is required for `search` events. Other event types
-  // should not set this field. Otherwise, an INVALID_ARGUMENT error is
-  // returned.
+  // or
+  // [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
+  // is required for `search` events. Other event types should not set this
+  // field. Otherwise, an INVALID_ARGUMENT error is returned.
   string search_query = 1;
 
   // The order in which products are returned, if applicable.