google-cloud-discovery_engine-v1 2.0.0 → 2.1.0

data/proto_docs/google/cloud/discoveryengine/v1/serving_config.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module 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.
+        # @!attribute [rw] media_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ServingConfig::MediaConfig]
+        #     The MediaConfig of the serving configuration.
+        #
+        #     Note: The following fields are mutually exclusive: `media_config`, `generic_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] generic_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ServingConfig::GenericConfig]
+        #     The GenericConfig of the serving configuration.
+        #
+        #     Note: The following fields are mutually exclusive: `generic_config`, `media_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] solution_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
+        #     Required. Immutable. Specifies the solution type that a serving config can
+        #     be associated with.
+        # @!attribute [rw] model_id
+        #   @return [::String]
+        #     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 {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType}
+        #     is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+        # @!attribute [rw] diversity_level
+        #   @return [::String]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+        # @!attribute [rw] ranking_expression
+        #   @return [::String]
+        #     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)`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. ServingConfig created timestamp.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. ServingConfig updated timestamp.
+        # @!attribute [rw] filter_control_ids
+        #   @return [::Array<::String>]
+        #     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.
+        # @!attribute [rw] boost_control_ids
+        #   @return [::Array<::String>]
+        #     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.
+        # @!attribute [rw] redirect_control_ids
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] synonyms_control_ids
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] oneway_synonyms_control_ids
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] dissociate_control_ids
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] replacement_control_ids
+        #   @return [::Array<::String>]
+        #     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
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] ignore_control_ids
+        #   @return [::Array<::String>]
+        #     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.
+        # @!attribute [rw] promote_control_ids
+        #   @return [::Array<::String>]
+        #     Condition promote specifications.
+        #
+        #     Maximum number of specifications is 100.
+        class ServingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # 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
+          # {::Google::Cloud::DiscoveryEngine::V1::SolutionType SolutionType} is
+          # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+          # @!attribute [rw] content_watched_percentage_threshold
+          #   @return [::Float]
+          #     Specifies the content watched percentage threshold for demotion.
+          #     Threshold value must be between [0, 1.0] inclusive.
+          #
+          #     Note: The following fields are mutually exclusive: `content_watched_percentage_threshold`, `content_watched_seconds_threshold`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] content_watched_seconds_threshold
+          #   @return [::Float]
+          #     Specifies the content watched minutes threshold for demotion.
+          #
+          #     Note: The following fields are mutually exclusive: `content_watched_seconds_threshold`, `content_watched_percentage_threshold`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] demotion_event_type
+          #   @return [::String]
+          #     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.
+          # @!attribute [rw] demote_content_watched_past_days
+          #   @return [::Integer]
+          #     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.
+          # @!attribute [rw] content_freshness_cutoff_days
+          #   @return [::Integer]
+          #     Specifies the content freshness used for recommendation result.
+          #     Contents will be demoted if contents were published for more than content
+          #     freshness cutoff days.
+          class MediaConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Specifies the configurations needed for Generic Discovery.Currently we
+          # support:
+          #
+          # * `content_search_spec`: configuration for generic content search.
+          # @!attribute [rw] content_search_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec]
+          #     Specifies the expected behavior of content search.
+          #     Only valid for content-search enabled data store.
+          class GenericConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/serving_config_service.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Request for UpdateServingConfig method.
+        # @!attribute [rw] serving_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ServingConfig]
+        #     Required. The ServingConfig to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1::ServingConfig ServingConfig} to update.
+        #     The following are NOT supported:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1::ServingConfig#name ServingConfig.name}
+        #
+        #     If not set, all supported fields are updated.
+        class UpdateServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/session.rb

@@ -26,6 +26,12 @@ module Google
         #   @return [::String]
         #     Immutable. Fully qualified name
         #     `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     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.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Session::State]
         #     The state of the session.
@@ -41,6 +47,10 @@ module Google
         # @!attribute [r] end_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time the session finished.
+        # @!attribute [rw] is_pinned
+        #   @return [::Boolean]
+        #     Optional. Whether the session is pinned, pinned session will be displayed
+        #     on the top of the session list.
         class Session
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -56,6 +66,14 @@ module Google
           #
           #     Only set if the answer generation (/answer API call) happened in this
           #     turn.
+          # @!attribute [r] detailed_answer
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
+          #     Output only. In
+          #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
+          #     API, if
+          #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
+          #     is set to true, this field will be populated when getting answer query
+          #     session.
           class Turn
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb

@@ -48,8 +48,8 @@ module Google
         #     excluded.
         # @!attribute [rw] exact_match
         #   @return [::Boolean]
-        #     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
@@ -157,6 +157,23 @@ module Google
             EXEMPTED = 3
           end
         end
+
+        # A sitemap for the SiteSearchEngine.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The fully qualified resource name of the sitemap.
+        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`
+        #     The `sitemap_id` suffix is system-generated.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The sitemap's creation time.
+        class Sitemap
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb

@@ -256,6 +256,134 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
+        #     as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @!attribute [rw] sitemap
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Sitemap]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap} to create.
+        class CreateSitemapRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}, regardless of whether
+        #     or not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the requested {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap} does
+        #     not exist, a NOT_FOUND error is returned.
+        class DeleteSitemapRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
+        #     as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @!attribute [rw] matcher
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::FetchSitemapsRequest::Matcher]
+        #     Optional. If specified, fetches the matching
+        #     {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}s. If not specified,
+        #     fetches all {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}s in the
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}.
+        class FetchSitemapsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}s by
+          # their uris.
+          # @!attribute [rw] uris
+          #   @return [::Array<::String>]
+          #     The {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap} uris.
+          class UrisMatcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}s.
+          # Currently only supports uris matcher.
+          # @!attribute [rw] uris_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::FetchSitemapsRequest::UrisMatcher]
+          #     Matcher by sitemap URIs.
+          class Matcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class CreateSitemapMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class DeleteSitemapMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
+        # method.
+        # @!attribute [rw] sitemaps_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::FetchSitemapsResponse::SitemapMetadata>]
+        #     List of {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}s fetched.
+        class FetchSitemapsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains a {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap} and its
+          # metadata.
+          # @!attribute [rw] sitemap
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Sitemap]
+          #     The {::Google::Cloud::DiscoveryEngine::V1::Sitemap Sitemap}.
+          class SitemapMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
         # method.
@@ -348,9 +476,7 @@ module Google
         #     `site_search_engine`.
         # @!attribute [rw] site_credential
         #   @return [::String]
-        #     Optional. Full resource name of the [SiteCredential][], such as
-        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
-        #     Only set to crawl private URIs.
+        #     Optional. Credential id to use for crawling.
         class RecrawlUrisRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -421,9 +547,25 @@ module Google
         #     finish time.
         # @!attribute [rw] invalid_uris
         #   @return [::Array<::String>]
+        #     Unique URIs in the request that have invalid format. Sample limited to
+        #     1000.
+        # @!attribute [rw] invalid_uris_count
+        #   @return [::Integer]
+        #     Total number of unique URIs in the request that have invalid format.
+        # @!attribute [rw] noindex_uris
+        #   @return [::Array<::String>]
+        #     URIs that have no index meta tag. Sample limited to 1000.
+        # @!attribute [rw] noindex_uris_count
+        #   @return [::Integer]
+        #     Total number of URIs that have no index meta tag.
+        # @!attribute [rw] uris_not_matching_target_sites
+        #   @return [::Array<::String>]
         #     Unique URIs in the request that don't match any TargetSite in the
         #     DataStore, only match TargetSites that haven't been fully indexed, or match
-        #     a TargetSite with type EXCLUDE.
+        #     a TargetSite with type EXCLUDE. Sample limited to 1000.
+        # @!attribute [rw] uris_not_matching_target_sites_count
+        #   @return [::Integer]
+        #     Total number of URIs that don't match any TargetSites.
         # @!attribute [rw] valid_uris_count
         #   @return [::Integer]
         #     Total number of unique URIs in the request that are not in invalid_uris.

data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb

@@ -34,6 +34,7 @@ module Google
         #     * `view-item-list`: View of a panel or ordered list of Documents.
         #     * `view-home-page`: View of the home page.
         #     * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
+        #     * `add-feedback`: Add a user feedback.
         #
         #     Retail-related values:
         #
@@ -44,6 +45,23 @@ module Google
         #
         #     * `media-play`: Start/resume watching a video, playing a song, etc.
         #     * `media-complete`: Finished or stopped midway through a video, song, etc.
+        #
+        #     Custom conversion value:
+        #
+        #     * `conversion`: Customer defined conversion event.
+        # @!attribute [rw] conversion_type
+        #   @return [::String]
+        #     Optional. Conversion type.
+        #
+        #     Required if
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#event_type UserEvent.event_type}
+        #     is `conversion`. This is a customer-defined conversion name in lowercase
+        #     letters or numbers separated by "-", such as "watch", "good-visit" etc.
+        #
+        #     Do not set the field if
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#event_type UserEvent.event_type}
+        #     is not `conversion`. This mixes the custom conversion event with predefined
+        #     events like `search`, `view-item` etc.
         # @!attribute [rw] user_pseudo_id
         #   @return [::String]
         #     Required. A unique identifier for tracking visitors.
@@ -244,6 +262,10 @@ module Google
         # @!attribute [rw] media_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::MediaInfo]
         #     Media-specific info.
+        # @!attribute [rw] panels
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::PanelInfo>]
+        #     Optional. List of panels associated with this event.
+        #     Used for page-level impression data.
         class UserEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -457,6 +479,15 @@ module Google
         #   @return [::Boolean]
         #     Output only. Whether the referenced Document can be found in the data
         #     store.
+        # @!attribute [rw] conversion_value
+        #   @return [::Float]
+        #     Optional. The conversion value associated with this Document.
+        #     Must be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#event_type UserEvent.event_type}
+        #     is "conversion".
+        #
+        #     For example, a value of 1000 signifies that 1000 seconds were spent viewing
+        #     a Document for the `watch` conversion type.
         class DocumentInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -481,6 +512,9 @@ module Google
         #     Must be set if
         #     {::Google::Cloud::DiscoveryEngine::V1::PanelInfo#panel_position panel_position}
         #     is set.
+        # @!attribute [rw] documents
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>]
+        #     Optional. The document IDs associated with this panel.
         class PanelInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb

@@ -29,9 +29,9 @@ module Google
         #     {::Google::Cloud::DiscoveryEngine::V1::DataStore 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
-        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
+        #     If the write user event action is applied in
+        #     `::Google::Cloud::Location::Location` level, for example, the event
+        #     with {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
         #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, the format is:
         #     `projects/{project}/locations/{location}`.
         # @!attribute [rw] user_event
@@ -49,8 +49,16 @@ module Google
         # Request message for CollectUserEvent method.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent DataStore resource name, such as
+        #     Required. The parent resource name.
+        #     If the collect user event action is applied in
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} level, the format
+        #     is:
         #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+        #     If the collect user event action is applied in
+        #     `::Google::Cloud::Location::Location` level, for example, the event
+        #     with {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, the format is:
+        #     `projects/{project}/locations/{location}`.
         # @!attribute [rw] user_event
         #   @return [::String]
         #     Required. URL encoded UserEvent proto with a length limit of 2,000,000