google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.0

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

@@ -42,7 +42,8 @@ module Google
         #     Output only. Represents the relevance score based on similarity.
         #     Higher score indicates higher chunk relevance.
         #     The score is in range [-1.0, 1.0].
-        #     Only populated on [SearchService.SearchResponse][].
+        #     Only populated on
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse SearchResponse}.
         # @!attribute [rw] document_metadata
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata]
         #     Metadata of the document from the current chunk.
@@ -56,6 +57,20 @@ module Google
         # @!attribute [r] chunk_metadata
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::ChunkMetadata]
         #     Output only. Metadata of the current chunk.
+        # @!attribute [r] data_urls
+        #   @return [::Array<::String>]
+        #     Output only. Image Data URLs if the current chunk contains images.
+        #     Data URLs are composed of four parts: a prefix (data:), a MIME type
+        #     indicating the type of data, an optional base64 token if non-textual,
+        #     and the data itself:
+        #     data:[<mediatype>][;base64],<data>
+        # @!attribute [r] annotation_contents
+        #   @return [::Array<::String>]
+        #     Output only. Annotation contents if the current chunk contains annotations.
+        # @!attribute [r] annotation_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Chunk::AnnotationMetadata>]
+        #     Output only. The annotation metadata includes structured content in the
+        #     current chunk.
         class Chunk
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -68,6 +83,10 @@ module Google
           # @!attribute [rw] title
           #   @return [::String]
           #     Title of the document.
+          # @!attribute [rw] mime_type
+          #   @return [::String]
+          #     The mime type of the document.
+          #     https://www.iana.org/assignments/media-types/media-types.xhtml.
           # @!attribute [rw] struct_data
           #   @return [::Google::Protobuf::Struct]
           #     Data representation.
@@ -112,6 +131,46 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # The structured content information.
+          # @!attribute [r] structure_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::StructureType]
+          #     Output only. The structure type of the structured content.
+          # @!attribute [r] content
+          #   @return [::String]
+          #     Output only. The content of the structured content.
+          class StructuredContent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The annotation metadata includes structured content in the current chunk.
+          # @!attribute [r] structured_content
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::StructuredContent]
+          #     Output only. The structured content information.
+          # @!attribute [r] image_id
+          #   @return [::String]
+          #     Output only. Image id is provided if the structured content is based on
+          #     an image.
+          class AnnotationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Defines the types of the structured content that can be extracted.
+          module StructureType
+            # Default value.
+            STRUCTURE_TYPE_UNSPECIFIED = 0
+
+            # Shareholder structure.
+            SHAREHOLDER_STRUCTURE = 1
+
+            # Signature structure.
+            SIGNATURE_STRUCTURE = 2
+
+            # Checkbox structure.
+            CHECKBOX_STRUCTURE = 3
+          end
         end
       end
     end

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

@@ -0,0 +1,228 @@
+# 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
+        # Request message for UpdateCmekConfig method.
+        # rpc.
+        # @!attribute [rw] config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig]
+        #     Required. The CmekConfig resource.
+        # @!attribute [rw] set_default
+        #   @return [::Boolean]
+        #     Set the following CmekConfig as the default to be used for child
+        #     resources if one is not specified.
+        class UpdateCmekConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetCmekConfigRequest method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig CmekConfig}, such as
+        #     `projects/*/locations/*/cmekConfig` or
+        #     `projects/*/locations/*/cmekConfigs/*`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig CmekConfig}, regardless of
+        #     whether or not it exists, a PERMISSION_DENIED error is returned.
+        class GetCmekConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for single-regional CMEKs.
+        # @!attribute [rw] kms_key
+        #   @return [::String]
+        #     Required. Single-regional kms key resource name which will be used to
+        #     encrypt resources
+        #     `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+        class SingleRegionKey
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configurations used to enable CMEK data encryption with Cloud KMS keys.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the CmekConfig of the form
+        #     `projects/{project}/locations/{location}/cmekConfig` or
+        #     `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
+        # @!attribute [rw] kms_key
+        #   @return [::String]
+        #     Required. KMS key resource name which will be used to encrypt resources
+        #     `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+        # @!attribute [r] kms_key_version
+        #   @return [::String]
+        #     Output only. KMS key version resource name which will be used to encrypt
+        #     resources
+        #     `<kms_key>/cryptoKeyVersions/{keyVersion}`.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig::State]
+        #     Output only. The states of the CmekConfig.
+        # @!attribute [r] is_default
+        #   @return [::Boolean]
+        #     Output only. The default CmekConfig for the Customer.
+        # @!attribute [r] last_rotation_timestamp_micros
+        #   @return [::Integer]
+        #     Output only. The timestamp of the last key rotation.
+        # @!attribute [rw] single_region_keys
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SingleRegionKey>]
+        #     Optional. Single-regional CMEKs that are required for some VAIS features.
+        # @!attribute [r] notebooklm_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig::NotebookLMState]
+        #     Output only. Whether the NotebookLM Corpus is ready to be used.
+        class CmekConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # States of the CmekConfig.
+          module State
+            # The CmekConfig state is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The CmekConfig is creating.
+            CREATING = 1
+
+            # The CmekConfig can be used with DataStores.
+            ACTIVE = 2
+
+            # The CmekConfig is unavailable, most likely due to the KMS Key being
+            # revoked.
+            KEY_ISSUE = 3
+
+            # The CmekConfig is deleting.
+            DELETING = 4
+
+            # The CmekConfig deletion process failed.
+            DELETE_FAILED = 7
+
+            # The CmekConfig is not usable, most likely due to some internal issue.
+            UNUSABLE = 5
+
+            # The KMS key version is being rotated.
+            ACTIVE_ROTATING = 6
+
+            # The KMS key is soft deleted. Some cleanup policy will eventually be
+            # applied.
+            DELETED = 8
+
+            # The KMS key is expired, meaning the key has been disabled for 30+ days.
+            # The customer can call DeleteCmekConfig to change the state to DELETED.
+            EXPIRED = 9
+          end
+
+          # States of NotebookLM.
+          module NotebookLMState
+            # The NotebookLM state is unknown.
+            NOTEBOOK_LM_STATE_UNSPECIFIED = 0
+
+            # The NotebookLM is not ready.
+            NOTEBOOK_LM_NOT_READY = 1
+
+            # The NotebookLM is ready to be used.
+            NOTEBOOK_LM_READY = 2
+
+            # The NotebookLM is not enabled.
+            NOTEBOOK_LM_NOT_ENABLED = 3
+          end
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfigService::Client#update_cmek_config CmekConfigService.UpdateCmekConfig}
+        # 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 UpdateCmekConfigMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfigService::Client#list_cmek_configs CmekConfigService.ListCmekConfigs}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent location resource name, such as
+        #     `projects/{project}/locations/{location}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig CmekConfig}s under this
+        #     location, regardless of whether or not a CmekConfig exists, a
+        #     PERMISSION_DENIED error is returned.
+        class ListCmekConfigsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfigService::Client#list_cmek_configs CmekConfigService.ListCmekConfigs}
+        # method.
+        # @!attribute [rw] cmek_configs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig>]
+        #     All the customer's
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig CmekConfig}s.
+        class ListCmekConfigsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfigService::Client#delete_cmek_config CmekConfigService.DeleteCmekConfig}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig CmekConfig} to delete,
+        #     such as
+        #     `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
+        class DeleteCmekConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CmekConfigService::Client#delete_cmek_config CmekConfigService.DeleteCmekConfig}
+        # 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 DeleteCmekConfigMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -91,6 +91,10 @@ module Google
         #
         #     The field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        #
+        #     Represents an opaque ID to the Search API. The Search API doesn't
+        #     interpret the value in any way. This field is used to associate events
+        #     with a user across sessions if the events are being uploaded.
         # @!attribute [rw] user_agent
         #   @return [::String]
         #     User agent as included in the HTTP header.
@@ -104,9 +108,35 @@ module Google
         #     or if
         #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#direct_user_request UserEvent.direct_user_request}
         #     is set.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     Optional. IANA time zone, e.g. Europe/Budapest.
+        # @!attribute [rw] precise_location
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo::PreciseLocation]
+        #     Optional. Input only. Precise location of the user.
+        #     It is used in Custom Ranking to calculate the distance between the user and
+        #     the relevant documents.
         class UserInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Precise location info with multiple representation options.
+          # Currently only latitude and longitude point is supported.
+          # @!attribute [rw] point
+          #   @return [::Google::Type::LatLng]
+          #     Optional. Location represented by a latitude/longitude point.
+          #
+          #     Note: The following fields are mutually exclusive: `point`, `address`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] address
+          #   @return [::String]
+          #     Optional. Location represented by a natural language address. Will
+          #     later be geocoded and converted to either a point or a polygon.
+          #
+          #     Note: The following fields are mutually exclusive: `address`, `point`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          class PreciseLocation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Defines embedding config, used for bring your own embeddings feature.
@@ -127,6 +157,131 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Identity Provider Config.
+        # @!attribute [rw] idp_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::IdpConfig::IdpType]
+        #     Identity provider type configured.
+        # @!attribute [rw] external_idp_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::IdpConfig::ExternalIdpConfig]
+        #     External Identity provider config.
+        class IdpConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Third party IDP Config.
+          # @!attribute [rw] workforce_pool_name
+          #   @return [::String]
+          #     Workforce pool name.
+          #     Example: "locations/global/workforcePools/pool_id"
+          class ExternalIdpConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Identity Provider Type.
+          module IdpType
+            # Default value. ACL search not enabled.
+            IDP_TYPE_UNSPECIFIED = 0
+
+            # Google 1P provider.
+            GSUITE = 1
+
+            # Third party provider.
+            THIRD_PARTY = 2
+          end
+        end
+
+        # Principal identifier of a user or a group.
+        # @!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 account, user_id is the mapped user
+        #     identifier configured during the workforcepool config.
+        #
+        #     Note: The following fields are mutually exclusive: `user_id`, `group_id`, `external_entity_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 user account, group_id is the mapped
+        #     group identifier configured during the workforcepool config.
+        #
+        #     Note: The following fields are mutually exclusive: `group_id`, `user_id`, `external_entity_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] external_entity_id
+        #   @return [::String]
+        #     For 3P application identities which are not present in the customer
+        #     identity provider.
+        #
+        #     Note: The following fields are mutually exclusive: `external_entity_id`, `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class Principal
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Config to data store for `HEALTHCARE_FHIR` vertical.
+        # @!attribute [rw] enable_configurable_schema
+        #   @return [::Boolean]
+        #     Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical.
+        #
+        #     If set to `true`, the predefined healthcare fhir schema can be extended
+        #     for more customized searching and filtering.
+        # @!attribute [rw] enable_static_indexing_for_batch_ingestion
+        #   @return [::Boolean]
+        #     Whether to enable static indexing for `HEALTHCARE_FHIR` batch
+        #     ingestion.
+        #
+        #     If set to `true`, the batch ingestion will be processed in a static
+        #     indexing mode which is slower but more capable of handling larger
+        #     volume.
+        # @!attribute [rw] initial_filter_groups
+        #   @return [::Array<::String>]
+        #     Optional. Names of the Group resources to use as a basis for the initial
+        #     patient filter, in format
+        #     `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.
+        #     The filter group must be a FHIR resource name of
+        #     type Group, and the filter will be constructed from the direct members of
+        #     the group which are Patient resources.
+        class HealthcareFhirConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Promotion proto includes uri and other helping information to display the
+        # promotion.
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     Required. The title of the promotion.
+        #     Maximum length: 160 characters.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Optional. The URL for the page the user wants to promote. Must be set for
+        #     site search. For other verticals, this is optional.
+        # @!attribute [rw] document
+        #   @return [::String]
+        #     Optional. The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} the
+        #     user wants to promote. For site search, leave unset and only populate uri.
+        #     Can be set along with uri.
+        # @!attribute [rw] image_uri
+        #   @return [::String]
+        #     Optional. The promotion thumbnail image url.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The Promotion description.
+        #     Maximum length: 200 characters.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Optional. The enabled promotion will be returned for any serving configs
+        #     associated with the parent of the control this promotion is attached to.
+        #
+        #     This flag is used for basic site search only.
+        class SearchLinkPromotion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The industry vertical associated with the
         # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}.
         module IndustryVertical
@@ -162,6 +317,9 @@ module Google
           # It's used for Generative chat engine only, the associated data stores
           # must enrolled with `SOLUTION_TYPE_CHAT` solution.
           SOLUTION_TYPE_GENERATIVE_CHAT = 4
+
+          # Used for AI Mode.
+          SOLUTION_TYPE_AI_MODE = 5
         end
 
         # Defines a further subdivision of `SolutionType`.
@@ -201,6 +359,71 @@ module Google
           # Large language model add-on.
           SEARCH_ADD_ON_LLM = 1
         end
+
+        # Subscription tier information.
+        module SubscriptionTier
+          # Default value.
+          SUBSCRIPTION_TIER_UNSPECIFIED = 0
+
+          # Search tier.
+          # Search tier can access Vertex AI Search features and NotebookLM features.
+          SUBSCRIPTION_TIER_SEARCH = 1
+
+          # Gemini Enterprise Plus tier.
+          SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT = 2
+
+          # NotebookLM tier.
+          # NotebookLM is a subscription tier can only access NotebookLM features.
+          SUBSCRIPTION_TIER_NOTEBOOK_LM = 3
+
+          # Gemini Frontline worker tier.
+          SUBSCRIPTION_TIER_FRONTLINE_WORKER = 4
+
+          # Gemini Business Starter tier.
+          SUBSCRIPTION_TIER_AGENTSPACE_STARTER = 10
+
+          # Gemini Business tier.
+          SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS = 6
+
+          # Gemini Enterprise Standard tier.
+          SUBSCRIPTION_TIER_ENTERPRISE = 7
+
+          # Gemini Enterprise Standard tier for emerging markets.
+          SUBSCRIPTION_TIER_ENTERPRISE_EMERGING = 15
+
+          # Gemini Enterprise EDU tier.
+          SUBSCRIPTION_TIER_EDU = 8
+
+          # Gemini Enterprise EDU Pro tier.
+          SUBSCRIPTION_TIER_EDU_PRO = 9
+
+          # Gemini Enterprise EDU tier for emerging market only.
+          SUBSCRIPTION_TIER_EDU_EMERGING = 11
+
+          # Gemini Enterprise EDU Pro tier for emerging market.
+          SUBSCRIPTION_TIER_EDU_PRO_EMERGING = 12
+
+          # Gemini Frontline Starter tier.
+          SUBSCRIPTION_TIER_FRONTLINE_STARTER = 13
+        end
+
+        # Subscription term.
+        module SubscriptionTerm
+          # Default value, do not use.
+          SUBSCRIPTION_TERM_UNSPECIFIED = 0
+
+          # 1 month.
+          SUBSCRIPTION_TERM_ONE_MONTH = 1
+
+          # 1 year.
+          SUBSCRIPTION_TERM_ONE_YEAR = 2
+
+          # 3 years.
+          SUBSCRIPTION_TERM_THREE_YEARS = 3
+
+          # Custom term. Must set the end_date.
+          SUBSCRIPTION_TERM_CUSTOM = 6
+        end
       end
     end
   end