@google-cloud/discoveryengine 1.8.0 → 1.9.0

package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto

@@ -0,0 +1,131 @@
+// Copyright 2024 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.v1;
+
+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.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "RankServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// Service for ranking text records.
+service RankService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Ranks a list of text records based on the given input query.
+  rpc Rank(RankRequest) returns (RankResponse) {
+    option (google.api.http) = {
+      post: "/v1/{ranking_config=projects/*/locations/*/rankingConfigs/*}:rank"
+      body: "*"
+    };
+  }
+}
+
+// Record message for
+// [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.
+message RankingRecord {
+  // The unique ID to represent the record.
+  string id = 1;
+
+  // The title of the record. Empty by default.
+  // At least one of
+  // [title][google.cloud.discoveryengine.v1.RankingRecord.title] or
+  // [content][google.cloud.discoveryengine.v1.RankingRecord.content] should be
+  // set otherwise an INVALID_ARGUMENT error is thrown.
+  string title = 2;
+
+  // The content of the record. Empty by default.
+  // At least one of
+  // [title][google.cloud.discoveryengine.v1.RankingRecord.title] or
+  // [content][google.cloud.discoveryengine.v1.RankingRecord.content] should be
+  // set otherwise an INVALID_ARGUMENT error is thrown.
+  string content = 3;
+
+  // The score of this record based on the given query and selected model.
+  float score = 4;
+}
+
+// Request message for
+// [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.
+message RankRequest {
+  // Required. The resource name of the rank service config, such as
+  // `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+  string ranking_config = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/RankingConfig"
+    }
+  ];
+
+  // The identifier of the model to use. It is one of:
+  //
+  // * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+  // token size 512.
+  //
+  // It is set to `semantic-ranker-512@latest` by default if unspecified.
+  string model = 2;
+
+  // The number of results to return. If this is unset or no bigger than zero,
+  // returns all results.
+  int32 top_n = 3;
+
+  // The query to use.
+  string query = 4;
+
+  // Required. A list of records to rank. At most 200 records to rank.
+  repeated RankingRecord records = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // If true, the response will contain only record ID and score. By default, it
+  // is false, the response will contain record details.
+  bool ignore_record_details_in_response = 6;
+
+  // 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 = 7;
+}
+
+// Response message for
+// [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] method.
+message RankResponse {
+  // A list of records sorted by descending score.
+  repeated RankingRecord records = 5;
+}

package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto

@@ -63,7 +63,7 @@ message RecommendRequest {
   // `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
   //
   // One default serving config is created along with your recommendation engine
-  // creation. The engine ID will be used as the ID of the default serving
+  // creation. The engine ID is used as the ID of the default serving
   // config. For example, for Engine
   // `projects/*/locations/global/collections/*/engines/my-engine`, you can use
   // `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
@@ -96,9 +96,9 @@ message RecommendRequest {
   UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Maximum number of results to return. Set this property
-  // to the number of recommendation results needed. If zero, the service will
-  // choose a reasonable default. The maximum allowed value is 100. Values
-  // above 100 will be coerced to 100.
+  // to the number of recommendation results needed. If zero, the service
+  // chooses a reasonable default. The maximum allowed value is 100. Values
+  // above 100 are set to 100.
   int32 page_size = 3;
 
   // Filter for restricting recommendation results with a length limit of 5,000
@@ -119,19 +119,19 @@ message RecommendRequest {
   //  * (available: true) AND
   //    (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
   //
-  // If your filter blocks all results, the API will return generic
+  // If your filter blocks all results, the API returns generic
   // (unfiltered) popular Documents. If you only want results strictly matching
-  // the filters, set `strictFiltering` to True in
+  // the filters, set `strictFiltering` to `true` in
   // [RecommendRequest.params][google.cloud.discoveryengine.v1.RecommendRequest.params]
   // to receive empty results instead.
   //
-  // Note that the API will never return
+  // Note that the API never returns
   // [Document][google.cloud.discoveryengine.v1.Document]s with `storageStatus`
-  // of `EXPIRED` or `DELETED` regardless of filter choices.
+  // as `EXPIRED` or `DELETED` regardless of filter choices.
   string filter = 4;
 
-  // Use validate only mode for this recommendation query. If set to true, a
-  // fake model will be used that returns arbitrary Document IDs.
+  // Use validate only mode for this recommendation query. If set to `true`, a
+  // fake model is used that returns arbitrary Document IDs.
   // Note that the validate only mode should only be used for testing the API,
   // or if the model is not ready.
   bool validate_only = 5;
@@ -140,16 +140,17 @@ message RecommendRequest {
   //
   // Allowed values:
   //
-  // * `returnDocument`: Boolean. If set to true, the associated Document
-  //    object will be returned in
+  // * `returnDocument`: Boolean. If set to `true`, the associated Document
+  //    object is returned in
   //    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.document].
-  // * `returnScore`: Boolean. If set to true, the recommendation 'score'
-  //    corresponding to each returned Document will be set in
+  // * `returnScore`: Boolean. If set to true, the recommendation score
+  //    corresponding to each returned Document is set in
   //    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.metadata].
-  //    The given 'score' indicates the probability of a Document conversion
-  //    given the user's context and history.
-  // * `strictFiltering`: Boolean. True by default. If set to false, the service
-  //    will return generic (unfiltered) popular Documents instead of empty if
+  //    The given score indicates the probability of a Document conversion given
+  //    the user's context and history.
+  // * `strictFiltering`: Boolean. True by default. If set to `false`, the
+  // service
+  //    returns generic (unfiltered) popular Documents instead of empty if
   //    your filter blocks all recommendation results.
   // * `diversityLevel`: String. Default empty. If set to be non-empty, then
   //    it needs to be one of:
@@ -197,7 +198,7 @@ message RecommendResponse {
     // [RecommendRequest.params][google.cloud.discoveryengine.v1.RecommendRequest.params].
     Document document = 2;
 
-    // Additional Document metadata / annotations.
+    // Additional Document metadata or annotations.
     //
     // Possible values:
     //

package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto

@@ -142,9 +142,9 @@ message ListSchemasRequest {
   // return. The service may return fewer than this value.
   //
   // If unspecified, at most 100
-  // [Schema][google.cloud.discoveryengine.v1.Schema]s will be returned.
+  // [Schema][google.cloud.discoveryengine.v1.Schema]s are returned.
   //
-  // The maximum value is 1000; values above 1000 will be coerced to 1000.
+  // The maximum value is 1000; values above 1000 are set to 1000.
   int32 page_size = 2;
 
   // A page token, received from a previous
@@ -188,8 +188,8 @@ message CreateSchemaRequest {
   Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The ID to use for the
-  // [Schema][google.cloud.discoveryengine.v1.Schema], which will become the
-  // final component of the
+  // [Schema][google.cloud.discoveryengine.v1.Schema], which becomes the final
+  // component of the
   // [Schema.name][google.cloud.discoveryengine.v1.Schema.name].
   //
   // This field should conform to
@@ -206,7 +206,7 @@ message UpdateSchemaRequest {
   Schema schema = 1 [(google.api.field_behavior) = REQUIRED];
 
   // If set to true, and the [Schema][google.cloud.discoveryengine.v1.Schema] is
-  // not found, a new [Schema][google.cloud.discoveryengine.v1.Schema] will be
+  // not found, a new [Schema][google.cloud.discoveryengine.v1.Schema] is
   // created. In this situation, `update_mask` is ignored.
   bool allow_missing = 3;
 }

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

@@ -69,7 +69,9 @@ message SearchRequest {
     }
   }
 
-  // A struct to define data stores to filter on in a search call.
+  // A struct to define data stores to filter on in a search call and
+  // configurations for those data stores. A maximum of 1 DataStoreSpec per
+  // data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
   message DataStoreSpec {
     // Required. Full resource name of
     // [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
@@ -111,7 +113,7 @@ message SearchRequest {
       // Only supported on textual fields. Maximum is 10.
       repeated string prefixes = 4;
 
-      // Only get facet values that contains the given strings. For example,
+      // Only get facet values that contain the given strings. For example,
       // suppose "category" has three values "Action > 2022",
       // "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
       // "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
@@ -145,7 +147,7 @@ message SearchRequest {
     // Required. The facet key specification.
     FacetKey facet_key = 1 [(google.api.field_behavior) = REQUIRED];
 
-    // Maximum of facet values that should be returned for this facet. If
+    // Maximum facet values that are returned for this facet. If
     // unspecified, defaults to 20. The maximum allowed value is 300. Values
     // above 300 are coerced to 300.
     //
@@ -296,10 +298,10 @@ message SearchRequest {
       // [Mode.AUTO][google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
       MODE_UNSPECIFIED = 0;
 
-      // Search API will try to find a spell suggestion if there
-      // is any and put in the
+      // Search API tries to find a spelling suggestion. If a suggestion is
+      // found, it is put in the
       // [SearchResponse.corrected_query][google.cloud.discoveryengine.v1.SearchResponse.corrected_query].
-      // The spell suggestion will not be used as the search query.
+      // The spelling suggestion won't be used as the search query.
       SUGGESTION_ONLY = 1;
 
       // Automatic spell correction built by the Search API. Search will
@@ -307,8 +309,8 @@ message SearchRequest {
       AUTO = 2;
     }
 
-    // The mode under which spell correction should take effect to
-    // replace the original search query. Default to
+    // The mode under which spell correction
+    // replaces the original search query. Defaults to
     // [Mode.AUTO][google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
     Mode mode = 1;
   }
@@ -561,7 +563,10 @@ message SearchRequest {
   // If this field is negative, an  `INVALID_ARGUMENT`  is returned.
   int32 offset = 6;
 
-  // A list of data store specs to apply on a search call.
+  // Specs defining dataStores to filter on in a search call and configurations
+  // for those dataStores. This is only considered for engines with multiple
+  // dataStores use case. For single dataStore within an engine, they should
+  // use the specs at the top level.
   repeated DataStoreSpec data_store_specs = 32;
 
   // The filter syntax consists of an expression language for constructing a
@@ -598,7 +603,9 @@ message SearchRequest {
   // The order in which documents are returned. Documents can be ordered by
   // a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
   // Leave it unset if ordered by relevance. `order_by` expression is
-  // case-sensitive. For more information on ordering, see
+  // case-sensitive.
+  //
+  // For more information on ordering for retail search, see
   // [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
   //
   // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -618,7 +625,7 @@ message SearchRequest {
 
   // Boost specification to boost certain documents.
   // For more information on boosting, see
-  // [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+  // [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
   BoostSpec boost_spec = 10;
 
   // Additional search parameters.
@@ -627,8 +634,7 @@ message SearchRequest {
   //
   // * `user_country_code`: string. Default empty. If set to non-empty, results
   //    are restricted or boosted based on the location provided.
-  //    Example:
-  //    user_country_code: "au"
+  //    For example, `user_country_code: "au"`
   //
   //    For available codes see [Country
   //    Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -636,8 +642,7 @@ message SearchRequest {
   // * `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.
-  //    Example:
-  //    search_type: 1
+  //    For example, `search_type: 1`
   map<string, google.protobuf.Value> params = 11;
 
   // The query expansion specification that specifies the conditions under which
@@ -702,7 +707,7 @@ message SearchResponse {
     string id = 1;
 
     // The document data snippet in the search response. Only fields that are
-    // marked as retrievable are populated.
+    // marked as `retrievable` are populated.
     Document document = 2;
   }
 
@@ -725,7 +730,7 @@ message SearchResponse {
       int64 count = 3;
     }
 
-    // The key for this facet. E.g., "colors" or "price". It matches
+    // The key for this facet. For example, `"colors"` or `"price"`. It matches
     // [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key].
     string key = 1;
 
@@ -736,7 +741,7 @@ message SearchResponse {
     bool dynamic_facet = 3;
   }
 
-  // Summary of the top N search result specified by the summary spec.
+  // Summary of the top N search results specified by the summary spec.
   message Summary {
     // Safety Attribute categories and their associated confidence scores.
     message SafetyAttributes {

package/build/protos/google/cloud/discoveryengine/v1/session.proto

@@ -0,0 +1,97 @@
+// Copyright 2024 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.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "SessionProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// External session proto definition.
+message Session {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Session"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}"
+  };
+
+  // Represents a turn, including a query from the user and a
+  // answer from service.
+  message Turn {
+    // The user query.
+    Query query = 1;
+
+    // The resource name of the answer to the user query.
+    //
+    // Only set if the answer generation (/answer API call) happened in this
+    // turn.
+    string answer = 2 [(google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Answer"
+    }];
+  }
+
+  // Enumeration of the state of the session.
+  enum State {
+    // State is unspecified.
+    STATE_UNSPECIFIED = 0;
+
+    // The session is currently open.
+    IN_PROGRESS = 1;
+  }
+
+  // Immutable. Fully qualified name
+  // `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+  // The state of the session.
+  State state = 2;
+
+  // A unique identifier for tracking users.
+  string user_pseudo_id = 3;
+
+  // Turns.
+  repeated Turn turns = 4;
+
+  // Output only. The time the session started.
+  google.protobuf.Timestamp start_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time the session finished.
+  google.protobuf.Timestamp end_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Defines a user inputed query.
+message Query {
+  // Query content.
+  oneof content {
+    // Plain text.
+    string text = 2;
+  }
+
+  // Unique Id for the query.
+  string query_id = 1;
+}

package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto

@@ -129,6 +129,9 @@ message TargetSite {
   // Output only. This is system-generated based on the provided_uri_pattern.
   string generated_uri_pattern = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Output only. Root domain of the provided_uri_pattern.
+  string root_domain_uri = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. Site ownership and validity verification status.
   SiteVerificationInfo site_verification_info = 7
       [(google.api.field_behavior) = OUTPUT_ONLY];

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

@@ -32,7 +32,7 @@ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
 option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
 
 // UserEvent captures all metadata information Discovery Engine API needs to
-// know about how end users interact with customers' website.
+// know about how end users interact with your website.
 message UserEvent {
   // Required. User event type. Allowed values are:
   //
@@ -74,6 +74,31 @@ message UserEvent {
   // for this field.
   string user_pseudo_id = 2 [(google.api.field_behavior) = REQUIRED];
 
+  // The [Engine][google.cloud.discoveryengine.v1.Engine] resource name, in the
+  // form of
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+  //
+  // Optional. Only required for
+  // [Engine][google.cloud.discoveryengine.v1.Engine] produced user events. For
+  // example, user events from blended search.
+  string engine = 19 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/Engine"
+  }];
+
+  // The [DataStore][google.cloud.discoveryengine.v1.DataStore] resource full
+  // name, of the form
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+  //
+  // Optional. Only required for user events whose data store can't by
+  // determined by
+  // [UserEvent.engine][google.cloud.discoveryengine.v1.UserEvent.engine] or
+  // [UserEvent.documents][google.cloud.discoveryengine.v1.UserEvent.documents].
+  // If data store is set in the parent of write/import/collect user event
+  // requests, this field can be omitted.
+  string data_store = 20 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/DataStore"
+  }];
+
   // Only required for
   // [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
   // method. Timestamp of when the user event happened.
@@ -196,7 +221,7 @@ message UserEvent {
 
   // A list of identifiers for the independent experiment groups this user event
   // belongs to. This is used to distinguish between user events associated with
-  // different experiment setups on the customer end.
+  // different experiment setups.
   repeated string tag_ids = 15;
 
   // The promotion IDs if this is an event associated with promotions.
@@ -416,7 +441,7 @@ message DocumentInfo {
 
   // Quantity of the Document associated with the user event. Defaults to 1.
   //
-  // For example, this field will be 2 if two quantities of the same Document
+  // For example, this field is 2 if two quantities of the same Document
   // are involved in a `add-to-cart` event.
   //
   // Required for events of the following event types:

package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto

@@ -49,6 +49,10 @@ service UserEventService {
         post: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write"
         body: "user_event"
       }
+      additional_bindings {
+        post: "/v1/{parent=projects/*/locations/*}/userEvents:write"
+        body: "user_event"
+      }
     };
   }
 
@@ -66,7 +70,7 @@ service UserEventService {
     };
   }
 
-  // Bulk import of User events. Request processing might be
+  // Bulk import of user events. Request processing might be
   // synchronous. Events that already exist are skipped.
   // Use this method for backfilling historical user events.
   //
@@ -92,8 +96,16 @@ service UserEventService {
 
 // Request message for WriteUserEvent method.
 message WriteUserEventRequest {
-  // Required. The parent DataStore resource name, such as
+  // Required. The parent resource name.
+  // If the write user event action is applied in
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
+  // is:
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+  // If the write user event action is applied in [Location][] level, for
+  // example, the event with
+  // [Document][google.cloud.discoveryengine.v1.Document] across multiple
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
+  // `projects/{project}/locations/{location}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -103,6 +115,10 @@ message WriteUserEventRequest {
 
   // Required. User event to write.
   optional UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // If set to true, the user event is written asynchronously after
+  // validation, and the API responds without waiting for the write.
+  bool write_async = 3;
 }
 
 // Request message for CollectUserEvent method.

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

@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1alpha;
 
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
@@ -83,6 +84,10 @@ message Answer {
 
       // List of cited chunk contents derived from document content.
       repeated ChunkContent chunk_contents = 4;
+
+      // The structured JSON metadata for the document.
+      // It is populated from the struct data from the Chunk in search result.
+      google.protobuf.Struct struct_data = 5;
     }
 
     // Chunk information.
@@ -102,6 +107,10 @@ message Answer {
 
         // Page identifier.
         string page_identifier = 4;
+
+        // The structured JSON metadata for the document.
+        // It is populated from the struct data from the Chunk in search result.
+        google.protobuf.Struct struct_data = 5;
       }
 
       // Chunk resource name.

package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto

@@ -96,6 +96,13 @@ message Chunk {
   // Content is a string from a document (parsed content).
   string content = 3;
 
+  // The relevance score based on similarity.
+  // Higher score indicates higher chunk relevance.
+  // The score is in range [-1.0, 1.0].
+  // Only populated on [SearchService.SearchResponse][].
+  optional double relevance_score = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Metadata of the document from the current chunk.
   DocumentMetadata document_metadata = 5;
 

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

@@ -89,6 +89,22 @@ enum SolutionType {
   SOLUTION_TYPE_GENERATIVE_CHAT = 4;
 }
 
+// Defines a further subdivision of `SolutionType`.
+// Specifically applies to
+// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
+enum SearchUseCase {
+  // Value used when unset. Will not occur in CSS.
+  SEARCH_USE_CASE_UNSPECIFIED = 0;
+
+  // Search use case. Expects the traffic has a non-empty
+  // [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query].
+  SEARCH_USE_CASE_SEARCH = 1;
+
+  // Browse use case. Expects the traffic has an empty
+  // [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query].
+  SEARCH_USE_CASE_BROWSE = 2;
+}
+
 // Tiers of search features. Different tiers might have different
 // pricing. To learn more, check the pricing documentation.
 enum SearchTier {