google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.0

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

@@ -0,0 +1,40 @@
+# 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
+        # Observability config for a resource.
+        # @!attribute [rw] observability_enabled
+        #   @return [::Boolean]
+        #     Optional. Enables observability. If `false`, all other flags are ignored.
+        # @!attribute [rw] sensitive_logging_enabled
+        #   @return [::Boolean]
+        #     Optional. Enables sensitive logging. Sensitive logging includes customer
+        #     core content (e.g. prompts, responses). If `false`, will sanitize all
+        #     sensitive fields.
+        class ObservabilityConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -40,6 +40,12 @@ module Google
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms}]
         #     Output only. A map of terms of services. The key is the `id` of
         #     {::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms ServiceTerms}.
+        # @!attribute [rw] customer_provided_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::CustomerProvidedConfig]
+        #     Optional. Customer provided configurations.
+        # @!attribute [r] configurable_billing_status
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::ConfigurableBillingStatus]
+        #     Output only. The current status of the project's configurable billing.
         class Project
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -91,6 +97,214 @@ module Google
             end
           end
 
+          # Customer provided configurations.
+          # @!attribute [rw] notebooklm_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::CustomerProvidedConfig::NotebooklmConfig]
+          #     Optional. Configuration for NotebookLM settings.
+          class CustomerProvidedConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Configuration for NotebookLM.
+            # @!attribute [rw] model_armor_config
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::CustomerProvidedConfig::NotebooklmConfig::ModelArmorConfig]
+            #     Model Armor configuration to be used for sanitizing user prompts and
+            #     LLM responses.
+            # @!attribute [rw] opt_out_notebook_sharing
+            #   @return [::Boolean]
+            #     Optional. Whether to disable the notebook sharing feature for the
+            #     project. Default to false if not specified.
+            # @!attribute [rw] data_protection_policy
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::CustomerProvidedConfig::NotebooklmConfig::DataProtectionPolicy]
+            #     Optional. Specifies the data protection policy for NotebookLM.
+            # @!attribute [rw] observability_config
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig]
+            #     Optional. Observability config for NotebookLM.
+            class NotebooklmConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Configuration for customer defined Model Armor templates to be used for
+              # sanitizing user prompts and LLM responses.
+              # @!attribute [rw] user_prompt_template
+              #   @return [::String]
+              #     Optional. The resource name of the Model Armor Template for
+              #     sanitizing user prompts. Format:
+              #     projects/\\{project}/locations/\\{location}/templates/\\{template_id}
+              #     If not specified, no sanitization will be applied to the user prompt.
+              # @!attribute [rw] response_template
+              #   @return [::String]
+              #     Optional. The resource name of the Model Armor Template for
+              #     sanitizing LLM responses. Format:
+              #     projects/\\{project}/locations/\\{location}/templates/\\{template_id}
+              #     If not specified, no sanitization will be applied to the LLM
+              #     response.
+              class ModelArmorConfig
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Data protection policy config for NotebookLM.
+              # @!attribute [rw] sensitive_data_protection_policy
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::CustomerProvidedConfig::NotebooklmConfig::DataProtectionPolicy::SensitiveDataProtectionPolicy]
+              #     Optional. The sensitive data protection policy.
+              class DataProtectionPolicy
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Specifies a Sensitive Data Protection
+                # (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview)
+                # policy.
+                # @!attribute [rw] policy
+                #   @return [::String]
+                #     Optional. The Sensitive Data Protection policy resource name.
+                class SensitiveDataProtectionPolicy
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+              end
+            end
+          end
+
+          # Represents the currently effective configurable billing parameters.
+          # These values are derived from the customer's subscription history stored
+          # internally and reflect the thresholds actively being used for billing
+          # purposes at the time of the GetProject call. This includes the start_time
+          # of the subscription and may differ from the values in
+          # `customer_provided_config` due to billing rules
+          # (e.g., scale-downs taking effect only at the start of a new month).
+          # We also include the update type to indicate the type of update performed on
+          # the configurable billing configuration in the UpdateProject operation.
+          # @!attribute [rw] effective_search_qpm_threshold
+          #   @return [::Integer]
+          #     Optional. The currently effective Search QPM threshold in queries per
+          #     minute. This is the threshold against which QPM usage is compared for
+          #     overage calculations.
+          # @!attribute [rw] effective_indexing_core_threshold
+          #   @return [::Integer]
+          #     Optional. The currently effective Indexing Core threshold.
+          #     This is the threshold against which Indexing Core usage is compared
+          #     for overage calculations.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The start time of the currently active billing subscription.
+          # @!attribute [r] terminate_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The latest terminate effective time of search qpm and
+          #     indexing core subscriptions.
+          # @!attribute [r] search_qpm_threshold_next_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The earliest next update time for the search QPM
+          #     subscription threshold. This is based on the next_update_time returned by
+          #     the underlying Cloud Billing Subscription V3 API. This field is populated
+          #     only if an update QPM subscription threshold request is succeeded.
+          # @!attribute [r] indexing_core_threshold_next_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The earliest next update time for the indexing core
+          #     subscription threshold. This is based on the next_update_time returned by
+          #     the underlying Cloud Billing Subscription V3 API. This field is populated
+          #     only if an update indexing core subscription threshold
+          #     request is succeeded.
+          # @!attribute [r] update_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::ConfigurableBillingStatus::UpdateType]
+          #     Output only. The type of update performed in this operation.
+          #     This field is populated in the response of UpdateProject.
+          # @!attribute [r] agent_search_token_subscription_statuses
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Project::ConfigurableBillingStatus::AgentSearchTokenSubscriptionStatus>]
+          #     Output only. Per-model Agent Search TPM subscription status.
+          class ConfigurableBillingStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Per-model Agent Search TPM subscription status. One entry per active
+            # `core_subscription.agent_search_token_subscriptions[*]` entry in the
+            # customer-provided config; populated by UpdateProject and GetProject.
+            #
+            # The lifecycle scalars on this message (`start_time`, `terminate_time`,
+            # `update_type`, `tpm_threshold_next_update_time`) are per (project,
+            # model_version) — siblings of the whole-relationship `start_time` /
+            # `terminate_time` / `update_type` on the enclosing
+            # ConfigurableBillingStatus, but scoped to this specific Agent Search
+            # TPM subscription instead of to the overall customer-configurable-
+            # pricing relationship. This per-instance granularity is intentional:
+            # the underlying SubV3 storage is per-(project, model_version), so
+            # each model has its own activation, termination, and deferred-update
+            # clock; surfacing that on the response gives customers the granularity
+            # they need to manage per-model commitments independently. QPM /
+            # IndexingCore differ — their storage is one row per (project,
+            # location), so their lifecycle is represented only by the whole-
+            # relationship scalars on ConfigurableBillingStatus.
+            # @!attribute [r] model_version
+            #   @return [::String]
+            #     Output only. The Gemini model version this status corresponds to.
+            #     Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a
+            #     stable Gemini model version from the Gemini Enterprise Agent Platform
+            #     model-versions registry; see
+            #     https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
+            # @!attribute [r] effective_tpm_threshold
+            #   @return [::Integer]
+            #     Output only. The currently effective TPM threshold. Reflects scale-up
+            #     immediately and scale-down at the next billing cycle, matching
+            #     `effective_search_qpm_threshold` semantics.
+            # @!attribute [r] tpm_threshold_next_update_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. The earliest next update time for the TPM subscription
+            #     threshold for this (project, model_version). Populated only after a
+            #     successful update.
+            # @!attribute [r] start_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. When this (project, model_version) Agent Search TPM
+            #     subscription was first activated. Set once on first activation of this
+            #     model version and never moved by subsequent threshold updates; on
+            #     termination + re-activation a new value is recorded. Does NOT move
+            #     the whole-relationship `start_time` on the enclosing
+            #     ConfigurableBillingStatus, which continues to represent the first
+            #     activation of the overall customer-configurable-pricing
+            #     relationship.
+            # @!attribute [r] terminate_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. If set, the scheduled effective time at which this
+            #     (project, model_version) Agent Search TPM subscription will terminate.
+            #     Populated when the customer removes this entry from
+            #     `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move
+            #     the whole-relationship `terminate_time` on the enclosing
+            #     ConfigurableBillingStatus, which is populated only when the entire
+            #     customer-configurable-pricing relationship is being torn down.
+            # @!attribute [r] update_type
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::ConfigurableBillingStatus::UpdateType]
+            #     Output only. The type of the most recent update to this (project,
+            #     model_version) subscription, as performed by the most recent
+            #     UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this
+            #     model_version was not touched by the most recent UpdateProject (its
+            #     `effective_tpm_threshold` reflects an earlier update). The
+            #     whole-relationship `update_type` on the enclosing
+            #     ConfigurableBillingStatus continues to summarize the direction of
+            #     the most recent update across all surfaces in the project (QPM,
+            #     IndexingCore, and Agent Search TPM together).
+            class AgentSearchTokenSubscriptionStatus
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The type of update performed on the configurable billing configuration.
+            module UpdateType
+              # Unspecified update type.
+              UPDATE_TYPE_UNSPECIFIED = 0
+
+              # Configurable billing was created/enabled.
+              CREATE = 1
+
+              # Configurable billing was deleted/disabled.
+              DELETE = 2
+
+              # Subscription was scaled up (thresholds increased).
+              SCALE_UP = 3
+
+              # Subscription was scaled down (thresholds decreased).
+              SCALE_DOWN = 4
+            end
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value

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

@@ -41,9 +41,27 @@ module Google
         #     and would like to give consent to.
         #
         #     Acceptable version is `2022-11-23`, and this may change over time.
+        # @!attribute [rw] saas_params
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ProvisionProjectRequest::SaasParams]
+        #     Optional. Parameters for Agentspace.
         class ProvisionProjectRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Parameters for Agentspace.
+          # @!attribute [rw] accept_biz_qos
+          #   @return [::Boolean]
+          #     Optional. Set to `true` to specify that caller has read and would like to
+          #     give consent to the [Terms for Agent Space quality of service].
+          # @!attribute [rw] is_biz
+          #   @return [::Boolean]
+          #     Optional. Indicates if the current request is for Biz edition (= true) or
+          #     not
+          #     (= false).
+          class SaasParams
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Metadata associated with a project provision operation.

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

@@ -41,16 +41,20 @@ module Google
         #     * `userId`: Double quoted string. Specifying this will delete all events
         #       associated with a user.
         #
+        #     Note: This API only supports purging a max range of 30 days.
+        #
         #     Examples:
         #
         #     * Deleting all events in a time range:
         #       `eventTime > "2012-04-23T18:25:43.511Z"
         #       eventTime < "2012-04-23T18:30:43.511Z"`
-        #     * Deleting specific eventType:
-        #       `eventType = "search"`
-        #     * Deleting all events for a specific visitor:
-        #       `userPseudoId = "visitor1024"`
-        #     * Deleting all events inside a DataStore:
+        #     * Deleting specific eventType in a time range:
+        #       `eventTime > "2012-04-23T18:25:43.511Z"
+        #       eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`
+        #     * Deleting all events for a specific visitor in a time range:
+        #       `eventTime > "2012-04-23T18:25:43.511Z"
+        #       eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`
+        #     * Deleting the past 30 days of events inside a DataStore:
         #       `*`
         #
         #     The filtering fields are assumed to have an implicit AND.

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

@@ -44,6 +44,8 @@ module Google
         # @!attribute [rw] score
         #   @return [::Float]
         #     The score of this record based on the given query and selected model.
+        #     The score will be rounded to 4 decimal places. If the score is close to 0,
+        #     it will be rounded to 0.00001 to avoid returning unset.
         class RankingRecord
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -60,7 +62,7 @@ module Google
         #   @return [::String]
         #     The identifier of the model to use. It is one of:
         #
-        #     * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+        #     * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
         #     token size 512.
         #
         #     It is set to `semantic-ranker-512@latest` by default if unspecified.
@@ -73,7 +75,7 @@ module Google
         #     The query to use.
         # @!attribute [rw] records
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
-        #     Required. A list of records to rank. At most 200 records to rank.
+        #     Required. A list of records to rank.
         # @!attribute [rw] ignore_record_details_in_response
         #   @return [::Boolean]
         #     If true, the response will contain only record ID and score. By default, it

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

@@ -77,9 +77,9 @@ module Google
         #     attribute-based expressions are expected instead of the above described
         #     tag-based syntax. Examples:
         #
-        #      * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
+        #      * (language: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
         #      * (available: true) AND
-        #        (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
+        #        (language: ANY("en", "es")) OR (categories: ANY("Movie"))
         #
         #     If your filter blocks all results, the API returns generic
         #     (unfiltered) popular Documents. If you only want results strictly matching

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

@@ -0,0 +1,108 @@
+# 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
+        # Safety rating corresponding to the generated content.
+        # @!attribute [r] category
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::HarmCategory]
+        #     Output only. Harm category.
+        # @!attribute [r] probability
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SafetyRating::HarmProbability]
+        #     Output only. Harm probability levels in the content.
+        # @!attribute [r] probability_score
+        #   @return [::Float]
+        #     Output only. Harm probability score.
+        # @!attribute [r] severity
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SafetyRating::HarmSeverity]
+        #     Output only. Harm severity levels in the content.
+        # @!attribute [r] severity_score
+        #   @return [::Float]
+        #     Output only. Harm severity score.
+        # @!attribute [r] blocked
+        #   @return [::Boolean]
+        #     Output only. Indicates whether the content was filtered out because of this
+        #     rating.
+        class SafetyRating
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Harm probability levels in the content.
+          module HarmProbability
+            # Harm probability unspecified.
+            HARM_PROBABILITY_UNSPECIFIED = 0
+
+            # Negligible level of harm.
+            NEGLIGIBLE = 1
+
+            # Low level of harm.
+            LOW = 2
+
+            # Medium level of harm.
+            MEDIUM = 3
+
+            # High level of harm.
+            HIGH = 4
+          end
+
+          # Harm severity levels.
+          module HarmSeverity
+            # Harm severity unspecified.
+            HARM_SEVERITY_UNSPECIFIED = 0
+
+            # Negligible level of harm severity.
+            HARM_SEVERITY_NEGLIGIBLE = 1
+
+            # Low level of harm severity.
+            HARM_SEVERITY_LOW = 2
+
+            # Medium level of harm severity.
+            HARM_SEVERITY_MEDIUM = 3
+
+            # High level of harm severity.
+            HARM_SEVERITY_HIGH = 4
+          end
+        end
+
+        # Harm categories that will block the content.
+        module HarmCategory
+          # The harm category is unspecified.
+          HARM_CATEGORY_UNSPECIFIED = 0
+
+          # The harm category is hate speech.
+          HARM_CATEGORY_HATE_SPEECH = 1
+
+          # The harm category is dangerous content.
+          HARM_CATEGORY_DANGEROUS_CONTENT = 2
+
+          # The harm category is harassment.
+          HARM_CATEGORY_HARASSMENT = 3
+
+          # The harm category is sexually explicit content.
+          HARM_CATEGORY_SEXUALLY_EXPLICIT = 4
+
+          # The harm category is civic integrity.
+          HARM_CATEGORY_CIVIC_INTEGRITY = 5
+        end
+      end
+    end
+  end
+end