@google-cloud/discoveryengine 2.0.1 → 2.1.0

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

@@ -116,6 +116,11 @@ message SearchRequest {
     // specified by data_store field. For more information on filtering, see
     // [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
     string filter = 5 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Boost specification to boost certain documents.
+    // For more information on boosting, see
+    // [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+    BoostSpec boost_spec = 6 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // A facet specification to perform faceted search.
@@ -369,7 +374,7 @@ message SearchRequest {
     }
 
     // Condition boost specifications. If a document matches multiple conditions
-    // in the specifictions, boost scores from these specifications are all
+    // in the specifications, boost scores from these specifications are all
     // applied and combined in a non-linear way. Maximum number of
     // specifications is 20.
     repeated ConditionBoostSpec condition_boost_specs = 1;
@@ -656,7 +661,8 @@ message SearchRequest {
       DOCUMENTS = 1;
 
       // Returns chunks in the search result. Only available if the
-      // [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
+      // [DocumentProcessingConfig.chunking_config][google.cloud.discoveryengine.v1.DocumentProcessingConfig.chunking_config]
+      // is specified.
       CHUNKS = 2;
     }
 
@@ -697,6 +703,10 @@ message SearchRequest {
 
       // Enables Search As You Type.
       ENABLED = 2;
+
+      // Automatic switching between search-as-you-type and standard search
+      // modes, ideal for single-API implementations (e.g., debouncing).
+      AUTO = 3;
     }
 
     // The condition under which search as you type should occur.
@@ -705,6 +715,24 @@ message SearchRequest {
     Condition condition = 1;
   }
 
+  // Specifies features for display, like match highlighting.
+  message DisplaySpec {
+    // Enum describing under which condition match highlighting should occur.
+    enum MatchHighlightingCondition {
+      // Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
+      MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED = 0;
+
+      // Disables match highlighting on all documents.
+      MATCH_HIGHLIGHTING_DISABLED = 1;
+
+      // Enables match highlighting on all documents.
+      MATCH_HIGHLIGHTING_ENABLED = 2;
+    }
+
+    // The condition under which match highlighting should occur.
+    MatchHighlightingCondition match_highlighting_condition = 1;
+  }
+
   // Session specification.
   //
   // Multi-turn Search feature is currently at private GA stage. Please use
@@ -741,13 +769,41 @@ message SearchRequest {
     // The number of top search results to persist. The persisted search results
     // can be used for the subsequent /answer api call.
     //
-    // This field is simliar to the `summary_result_count` field in
+    // This field is similar to the `summary_result_count` field in
     // [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].
     //
     // At most 10 results for documents mode, or 50 for chunks mode.
     optional int32 search_result_persistence_count = 2;
   }
 
+  // The specification for returning the document relevance score.
+  message RelevanceScoreSpec {
+    // Optional. Whether to return the relevance score for search results.
+    // The higher the score, the more relevant the document is to the query.
+    bool return_relevance_score = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // The relevance threshold of the search results. The higher relevance
+  // threshold is, the higher relevant results are shown and the less number of
+  // results are returned.
+  enum RelevanceThreshold {
+    // Default value. In this case, server behavior defaults to Google defined
+    // threshold.
+    RELEVANCE_THRESHOLD_UNSPECIFIED = 0;
+
+    // Lowest relevance threshold.
+    LOWEST = 1;
+
+    // Low relevance threshold.
+    LOW = 2;
+
+    // Medium relevance threshold.
+    MEDIUM = 3;
+
+    // High relevance threshold.
+    HIGH = 4;
+  }
+
   // Required. The resource name of the Search serving config, such as
   // `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
   // or
@@ -812,10 +868,13 @@ message SearchRequest {
   // Default number is 10.
   int32 one_box_page_size = 47;
 
-  // 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.
+  // Specifications that define the specific
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
+  // along with configurations for those data stores. This is only considered
+  // for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
+  // stores. For engines with a single data store, the specs directly under
+  // [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
+  // used.
   repeated DataStoreSpec data_store_specs = 32;
 
   // The filter syntax consists of an expression language for constructing a
@@ -864,7 +923,7 @@ message SearchRequest {
   string order_by = 8;
 
   // Information about the end user.
-  // Highly recommended for analytics.
+  // Highly recommended for analytics and personalization.
   // [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
   // is used to deduce `device_type` for analytics.
   UserInfo user_info = 21;
@@ -959,6 +1018,10 @@ message SearchRequest {
   // vertical.
   SearchAsYouTypeSpec search_as_you_type_spec = 31;
 
+  // Optional. Config for display feature, like match highlighting on search
+  // results.
+  DisplaySpec display_spec = 38 [(google.api.field_behavior) = OPTIONAL];
+
   // The session resource name. Optional.
   //
   // Session allows users to do multi-turn /search API calls or coordination
@@ -993,6 +1056,19 @@ message SearchRequest {
   //
   // Can be used only when `session` is set.
   SessionSpec session_spec = 42;
+
+  // The relevance threshold of the search results.
+  //
+  // Default to Google defined threshold, leveraging a balance of
+  // precision and recall to deliver both highly accurate results and
+  // comprehensive coverage of relevant information.
+  //
+  // This feature is not supported for healthcare search.
+  RelevanceThreshold relevance_threshold = 44;
+
+  // Optional. The specification for returning the relevance score.
+  RelevanceScoreSpec relevance_score_spec = 52
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for
@@ -1014,6 +1090,10 @@ message SearchResponse {
     // is set to
     // [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
     Chunk chunk = 18;
+
+    // Output only. Google provided available scores.
+    map<string, DoubleList> model_scores = 4
+        [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // A facet result.
@@ -1194,6 +1274,11 @@ message SearchResponse {
       // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
       // is set to `true`.
       NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9;
+
+      // The time out case.
+      //
+      // Google skips the summary if the time out.
+      TIME_OUT = 10;
     }
 
     // The summary content.
@@ -1295,4 +1380,7 @@ message SearchResponse {
   // [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
   // is provided. See its description for more details.
   SessionInfo session_info = 19;
+
+  // Promotions for site search.
+  repeated SearchLinkPromotion search_link_promotions = 23;
 }

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

@@ -0,0 +1,271 @@
+// Copyright 2025 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/cloud/discoveryengine/v1/common.proto";
+import "google/cloud/discoveryengine/v1/search_service.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 = "ServingConfigProto";
+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";
+
+// Configures metadata that is used to generate serving time results (e.g.
+// search results or recommendation predictions).
+// The ServingConfig is passed in the search and predict request and generates
+// results.
+message ServingConfig {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/ServingConfig"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
+  };
+
+  // Specifies the configurations needed for Media Discovery. Currently we
+  // support:
+  //
+  // * `demote_content_watched`: Threshold for watched content demotion.
+  // Customers can specify if using watched content demotion or use viewed
+  // detail page. Using the content watched demotion, customers need to specify
+  // the watched minutes or percentage exceeds the threshold, the content will
+  // be demoted in the recommendation result.
+  // * `promote_fresh_content`: cutoff days for fresh content promotion.
+  // Customers can specify if using content freshness promotion. If the content
+  // was published within the cutoff days, the content will be promoted in the
+  // recommendation result.
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  message MediaConfig {
+    // Specify the threshold for demoting watched content, the threshold can be
+    // either percentage or minutes value.
+    // This must be set for `media-complete` event type.
+    oneof demote_content_watched {
+      // Specifies the content watched percentage threshold for demotion.
+      // Threshold value must be between [0, 1.0] inclusive.
+      float content_watched_percentage_threshold = 2;
+
+      // Specifies the content watched minutes threshold for demotion.
+      float content_watched_seconds_threshold = 5;
+    }
+
+    // Specifies the event type used for demoting recommendation result.
+    // Currently supported values:
+    //
+    // * `view-item`: Item viewed.
+    // * `media-play`: Start/resume watching a video, playing a song, etc.
+    // * `media-complete`: Finished or stopped midway through a video, song,
+    // etc.
+    //
+    // If unset, watch history demotion will not be applied. Content freshness
+    // demotion will still be applied.
+    string demotion_event_type = 1;
+
+    // Optional. Specifies the number of days to look back for demoting watched
+    // content. If set to zero or unset, defaults to the maximum of 365 days.
+    int32 demote_content_watched_past_days = 37
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Specifies the content freshness used for recommendation result.
+    // Contents will be demoted if contents were published for more than content
+    // freshness cutoff days.
+    int32 content_freshness_cutoff_days = 4;
+  }
+
+  // Specifies the configurations needed for Generic Discovery.Currently we
+  // support:
+  //
+  // * `content_search_spec`: configuration for generic content search.
+  message GenericConfig {
+    // Specifies the expected behavior of content search.
+    // Only valid for content-search enabled data store.
+    SearchRequest.ContentSearchSpec content_search_spec = 1;
+  }
+
+  // Industry vertical specific config.
+  oneof vertical_config {
+    // The MediaConfig of the serving configuration.
+    MediaConfig media_config = 7;
+
+    // The GenericConfig of the serving configuration.
+    GenericConfig generic_config = 10;
+  }
+
+  // Immutable. Fully qualified name
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Required. The human readable serving config display name. Used in Discovery
+  // UI.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 128
+  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Immutable. Specifies the solution type that a serving config can
+  // be associated with.
+  SolutionType solution_type = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // The id of the model to use at serving time.
+  // Currently only RecommendationModels are supported.
+  // Can be changed but only to a compatible model (e.g.
+  // others-you-may-like CTR to others-you-may-like CVR).
+  //
+  // Required when [SolutionType][google.cloud.discoveryengine.v1.SolutionType]
+  // is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  string model_id = 4;
+
+  // How much diversity to use in recommendation model results e.g.
+  // `medium-diversity` or `high-diversity`. Currently supported values:
+  //
+  // * `no-diversity`
+  // * `low-diversity`
+  // * `medium-diversity`
+  // * `high-diversity`
+  // * `auto-diversity`
+  //
+  // If not specified, we choose default based on recommendation model
+  // type. Default value: `no-diversity`.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  string diversity_level = 5;
+
+  // The ranking expression controls the customized ranking on retrieval
+  // documents. To leverage this, document embedding is required. The ranking
+  // expression setting in ServingConfig applies to all search requests served
+  // by the serving config. However, if `SearchRequest.ranking_expression` is
+  // specified, it overrides the ServingConfig ranking expression.
+  //
+  // The ranking expression is a single function or multiple functions that are
+  // joined by "+".
+  //
+  //   * ranking_expression = function, { " + ", function };
+  //
+  // Supported functions:
+  //
+  //   * double * relevance_score
+  //   * double * dotProduct(embedding_field_path)
+  //
+  // Function variables:
+  //
+  //   * `relevance_score`: pre-defined keywords, used for measure relevance
+  //   between query and document.
+  //   * `embedding_field_path`: the document embedding field
+  //   used with query embedding vector.
+  //   * `dotProduct`: embedding function between embedding_field_path and query
+  //   embedding vector.
+  //
+  //  Example ranking expression:
+  //
+  //    If document has an embedding field doc_embedding, the ranking expression
+  //    could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+  string ranking_expression = 21;
+
+  // Output only. ServingConfig created timestamp.
+  google.protobuf.Timestamp create_time = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. ServingConfig updated timestamp.
+  google.protobuf.Timestamp update_time = 9
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Filter controls to use in serving path.
+  // All triggered filter controls will be applied.
+  // Filter controls must be in the same data store as the serving config.
+  // Maximum of 20 filter controls.
+  repeated string filter_control_ids = 11;
+
+  // Boost controls to use in serving path.
+  // All triggered boost controls will be applied.
+  // Boost controls must be in the same data store as the serving config.
+  // Maximum of 20 boost controls.
+  repeated string boost_control_ids = 12;
+
+  // IDs of the redirect controls. Only the first triggered redirect
+  // action is applied, even if multiple apply. Maximum number of
+  // specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string redirect_control_ids = 14;
+
+  // Condition synonyms specifications. If multiple synonyms conditions
+  // match, all matching synonyms controls in the list will execute.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string synonyms_control_ids = 15;
+
+  // Condition oneway synonyms specifications. If multiple oneway synonyms
+  // conditions match, all matching oneway synonyms controls in the list
+  // will execute. Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string oneway_synonyms_control_ids = 16;
+
+  // Condition do not associate specifications. If multiple do not
+  // associate conditions match, all matching do not associate controls in
+  // the list will execute.
+  // Order does not matter.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string dissociate_control_ids = 17;
+
+  // Condition replacement specifications.
+  // Applied according to the order in the list.
+  // A previously replaced term can not be re-replaced.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string replacement_control_ids = 18;
+
+  // Condition ignore specifications. If multiple ignore
+  // conditions match, all matching ignore controls in the list will
+  // execute.
+  // Order does not matter.
+  // Maximum number of specifications is 100.
+  repeated string ignore_control_ids = 19;
+
+  // Condition promote specifications.
+  //
+  // Maximum number of specifications is 100.
+  repeated string promote_control_ids = 26;
+}

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

@@ -0,0 +1,75 @@
+// Copyright 2025 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";
+import "google/cloud/discoveryengine/v1/serving_config.proto";
+import "google/protobuf/field_mask.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 = "ServingConfigServiceProto";
+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 operations related to
+// [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig].
+service ServingConfigService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Updates a ServingConfig.
+  //
+  // Returns a NOT_FOUND error if the ServingConfig does not exist.
+  rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) {
+    option (google.api.http) = {
+      patch: "/v1/{serving_config.name=projects/*/locations/*/dataStores/*/servingConfigs/*}"
+      body: "serving_config"
+      additional_bindings {
+        patch: "/v1/{serving_config.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}"
+        body: "serving_config"
+      }
+      additional_bindings {
+        patch: "/v1/{serving_config.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}"
+        body: "serving_config"
+      }
+    };
+    option (google.api.method_signature) = "serving_config,update_mask";
+  }
+}
+
+// Request for UpdateServingConfig method.
+message UpdateServingConfigRequest {
+  // Required. The ServingConfig to update.
+  ServingConfig serving_config = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided
+  // [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to update.
+  // The following are NOT supported:
+  //
+  // * [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name]
+  //
+  // If not set, all supported fields are updated.
+  google.protobuf.FieldMask update_mask = 2;
+}

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

@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1;
 
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1/answer.proto";
 import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
@@ -51,6 +52,14 @@ message Session {
     string answer = 2 [(google.api.resource_reference) = {
       type: "discoveryengine.googleapis.com/Answer"
     }];
+
+    // Output only. In
+    // [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
+    // API, if
+    // [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details]
+    // is set to true, this field will be populated when getting answer query
+    // session.
+    Answer detailed_answer = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // Enumeration of the state of the session.
@@ -66,6 +75,12 @@ message Session {
   // `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
   string name = 1 [(google.api.field_behavior) = IMMUTABLE];
 
+  // Optional. The display name of the session.
+  //
+  // This field is used to identify the session in the UI.
+  // By default, the display name is the first turn query text in the session.
+  string display_name = 7 [(google.api.field_behavior) = OPTIONAL];
+
   // The state of the session.
   State state = 2;
 
@@ -82,6 +97,10 @@ message Session {
   // Output only. The time the session finished.
   google.protobuf.Timestamp end_time = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Whether the session is pinned, pinned session will be displayed
+  // on the top of the session list.
+  bool is_pinned = 8 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Defines a user inputed query.

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

@@ -118,13 +118,13 @@ message TargetSite {
   // excluded.
   Type type = 3;
 
-  // Input only. If set to false, a uri_pattern is generated to include all
-  // pages whose address contains the provided_uri_pattern. If set to true, an
+  // Immutable. If set to false, a uri_pattern is generated to include all pages
+  // whose address contains the provided_uri_pattern. If set to true, an
   // uri_pattern is generated to try to be an exact match of the
   // provided_uri_pattern or just the specific page if the provided_uri_pattern
   // is a specific one. provided_uri_pattern is always normalized to
   // generate the URI pattern to be used by the search engine.
-  bool exact_match = 6 [(google.api.field_behavior) = INPUT_ONLY];
+  bool exact_match = 6 [(google.api.field_behavior) = IMMUTABLE];
 
   // Output only. This is system-generated based on the provided_uri_pattern.
   string generated_uri_pattern = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -171,3 +171,27 @@ message SiteVerificationInfo {
   // Latest site verification time.
   google.protobuf.Timestamp verify_time = 2;
 }
+
+// A sitemap for the SiteSearchEngine.
+message Sitemap {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Sitemap"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}"
+  };
+
+  // Supported feed sources.
+  oneof feed {
+    // Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+    string uri = 2;
+  }
+
+  // Output only. The fully qualified resource name of the sitemap.
+  // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`
+  // The `sitemap_id` suffix is system-generated.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The sitemap's creation time.
+  google.protobuf.Timestamp create_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}