google-cloud-discovery_engine-v1beta 0.26.0 → 0.28.0

data/proto_docs/google/cloud/discoveryengine/v1beta/feedback.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 V1beta
+        # Information about the user feedback. This information will be used for
+        # logging and metrics purpose.
+        # @!attribute [rw] feedback_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Feedback::FeedbackType]
+        #     Required. Indicate whether the user gives a positive or negative feedback.
+        #     If the user gives a negative feedback, there might be more feedback
+        #     details.
+        # @!attribute [rw] reasons
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Feedback::Reason>]
+        #     Optional. The reason if user gives a thumb down.
+        # @!attribute [rw] comment
+        #   @return [::String]
+        #     Optional. The additional user comment of the feedback if user gives a thumb
+        #     down.
+        # @!attribute [rw] conversation_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Feedback::ConversationInfo]
+        #     The related conversation information when user gives feedback.
+        # @!attribute [rw] llm_model_version
+        #   @return [::String]
+        #     The version of the LLM model that was used to generate the response.
+        # @!attribute [rw] feedback_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Feedback::FeedbackSource]
+        #     Optional. The UI component the user feedback comes from, which could be
+        #     GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.
+        # @!attribute [rw] component_version
+        #   @return [::String]
+        #     Optional. The version of the component that this report is being sent from.
+        # @!attribute [rw] data_terms_accepted
+        #   @return [::Boolean]
+        #     Optional. Whether the customer accepted data use terms.
+        class Feedback
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The conversation information such as the question index and session name.
+          # @!attribute [rw] question_index
+          #   @return [::Integer]
+          #     The index of the user input within the conversation messages.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Name of the newly generated or continued session.
+          # @!attribute [rw] query
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Query]
+          #     Required. The user's search query.
+          # @!attribute [rw] assist_token
+          #   @return [::String]
+          #     Optional. The token which could be used to fetch the assistant log.
+          # @!attribute [rw] answer_query_token
+          #   @return [::String]
+          #     Optional. The token which could be used to fetch the answer log.
+          class ConversationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The type of the feedback user gives.
+          module FeedbackType
+            # Unspecified feedback type.
+            FEEDBACK_TYPE_UNSPECIFIED = 0
+
+            # The user gives a positive feedback.
+            LIKE = 1
+
+            # The user gives a negative feedback.
+            DISLIKE = 2
+          end
+
+          # The reason why user gives a negative feedback.
+          module Reason
+            # Unspecified reason.
+            REASON_UNSPECIFIED = 0
+
+            # The response is inaccurate.
+            INACCURATE_RESPONSE = 1
+
+            # The response is not relevant.
+            NOT_RELEVANT = 2
+
+            # The response is incomprehensive.
+            INCOMPREHENSIVE = 3
+
+            # The response is offensive or unsafe.
+            OFFENSIVE_OR_UNSAFE = 4
+
+            # The response is not well-formatted.
+            FORMAT_AND_STYLES = 6
+
+            # The response is not well-associated with the query.
+            BAD_CITATION = 7
+
+            # The expected canvas was not generated for the response.
+            CANVAS_NOT_GENERATED = 8
+
+            # The generated canvas is of bad quality (e.g. inaccurate, incomplete,
+            # poorly formatted).
+            CANVAS_QUALITY_BAD = 9
+
+            # Exporting the generated canvas failed (e.g. download or external
+            # export action did not complete successfully).
+            CANVAS_EXPORT_FAILED = 10
+          end
+
+          # Source of the feedback as per integration.
+          module FeedbackSource
+            # Unspecified feedback source.
+            FEEDBACK_SOURCE_UNSPECIFIED = 0
+
+            # Feedback source is Google Console.
+            GOOGLE_CONSOLE = 1
+
+            # Feedback source is Google Widget.
+            GOOGLE_WIDGET = 2
+
+            # Feedback source is Google Webapp.
+            GOOGLE_WEBAPP = 3
+
+            # Feedback source is Google AgentSpace Mobile app.
+            GOOGLE_AGENTSPACE_MOBILE = 4
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb

@@ -114,15 +114,36 @@ module Google
           # @!attribute [rw] frequency_penalty
           #   @return [::Float]
           #     If specified, custom value for frequency penalty will be used.
+          # @!attribute [rw] seed
+          #   @return [::Integer]
+          #     If specified, custom value for the seed will be used.
           # @!attribute [rw] presence_penalty
           #   @return [::Float]
           #     If specified, custom value for presence penalty will be used.
           # @!attribute [rw] max_output_tokens
           #   @return [::Integer]
           #     If specified, custom value for max output tokens will be used.
+          # @!attribute [rw] provisioned_throughput_setting
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GenerationSpec::ProvisionedThroughputSetting]
+          #     Optional. Setting for provisioned throughput.
           class GenerationSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Setting for provisioned throughput.
+            module ProvisionedThroughputSetting
+              # Default value. If the user has remaining provisioned throughput,
+              # provisioned throughput will be used. Otherwise, pay as you go will be
+              # used.
+              PROVISIONED_THROUGHPUT_SETTING_UNSPECIFIED = 0
+
+              # Only use provisioned throughput. If the user has no remaining
+              # provisioned throughput, an error will be returned.
+              PROVISIONED_THROUGHPUT_ONLY = 1
+
+              # Disables provisioned throughput.
+              PAY_AS_YOU_GO_ONLY = 2
+            end
           end
 
           # Describes the options to customize dynamic retrieval.
@@ -161,17 +182,22 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::InlineSource]
           #     If set, grounding is performed with inline content.
           #
-          #     Note: The following fields are mutually exclusive: `inline_source`, `search_source`, `google_search_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          #     Note: The following fields are mutually exclusive: `inline_source`, `search_source`, `google_search_source`, `enterprise_web_retrieval_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] search_source
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::SearchSource]
           #     If set, grounding is performed with Vertex AI Search.
           #
-          #     Note: The following fields are mutually exclusive: `search_source`, `inline_source`, `google_search_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          #     Note: The following fields are mutually exclusive: `search_source`, `inline_source`, `google_search_source`, `enterprise_web_retrieval_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] google_search_source
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::GoogleSearchSource]
           #     If set, grounding is performed with Google Search.
           #
-          #     Note: The following fields are mutually exclusive: `google_search_source`, `inline_source`, `search_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          #     Note: The following fields are mutually exclusive: `google_search_source`, `inline_source`, `search_source`, `enterprise_web_retrieval_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] enterprise_web_retrieval_source
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::EnterpriseWebRetrievalSource]
+          #     If set, grounding is performed with enterprise web retrieval.
+          #
+          #     Note: The following fields are mutually exclusive: `enterprise_web_retrieval_source`, `inline_source`, `search_source`, `google_search_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class GroundingSource
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -231,10 +257,30 @@ module Google
             #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
             #     Optional. Specifies the dynamic retrieval configuration for the given
             #     source.
+            # @!attribute [rw] exclude_domains
+            #   @return [::Array<::String>]
+            #     Optional. List of domains to be excluded from the search results.
+            # @!attribute [rw] blocking_confidence
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Citation::PhishBlockThreshold]
+            #     Optional. Sites with confidence level chosen & above this value will be
+            #     blocked from the search results.
             class GoogleSearchSource
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Params for using enterprise web retrieval as grounding source.
+            # @!attribute [rw] exclude_domains
+            #   @return [::Array<::String>]
+            #     Optional. List of domains to be excluded from the search results.
+            # @!attribute [rw] blocking_confidence
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Citation::PhishBlockThreshold]
+            #     Optional. Sites with confidence level chosen & above this value will be
+            #     blocked from the search results.
+            class EnterpriseWebRetrievalSource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # Grounding specification.
@@ -303,6 +349,12 @@ module Google
             #     GroundingSupport across all claims in the answer candidate.
             #     An support to a fact indicates that the claim is supported by
             #     the fact.
+            # @!attribute [rw] images
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::ImageMetadata>]
+            #     Images from the web search.
+            # @!attribute [rw] videos
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::VideoMetadata>]
+            #     Videos from the web search.
             class GroundingMetadata
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,6 +457,60 @@ module Google
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
+
+              # Metadata about an image from the web search.
+              # @!attribute [rw] image
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::ImageMetadata::Image]
+              #     Metadata about the full size image.
+              # @!attribute [rw] thumbnail
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::ImageMetadata::Image]
+              #     Metadata about the thumbnail.
+              # @!attribute [rw] source
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::ImageMetadata::WebsiteInfo]
+              #     The details about the website that the image is from.
+              class ImageMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Metadata about the website that the image is from.
+                # @!attribute [rw] uri
+                #   @return [::String]
+                #     The url of the website.
+                # @!attribute [rw] title
+                #   @return [::String]
+                #     The title of the website.
+                # @!attribute [rw] site_display_name
+                #   @return [::String]
+                #     The display name of the website.
+                class WebsiteInfo
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+
+                # Metadata about the image.
+                # @!attribute [rw] uri
+                #   @return [::String]
+                #     The url of the image.
+                # @!attribute [rw] width
+                #   @return [::Integer]
+                #     The width of the image in pixels.
+                # @!attribute [rw] height
+                #   @return [::Integer]
+                #     The height of the image in pixels.
+                class Image
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+              end
+
+              # Metadata about a video from the web search.
+              # @!attribute [rw] youtube_external_id
+              #   @return [::String]
+              #     The external id of the video.
+              class VideoMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
             end
           end
         end
@@ -417,6 +523,9 @@ module Google
         #     will lead to fewer but very strong citations, while choosing a lower
         #     threshold may lead to more but somewhat weaker citations. If unset, the
         #     threshold will default to 0.6.
+        # @!attribute [rw] enable_claim_level_score
+        #   @return [::Boolean]
+        #     The control flag that enables claim-level grounding score in the response.
         class CheckGroundingSpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -508,11 +617,21 @@ module Google
           # @!attribute [rw] start_pos
           #   @return [::Integer]
           #     Position indicating the start of the claim in the answer candidate,
-          #     measured in bytes.
+          #     measured in bytes. Note that this is not measured in characters and,
+          #     therefore, must be rendered in the user interface keeping in mind that
+          #     some characters may take more than one byte. For example,
+          #     if the claim text contains non-ASCII characters, the start and end
+          #     positions vary when measured in characters
+          #     (programming-language-dependent) and when measured in bytes
+          #     (programming-language-independent).
           # @!attribute [rw] end_pos
           #   @return [::Integer]
           #     Position indicating the end of the claim in the answer candidate,
-          #     exclusive.
+          #     exclusive, in bytes. Note that this is not measured in characters and,
+          #     therefore, must be rendered as such. For example, if the claim text
+          #     contains non-ASCII characters, the start and end positions vary when
+          #     measured in characters (programming-language-dependent) and when measured
+          #     in bytes (programming-language-independent).
           # @!attribute [rw] claim_text
           #   @return [::String]
           #     Text for the claim in the answer candidate. Always provided regardless of
@@ -530,16 +649,78 @@ module Google
           #     decided this claim doesn't require attribution/grounding check, this
           #     field will be set to false. In that case, no grounding check was done for
           #     the claim and therefore
-          #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
-          #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
-          #     and
-          #     [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices}
           #     should not be returned.
+          # @!attribute [rw] score
+          #   @return [::Float]
+          #     Confidence score for the claim in the answer candidate, in the range of
+          #     [0, 1]. This is set only when
+          #     `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
           class Claim
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # A collection of source attributions for a piece of content.
+        # @!attribute [r] citations
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Citation>]
+        #     Output only. List of citations.
+        class CitationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Source attributions for content.
+        # @!attribute [r] start_index
+        #   @return [::Integer]
+        #     Output only. Start index into the content.
+        # @!attribute [r] end_index
+        #   @return [::Integer]
+        #     Output only. End index into the content.
+        # @!attribute [r] uri
+        #   @return [::String]
+        #     Output only. Url reference of the attribution.
+        # @!attribute [r] title
+        #   @return [::String]
+        #     Output only. Title of the attribution.
+        # @!attribute [r] license
+        #   @return [::String]
+        #     Output only. License of the attribution.
+        # @!attribute [r] publication_date
+        #   @return [::Google::Type::Date]
+        #     Output only. Publication date of the attribution.
+        class Citation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # These are available confidence level user can set to block malicious urls
+          # with chosen confidence and above. For understanding different confidence of
+          # webrisk, please refer to
+          # https://cloud.google.com/web-risk/docs/reference/rpc/google.cloud.webrisk.v1eap1#confidencelevel
+          module PhishBlockThreshold
+            # Defaults to unspecified.
+            PHISH_BLOCK_THRESHOLD_UNSPECIFIED = 0
+
+            # Blocks Low and above confidence URL that is risky.
+            BLOCK_LOW_AND_ABOVE = 30
+
+            # Blocks Medium and above confidence URL that is risky.
+            BLOCK_MEDIUM_AND_ABOVE = 40
+
+            # Blocks High and above confidence URL that is risky.
+            BLOCK_HIGH_AND_ABOVE = 50
+
+            # Blocks Higher and above confidence URL that is risky.
+            BLOCK_HIGHER_AND_ABOVE = 55
+
+            # Blocks Very high and above confidence URL that is risky.
+            BLOCK_VERY_HIGH_AND_ABOVE = 60
+
+            # Blocks Extremely high confidence URL that is risky.
+            BLOCK_ONLY_EXTREMELY_HIGH = 100
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb

@@ -70,6 +70,15 @@ module Google
         # @!attribute [rw] source_metadata
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     More fine-grained information for the source reference.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The URI of the source.
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     The title of the source.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     The domain of the source.
         class FactChunk
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 V1beta
+        # Identity Mapping Store which contains Identity Mapping Entries.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The full resource name of the identity mapping store.
+        #     Format:
+        #     `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     Input only. The KMS key to be used to protect this Identity Mapping Store
+        #     at creation time.
+        #
+        #     Must be set for requests that need to comply with CMEK Org Policy
+        #     protections.
+        #
+        #     If this field is set and processed successfully, the Identity Mapping Store
+        #     will be protected by the KMS key, as indicated in the cmek_config field.
+        # @!attribute [r] cmek_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig]
+        #     Output only. CMEK-related information for the Identity Mapping Store.
+        class IdentityMappingStore
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Identity Mapping Entry that maps an external identity to an internal
+        # identity.
+        # @!attribute [rw] user_id
+        #   @return [::String]
+        #     User identifier.
+        #     For Google Workspace user account, user_id should be the google workspace
+        #     user email.
+        #     For non-google identity provider, user_id is the mapped user identifier
+        #     configured during the workforcepool config.
+        #
+        #     Note: The following fields are mutually exclusive: `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] group_id
+        #   @return [::String]
+        #     Group identifier.
+        #     For Google Workspace user account, group_id should be the google
+        #     workspace group email.
+        #     For non-google identity provider, group_id is the mapped group identifier
+        #     configured during the workforcepool config.
+        #
+        #     Note: The following fields are mutually exclusive: `group_id`, `user_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] external_identity
+        #   @return [::String]
+        #     Required. Identity outside the customer identity provider.
+        #     The length limit of external identity will be of 100 characters.
+        # @!attribute [rw] external_identity_name
+        #   @return [::String]
+        #     Optional. The name of the external identity.
+        class IdentityMappingEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end