google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

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

@@ -0,0 +1,1082 @@
+# 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 V1
+        # WidgetConfig captures configs at the Widget level.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The full resource name of the widget config.
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The human readable widget 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 [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1::WidgetConfig WidgetConfig} was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1::WidgetConfig WidgetConfig} was updated.
+        # @!attribute [r] data_store_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreType]
+        #     Output only. The type of the parent data store.
+        # @!attribute [r] config_id
+        #   @return [::String]
+        #     Output only. Unique obfuscated identifier of a
+        #     {::Google::Cloud::DiscoveryEngine::V1::WidgetConfig WidgetConfig}.
+        # @!attribute [rw] solution_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
+        #     Required. Immutable. Specifies the solution type that this WidgetConfig can
+        #     be used for.
+        # @!attribute [r] industry_vertical
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::IndustryVertical]
+        #     Output only. The industry vertical that the WidgetConfig registers.
+        #     The WidgetConfig industry vertical is based on the associated
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}.
+        # @!attribute [r] llm_enabled
+        #   @return [::Boolean]
+        #     Output only. Whether LLM is enabled in the corresponding data store.
+        # @!attribute [rw] enable_result_score
+        #   @return [::Boolean]
+        #     Whether to show the result score.
+        # @!attribute [r] minimum_data_term_accepted
+        #   @return [::Boolean]
+        #     Output only. Whether the customer accepted data use terms.
+        # @!attribute [r] collection_components
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CollectionComponent>]
+        #     Output only. Collection components that lists all collections and child
+        #     data stores associated with the widget config, those data sources can be
+        #     used for filtering in widget service APIs, users can return results that
+        #     from selected data sources.
+        #
+        #     For SaaS / Business engines, when `LookupWidgetConfig` is called with
+        #     `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented
+        #     with synthetic placeholder entries for connectors the caller may attach
+        #     but has not yet attached (see `CollectionComponent` for the placeholder
+        #     contract). The frontend can therefore render a unified list of
+        #     already-attached and available-to-attach sources by iterating this single
+        #     field. For Enterprise engines and for the default `view`, only
+        #     already-attached connectors are returned (today's behavior).
+        # @!attribute [rw] ui_settings
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings]
+        #     Describes general widget search settings as seen in cloud console
+        #     widget configuration page. Replaces top deprecated top level properties.
+        # @!attribute [rw] access_settings
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AccessSettings]
+        #     Will be used for all widget access settings seen in cloud console
+        #     integration page. Replaces top deprecated top level properties.
+        # @!attribute [rw] ui_branding
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiBrandingSettings]
+        #     Describes search widget UI branding settings, such as the widget title,
+        #     logo, favicons, and colors.
+        # @!attribute [rw] homepage_setting
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::HomepageSetting]
+        #     Optional. Describes the homepage settings of the widget.
+        # @!attribute [r] assistant_settings
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AssistantSettings]
+        #     Optional. Output only. Describes the assistant settings of the widget.
+        # @!attribute [r] customer_provided_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CustomerProvidedConfig]
+        #     Optional. Output only. Describes the customer related configurations,
+        #     currently only used for government customers. This field cannot be modified
+        #     after project onboarding.
+        # @!attribute [r] enable_private_knowledge_graph
+        #   @return [::Boolean]
+        #     Optional. Output only. Whether to enable private knowledge graph.
+        # @!attribute [r] gemini_bundle
+        #   @return [::Boolean]
+        #     Output only. Whether the subscription is gemini bundle or not.
+        # @!attribute [r] batch_auth_statuses
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::BatchAuthStatus>]
+        #     Output only. The batch authorization statuses for the widget's connectors.
+        # @!attribute [r] nodes
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::Node>]
+        #     Output only. The nodes associated with the Widget Config.
+        class WidgetConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Facet field that maps to a UI Component.
+          # @!attribute [rw] field
+          #   @return [::String]
+          #     Required. Registered field name. The format is `field.abc`.
+          # @!attribute [rw] device_visibility
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UIComponentField::DeviceVisibility>]
+          #     The field visibility on different types of devices.
+          # @!attribute [rw] display_template
+          #   @return [::String]
+          #     The template to customize how the field is displayed. An example value
+          #     would be a string that looks like: "Price: \\{value}".
+          class UIComponentField
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The visibility of the field on different type of devices.
+            module DeviceVisibility
+              # Default value when not specified. Server returns INVALID_ARGUMENT if
+              # used in requests.
+              DEVICE_VISIBILITY_UNSPECIFIED = 0
+
+              # The UI component is visible on Mobile devices.
+              MOBILE = 1
+
+              # The UI component is visible on Browser-based client.
+              DESKTOP = 2
+            end
+          end
+
+          # Facet fields that store the mapping of fields to end user widget
+          # appearance.
+          # @!attribute [rw] field
+          #   @return [::String]
+          #     Required. Registered field name. The format is `field.abc`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Optional. The field name that end users will see.
+          class FacetField
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # UI component configuration for data store.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the data store. It should be data store resource name
+          #     Format:
+          #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+          #     For APIs under
+          #     [WidgetService][google.cloud.discoveryengine.v1.WidgetService], such as
+          #     [WidgetService.LookupWidgetConfig][google.cloud.discoveryengine.v1.WidgetService.LookupWidgetConfig],
+          #     the project number and location part is erased in this field.
+          # @!attribute [r] id
+          #   @return [::String]
+          #     Output only. the identifier of the data store, used for widget service.
+          #     For now it refers to data_store_id, in the future we will migrate the
+          #     field to encrypted data store name UUID.
+          # @!attribute [rw] facet_field
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::FacetField>]
+          #     Facet fields that store the mapping of fields to end user widget
+          #     appearance.
+          # @!attribute [rw] fields_ui_components_map
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UIComponentField}]
+          #     The key is the UI component. Mock. Currently supported `title`,
+          #     `thumbnail`, `url`, `custom1`, `custom2`, `custom3`.
+          #
+          #     The value is the name of the field along with its device visibility.
+          #
+          #     The 3 custom fields are optional and can be added or removed. `title`,
+          #     `thumbnail`, `url` are required UI components that cannot be removed.
+          class DataStoreUiConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UIComponentField]
+            class FieldsUiComponentsMapEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Read-only data store component that contains data stores fields that may be
+          # used for filtering, it's the child of `CollectionComponent`.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the data store. It should be data store resource name
+          #     Format:
+          #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+          #     For APIs under
+          #     [WidgetService][google.cloud.discoveryengine.v1.WidgetService], such as
+          #     [WidgetService.LookupWidgetConfig][google.cloud.discoveryengine.v1.WidgetService.LookupWidgetConfig],
+          #     the project number and location part is erased in this field.
+          # @!attribute [r] id
+          #   @return [::String]
+          #     Output only. the identifier of the data store, used for widget service.
+          #     For now it refers to data_store_id, in the future we will migrate the
+          #     field to encrypted data store name UUID.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     The display name of the data store.
+          # @!attribute [rw] entity_name
+          #   @return [::String]
+          #     The name of the entity, retrieved from
+          #     `Collection.data_connector.entities.entityName`.
+          # @!attribute [r] data_store_config_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreComponent::DataStoreConfigType]
+          #     Output only. The type of the data store config.
+          class DataStoreComponent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the data store config.
+            module DataStoreConfigType
+              # Default value. This value is unused.
+              DATA_STORE_CONFIG_TYPE_UNSPECIFIED = 0
+
+              # The data store is connected to AlloyDB
+              ALLOW_DB_CONFIG = 1
+
+              # The data store is a connected to a third party data source.
+              THIRD_PARTY_OAUTH_CONFIG = 2
+
+              # The data store is a connected to NotebookLM Enterprise.
+              NOTEBOOKLM_CONFIG = 3
+            end
+          end
+
+          # Read-only connector in CollectionComponent auth state.
+          # @!attribute [r] auth_state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ConnectorAuthState::AuthState]
+          #     Output only. The authorization state of the data connector.
+          # @!attribute [r] authorization_uri
+          #   @return [::String]
+          #     Output only. The authorization uri for the data connector.
+          #
+          #     For synthetic placeholder `CollectionComponent` entries (returned by
+          #     `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS /
+          #     Business engines), this field is left empty. The widget should call
+          #     `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect"
+          #     click to obtain a freshly-built authorization URL.
+          # @!attribute [r] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The authorization state update timestamp.
+          class ConnectorAuthState
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The authorization state of the data connector.
+            module AuthState
+              # Default value. Also returned for synthetic placeholder
+              # `CollectionComponent` entries surfaced by
+              # `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS /
+              # Business only) — those entries represent connectors the caller may
+              # attach but has not yet attached.
+              AUTH_STATE_UNSPECIFIED = 0
+
+              # The user has authorized the data connector.
+              AUTHORIZED = 1
+
+              # The user authorization for the data connector has expired.
+              EXPIRED = 2
+
+              # The user can still make search requests but actions need to be enabled.
+              ACTIONS_DISABLED = 3
+
+              # The data connector does not require any authorization. Also used for
+              # placeholder entries whose underlying connector does not require user
+              # OAuth.
+              NO_AUTH = 4
+            end
+          end
+
+          # Describes the batch authorization status for a batch_authorization_group.
+          # @!attribute [r] placeholder
+          #   @return [::String]
+          #     Output only. It is the batch authorization group placeholder full
+          #     resource name. This is not a real data connector resource. E.g.
+          #     projects/\\{project}/locations/\\{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
+          # @!attribute [r] batch_authorization_group
+          #   @return [::String]
+          #     Output only. The batch authorization group the placeholder belongs to.
+          # @!attribute [r] connector_auth_state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ConnectorAuthState]
+          #     Output only. The current authorization state for this connector.
+          class BatchAuthStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Read-only collection component that contains data store collections fields
+          # that may be used for filtering.
+          #
+          # For SaaS / Business engines, when `LookupWidgetConfig` is called with
+          # `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also
+          # used to represent synthetic placeholder entries for connectors the caller
+          # may attach but has not yet attached. Placeholder entries have
+          # `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or
+          # `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the
+          # widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect"
+          # click), and synthetic placeholder values in `name` / `id` (see field
+          # comments). Fields that only make sense for materialized connectors
+          # (`data_store_components`, `tenant`, `action_connector`) are left unset
+          # for placeholder entries.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the collection. It should be collection resource name.
+          #     Format:
+          #     `projects/{project}/locations/{location}/collections/{collection_id}`.
+          #     For APIs under
+          #     [WidgetService][google.cloud.discoveryengine.v1.WidgetService], such as
+          #     [WidgetService.LookupWidgetConfig][google.cloud.discoveryengine.v1.WidgetService.LookupWidgetConfig],
+          #     the project number and location part is erased in this field.
+          #
+          #     For synthetic placeholder entries (see message-level comment) this
+          #     carries a synthetic placeholder collection id that does not correspond
+          #     to a real collection. Callers must not attempt to resolve / GET this
+          #     resource until the user authorizes the connector.
+          # @!attribute [r] id
+          #   @return [::String]
+          #     Output only. the identifier of the collection, used for widget service.
+          #     For now it refers to collection_id, in the future we will migrate the
+          #     field to encrypted collection name UUID.
+          #
+          #     For synthetic placeholder entries (see message-level comment) this is a
+          #     synthetic placeholder id, not a real collection_id.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     The display name of the collection.
+          # @!attribute [rw] data_store_components
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreComponent>]
+          #     For the data store collection, list of the children data stores.
+          # @!attribute [rw] data_source
+          #   @return [::String]
+          #     The name of the data source, retrieved from
+          #     `Collection.data_connector.data_source`.
+          # @!attribute [r] data_source_version
+          #   @return [::Float]
+          #     Output only. The version of the connector definition backing this
+          #     collection, mirroring `DataConnector.data_source_version`.
+          # @!attribute [r] data_source_display_name
+          #   @return [::String]
+          #     Output only. The display name of the data source.
+          # @!attribute [r] data_source_end_user_display_name
+          #   @return [::String]
+          #     Output only. The end-user-facing display name of the data source, sourced
+          #     from `ConnectorSource.end_user_display_name`. When unset, clients fall
+          #     back to `data_source_display_name`.
+          # @!attribute [r] connector_icon_link
+          #   @return [::String]
+          #     Output only. The icon link of the connector source.
+          # @!attribute [r] connector_auth_state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ConnectorAuthState]
+          #     Output only. The auth uri of the connector source.
+          # @!attribute [r] metadata
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMetadata]
+          #     Output only. User-facing connector metadata (`title`, `description`,
+          #     `short_description`, `author`, `note`), retrieved from the registry
+          #     `ConnectorSource.metadata` (joined by data source). Shown on the
+          #     connector detail page.
+          # @!attribute [r] is_first_party
+          #   @return [::Boolean]
+          #     Output only. Whether this is a first-party (Google-owned) connector, as
+          #     opposed to a third-party connector.
+          # @!attribute [r] tag
+          #   @return [::String]
+          #     Output only. The version-independent label of the connector backing this
+          #     collection, mirroring `DataConnector.tag`. Unlike the version-pinned data
+          #     store id it survives a connector version upgrade, so an upgraded
+          #     connector keeps the same tag.
+          #
+          #     Not a unique key. As `DataConnector.tag` documents, several connectors
+          #     may share a tag under the same (project, location, collection,
+          #     data_source), and tag-based lookup resolves to the one with the greatest
+          #     create_time. Clients must not treat this as a connector identifier.
+          #
+          #     Empty when the connector was created before the tag-write launch, and
+          #     for synthetic placeholder entries, which have no underlying
+          #     `DataConnector`. Populated only when
+          #     `ConnectorsFeature.enable_connector_tag` is on.
+          class CollectionComponent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes general widget (or web app) UI settings as seen
+          # in the cloud console UI configuration page.
+          # @!attribute [rw] interaction_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::InteractionType]
+          #     Describes widget (or web app) interaction type
+          # @!attribute [rw] generative_answer_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig]
+          #     Describes generative answer configuration.
+          # @!attribute [rw] result_description_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ResultDisplayType]
+          #     Controls whether result extract is display and how (snippet or
+          #     extractive answer). Default to no result if unspecified.
+          # @!attribute [rw] enable_autocomplete
+          #   @return [::Boolean]
+          #     Whether or not to enable autocomplete.
+          # @!attribute [rw] enable_safe_search
+          #   @return [::Boolean]
+          #     Whether to enable safe search.
+          # @!attribute [rw] enable_quality_feedback
+          #   @return [::Boolean]
+          #     Turn on or off collecting the search result quality feedback from end
+          #     users.
+          # @!attribute [rw] enable_search_as_you_type
+          #   @return [::Boolean]
+          #     Whether to enable search-as-you-type behavior for the search widget.
+          # @!attribute [rw] default_search_request_order_by
+          #   @return [::String]
+          #     The default ordering for search results if specified.
+          #
+          #     Used to set SearchRequest#order_by on applicable requests.
+          #     https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+          # @!attribute [rw] data_store_ui_configs
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreUiConfig>]
+          #     Per data store configuration.
+          # @!attribute [rw] disable_user_events_collection
+          #   @return [::Boolean]
+          #     If set to true, the widget will not collect user events.
+          # @!attribute [rw] enable_visual_content_summary
+          #   @return [::Boolean]
+          #     If set to true, the widget will enable visual content summary on
+          #     applicable search requests. Only used by healthcare search.
+          # @!attribute [rw] enable_people_search
+          #   @return [::Boolean]
+          #     Optional. If set to true, the widget will enable people search.
+          # @!attribute [rw] enable_create_agent_button
+          #   @return [::Boolean]
+          #     Optional. If set to true, the widget will enable the create agent button.
+          # @!attribute [r] features
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::FeatureState}]
+          #     Output only. Feature config for the engine to opt in or opt out of
+          #     features. Supported keys:
+          #
+          #     * `agent-gallery`
+          #     * `no-code-agent-builder`
+          #     * `prompt-gallery`
+          #     * `model-selector`
+          #     * `notebook-lm`
+          #     * `people-search`
+          #     * `people-search-org-chart`
+          #     * `bi-directional-audio`
+          #     * `speech-to-text`
+          #     * `feedback`
+          #     * `session-sharing`
+          #     * `personalization-memory`
+          #     * `personalization-suggested-highlights`
+          #     * `mobile-app-access`
+          #     * `disable-agent-sharing`
+          #     * `disable-image-generation`
+          #     * `disable-video-generation`
+          #     * `disable-onedrive-upload`
+          #     * `disable-talk-to-content`
+          #     * `disable-google-drive-upload`
+          #     * `disable-welcome-emails`
+          #     * `disable-canvas`
+          #     * `canvas-workspace`
+          #     * `canvas-app-builder`
+          #     * `skills`
+          #     * `skill-sharing`
+          #     * `skill-sharing-without-admin-approval`
+          #     * `disable-projects`
+          #     * `sobi`
+          #     * `enable-end-user-sharing-with-groups`
+          #     * `single-agent-orchestration`
+          #     * `multi-agent-orchestration`
+          #     * `cross-product-intelligence`
+          #     * `workflow-agents`
+          #     * `in-app-notifications`
+          #     * `code-extraction`
+          #     * `remote-vm`
+          #     * `license-tier-badge`
+          # @!attribute [r] model_configs
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelState}]
+          #     Output only. Maps a model name to its specific configuration for this
+          #     engine. This allows admin users to turn on/off individual models. This
+          #     only stores models whose states are overridden by the admin.
+          #
+          #     When the state is unspecified, or model_configs is empty for this
+          #     model, the system will decide if this model should be available or not
+          #     based on the default configuration. For example, a preview model
+          #     should be disabled by default if the admin has not chosen to enable it.
+          # @!attribute [rw] search_addon_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::SearchAddonSpec]
+          #     Optional. SearchAddonSpec is used to disable add-ons for search.
+          #     This field is only supported for search requests.
+          # @!attribute [r] onedrive_picker_enabled
+          #   @return [::Boolean]
+          #     Output only. Whether the OneDrive file picker is available to end-users.
+          #     Computed by the backend from admin connector enablement (Business
+          #     edition) or attached OneDrive connectors (Enterprise edition), combined
+          #     with the existing `disable-onedrive-upload` admin feature.
+          #
+          #     Declared `optional` so an explicitly-computed `false` is serialized with
+          #     field presence. A plain proto3 `bool` drops a default `false` on the
+          #     wire, which prevented clients from distinguishing "picker disabled"
+          #     (`false`) from "field not populated" (unset).
+          # @!attribute [r] google_drive_picker_enabled
+          #   @return [::Boolean]
+          #     Output only. Whether the Google Drive file picker is available to
+          #     end-users. Declared `optional` for the same field-presence reason as
+          #     `onedrive_picker_enabled` above.
+          # @!attribute [r] model_config_info
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelConfigInfo]
+          #     Output only. The resolved, server-side view of model selector
+          #     configuration. Holds both the ordered list of models that should appear
+          #     in the model selector dropdown and the model that should be selected by
+          #     default.
+          #
+          #     Clients should render this directly without applying their own
+          #     filtering, ordering, or localization. The legacy `model_configs` map
+          #     above is retained for backward compatibility with clients that have not
+          #     yet migrated to consuming this field.
+          # @!attribute [rw] source_admin_display_name_enabled
+          #   @return [::Boolean]
+          #     Optional. Whether to show the admin-configured display name for data
+          #     connectors in the widget sources UI (instead of the connector kind).
+          #     Opt-in; defaults to false.
+          class UiSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes configuration for generative answer.
+            # @!attribute [rw] result_count
+            #   @return [::Integer]
+            #     The number of top results to generate the answer from. Up to 10.
+            # @!attribute [rw] model_version
+            #   @return [::String]
+            #     The model version used to generate the answer.
+            # @!attribute [rw] model_prompt_preamble
+            #   @return [::String]
+            #     Text at the beginning of the prompt that instructs the model that
+            #     generates the answer.
+            # @!attribute [rw] max_rephrase_steps
+            #   @return [::Integer]
+            #     Max rephrase steps.
+            #     The max number is 5 steps.
+            #     If not set or set to < 1, it will be set to 1 by default.
+            # @!attribute [rw] language_code
+            #   @return [::String]
+            #     Language code for Summary. Use language tags defined by
+            #     [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
+            #     Note: This is an experimental feature.
+            # @!attribute [rw] disable_related_questions
+            #   @return [::Boolean]
+            #     Whether generated answer contains suggested related questions.
+            # @!attribute [rw] ignore_non_answer_seeking_query
+            #   @return [::Boolean]
+            #     Optional. Specifies whether to filter out queries that are not
+            #     answer-seeking. The default value is `false`.
+            #
+            #     No answer is returned if the search query is classified as a
+            #     non-answer seeking query. If this field is set to `true`, we skip
+            #     generating answers for non-answer seeking queries and return
+            #     fallback messages instead.
+            # @!attribute [rw] ignore_adversarial_query
+            #   @return [::Boolean]
+            #     Optional. Specifies whether to filter out queries that are adversarial.
+            # @!attribute [rw] ignore_low_relevant_content
+            #   @return [::Boolean]
+            #     Optional. Specifies whether to filter out queries that are not relevant
+            #     to the content.
+            # @!attribute [rw] image_source
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig::ImageSource]
+            #     Optional. Source of image returned in the answer.
+            class GenerativeAnswerConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Source of image returned in the answer.
+              module ImageSource
+                # Unspecified image source (multimodal feature is disabled by default)
+                IMAGE_SOURCE_UNSPECIFIED = 0
+
+                # Behavior when service determines the pick from all available sources.
+                ALL_AVAILABLE_SOURCES = 1
+
+                # Include image from corpus in the answer.
+                CORPUS_IMAGE_ONLY = 2
+
+                # Triggers figure generation in the answer.
+                FIGURE_GENERATION_ONLY = 3
+              end
+            end
+
+            # The resolved, server-side view of model selector configuration for the
+            # end-user. The backend computes this per-request by applying, in order:
+            # Mendel flag evaluation, regional availability rules based on the
+            # engine's location, and admin-panel overrides from `model_configs`.
+            #
+            # The backend is the single source of truth for this configuration;
+            # clients should render `resolved_models` directly in the model selector
+            # dropdown, in the order provided, without applying their own filtering,
+            # ordering, or localization.
+            # @!attribute [r] resolved_models
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelConfigInfo::ResolvedModel>]
+            #     Output only. The list of models that are available to the end-user in
+            #     the model selector, in the order in which they should be displayed.
+            # @!attribute [r] default_model_id
+            #   @return [::String]
+            #     Output only. The `model_id` of the model that should be selected by
+            #     default in the model selector when the end-user has not made an
+            #     explicit choice. The value is always one of the `model_id`s present in
+            #     `resolved_models`.
+            # @!attribute [r] auto_model_id
+            #   @return [::String]
+            #     Output only. The `model_id` a client must send when the end-user picks
+            #     the "Auto" entry (the empty `model_id`).
+            #
+            #     Populated only for surfaces known to have no true "Auto" mode, where
+            #     leaving the model unset would fall back to a platform default rather
+            #     than a backend-chosen model. Empty on every other surface, where
+            #     "Auto" is resolved server-side, and when none of the surface's ranked
+            #     models is available. When set, it is always one of the non-empty
+            #     `model_id`s present in `resolved_models`.
+            class ModelConfigInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # A single model that is resolved to be available to the end-user in the
+              # model selector, with all of its localized display metadata.
+              # @!attribute [r] model_id
+              #   @return [::String]
+              #     Output only. Unique identifier of the model
+              #     (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`).
+              #
+              #     This is the same identifier that clients pass back to the assistant
+              #     service to select this model. Virtual / "pseudo" models (e.g.
+              #     `gemini-fast`) are also valid values here; they are resolved to the
+              #     underlying concrete model on the backend.
+              # @!attribute [r] display_name
+              #   @return [::String]
+              #     Output only. Localized display name of the model (e.g. `Gemini 3.1
+              #     Pro`). Localized server-side based on the
+              #     [LookupWidgetConfigRequest.language_code][google.cloud.discoveryengine.v1.LookupWidgetConfigRequest.language_code]
+              #     and
+              #     [LookupWidgetConfigRequest.region_code][google.cloud.discoveryengine.v1.LookupWidgetConfigRequest.region_code]
+              #     of the request.
+              # @!attribute [r] icon
+              #   @return [::String]
+              #     Output only. GM3-compatible icon token associated with the model
+              #     (e.g. `rocket_launch`, `bolt`, `graph_5`).
+              # @!attribute [r] description
+              #   @return [::String]
+              #     Output only. Localized description text (e.g. `State-of-the-art
+              #     reasoning`). Localized using the same locale as `display_name`.
+              # @!attribute [r] is_preview
+              #   @return [::Boolean]
+              #     Output only. Whether the model is currently in preview. Clients
+              #     should surface this via a "Preview" badge in the selector UI.
+              # @!attribute [r] label
+              #   @return [::String]
+              #     Output only. Short label shown in the compact selector bar chip (e.g.
+              #     `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x
+              #     Flash`). Falls back to `display_name` when the backend registry does
+              #     not specify a distinct short label.
+              # @!attribute [r] admin_view
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelConfigInfo::ResolvedModel::AdminView]
+              #     Output only. Admin-surface metadata; populated only for the Console
+              #     admin Feature Control page (see `AdminView`). Unset for end-user
+              #     surfaces.
+              # @!attribute [r] promoted
+              #   @return [::Boolean]
+              #     Output only. Whether this model should be promoted in the GE chat
+              #     homepage banner.
+              # @!attribute [r] icon_url
+              #   @return [::String]
+              #     Output only. Absolute URL of a brand mark to render instead of
+              #     `icon`, for models whose vendor logo is not a GM3 glyph.
+              #
+              #     `icon` stays populated as the fallback, so a client that does not
+              #     render images, or that fails to fetch this one, shows the glyph
+              #     instead of nothing.
+              # @!attribute [r] family
+              #   @return [::String]
+              #     Output only. Groups models that render together in the selector.
+              #     Models sharing a value form one group; empty means the model belongs
+              #     to no group.
+              #
+              #     Compared for equality only -- never parsed, and never shown to a
+              #     user, so it is not localized.
+              class ResolvedModel
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Admin-surface metadata. Populated only when the request originates
+                # from the Cloud Console admin "Feature Control" page; left unset for
+                # end-user surfaces (Web, Mobile). Lets the admin page render its
+                # toggle table directly from the backend instead of a hardcoded
+                # client-side registry.
+                # @!attribute [r] admin_overridable
+                #   @return [::Boolean]
+                #     Output only. Whether the admin can toggle this model's
+                #     enabled/disabled state via `UiSettings.model_configs`. Derived from
+                #     `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced"
+                #     and its state is governed by `enabled_by_default`.
+                # @!attribute [r] enabled_by_default
+                #   @return [::Boolean]
+                #     Output only. Whether the model is enabled when the admin has set no
+                #     explicit override in `UiSettings.model_configs`. Derived from
+                #     `MODEL_TAG_ENABLED_BY_DEFAULT`.
+                # @!attribute [r] regions
+                #   @return [::Array<::String>]
+                #     Output only. Regions where this model is launched.
+                class AdminView
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+              end
+            end
+
+            # SearchAddonSpec is used to disable add-ons for search. By default, if
+            # this field is not specified, add-ons are enabled wherever applicable.
+            # @!attribute [rw] semantic_add_on_disabled
+            #   @return [::Boolean]
+            #     Optional. If true, semantic add-on is disabled. Semantic add-on
+            #     includes embeddings and jetstream.
+            # @!attribute [rw] kpi_personalization_add_on_disabled
+            #   @return [::Boolean]
+            #     Optional. If true, disables event re-ranking and personalization to
+            #     optimize KPIs & personalize results.
+            # @!attribute [rw] generative_answer_add_on_disabled
+            #   @return [::Boolean]
+            #     Optional. If true, generative answer add-on is disabled. Generative
+            #     answer add-on includes natural language to filters and simple answers.
+            class SearchAddonSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::FeatureState]
+            class FeaturesEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelState]
+            class ModelConfigsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Describes interaction type.
+            module InteractionType
+              # Not specified. Defaults to SEARCH_ONLY.
+              INTERACTION_TYPE_UNSPECIFIED = 0
+
+              # Search without a generative answer.
+              SEARCH_ONLY = 1
+
+              # Search with the generative answer.
+              SEARCH_WITH_ANSWER = 2
+
+              # Search with the generative answer that supports follow up questions.
+              # Also known as multi-turn search.
+              SEARCH_WITH_FOLLOW_UPS = 3
+            end
+
+            # The state of the feature for the engine.
+            module FeatureState
+              # The feature state is unspecified.
+              FEATURE_STATE_UNSPECIFIED = 0
+
+              # The feature is turned on to be accessible.
+              FEATURE_STATE_ON = 1
+
+              # The feature is turned off to be inaccessible.
+              FEATURE_STATE_OFF = 2
+            end
+
+            # The state of the model for the engine.
+            module ModelState
+              # The model state is unspecified.
+              MODEL_STATE_UNSPECIFIED = 0
+
+              # The model is enabled by admin.
+              MODEL_ENABLED = 1
+
+              # The model is disabled by admin.
+              MODEL_DISABLED = 2
+            end
+          end
+
+          # Describes widget access settings.
+          # @!attribute [rw] allow_public_access
+          #   @return [::Boolean]
+          #     Whether public unauthenticated access is allowed.
+          # @!attribute [rw] allowlisted_domains
+          #   @return [::Array<::String>]
+          #     List of domains that are allowed to integrate the search widget.
+          # @!attribute [rw] enable_web_app
+          #   @return [::Boolean]
+          #     Whether web app access is enabled.
+          # @!attribute [rw] workforce_identity_pool_provider
+          #   @return [::String]
+          #     Optional. The workforce identity pool provider used to access the widget.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Optional. Language code for user interface. Use language tags defined by
+          #     [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
+          #     If unset, the default language code is "en-US".
+          class AccessSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Options to store an image.
+          # @!attribute [rw] url
+          #   @return [::String]
+          #     Image URL.
+          class Image
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes widget UI branding settings.
+          # @!attribute [rw] logo
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::Image]
+          #     Logo image.
+          class UiBrandingSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the homepage setting of the widget. It includes all homepage
+          # related settings and configurations, such as shortcuts.
+          # @!attribute [rw] shortcuts
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::HomepageSetting::Shortcut>]
+          #     Optional. The shortcuts to display on the homepage.
+          class HomepageSetting
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes an entity of shortcut (aka pinned content) on the homepage.
+            # The home page will render these shortcuts in the same order as what the
+            # API returns. If a customer wants to reorder or remove a shortcut, the UI
+            # should always provide the new full list of shortcuts.
+            # @!attribute [rw] title
+            #   @return [::String]
+            #     Optional. Title of the shortcut.
+            # @!attribute [rw] icon
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::Image]
+            #     Optional. Icon URL of shortcut.
+            # @!attribute [rw] destination_uri
+            #   @return [::String]
+            #     Optional. Destination URL of shortcut.
+            class Shortcut
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Describes the assistant settings of the widget.
+          # @!attribute [rw] web_grounding_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AssistantSettings::WebGroundingType]
+          #     Optional. The type of web grounding to use.
+          # @!attribute [r] default_web_grounding_toggle_off
+          #   @return [::Boolean]
+          #     Output only. This field controls the default web grounding toggle for end
+          #     users if `web_grounding_type` is set to
+          #     `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or
+          #     `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`.
+          #     By default, this field is set to false. If `web_grounding_type` is
+          #     `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or
+          #     `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web
+          #     grounding enabled by default on UI. If true, grounding toggle will be
+          #     disabled by default on UI. End users can still enable web grounding in
+          #     the UI if web grounding is enabled.
+          # @!attribute [r] disable_location_context
+          #   @return [::Boolean]
+          #     Optional. Output only. Whether to disable user location context.
+          class AssistantSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of web grounding to use.
+            module WebGroundingType
+              # Default, unspecified setting. This is the same as disabled.
+              WEB_GROUNDING_TYPE_UNSPECIFIED = 0
+
+              # Web grounding is disabled.
+              WEB_GROUNDING_TYPE_DISABLED = 1
+
+              # Grounding with Google Search is enabled.
+              WEB_GROUNDING_TYPE_GOOGLE_SEARCH = 2
+
+              # Grounding with Enterprise Web Search is enabled.
+              WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH = 3
+            end
+          end
+
+          # Customer provided configurations.
+          # @!attribute [rw] customer_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CustomerProvidedConfig::CustomerType]
+          #     Customer type.
+          # @!attribute [r] compliance_level
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CustomerProvidedConfig::ComplianceLevel]
+          #     Output only. The customer's Assured Workloads compliance level.
+          #
+          #     `customer_type` collapses every compliance level into a single
+          #     `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one
+          #     specific level rather than on government status as a whole must read
+          #     this field instead.
+          class CustomerProvidedConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Customer type.
+            module CustomerType
+              # Default customer type.
+              DEFAULT_CUSTOMER = 0
+
+              # Government customer type. Some features are disabled for government
+              # customers due to legal requirements.
+              GOVERNMENT_CUSTOMER = 1
+            end
+
+            # Assured Workloads compliance level of the customer's project.
+            #
+            # Not frozen: further levels may be added as more compliance regimes are
+            # supported, so a client must treat an unrecognized value as
+            # government-restricted rather than as unrestricted.
+            module ComplianceLevel
+              # The project has no Assured Workloads compliance level, or reports one
+              # that this API version does not model.
+              COMPLIANCE_LEVEL_UNSPECIFIED = 0
+
+              # FedRAMP High compliance level.
+              COMPLIANCE_LEVEL_FEDRAMP_HIGH = 1
+
+              # Impact Level 4 (IL4) compliance level.
+              COMPLIANCE_LEVEL_IL4 = 2
+
+              # Impact Level 5 (IL5) compliance level.
+              COMPLIANCE_LEVEL_IL5 = 3
+            end
+          end
+
+          # Represents a single reusable computational or logical unit.
+          # @!attribute [r] display_name
+          #   @return [::String]
+          #     Output only. A human readable name for the node.
+          # @!attribute [r] icon_url
+          #   @return [::String]
+          #     Output only. An identifier or URL pointing to an icon representing this
+          #     node type.
+          # @!attribute [r] description
+          #   @return [::String]
+          #     Output only. A detailed description of what the node does.
+          # @!attribute [r] parameter_schema
+          #   @return [::Google::Protobuf::Struct]
+          #     Output only. The parameter schema of the tool.
+          #
+          #     This schema is expected to conform to the OpenAPI Schema standard (see
+          #     https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the
+          #     expected structure of the parameters that this node accepts.
+          # @!attribute [r] output_schema
+          #   @return [::Google::Protobuf::Struct]
+          #     Output only. The output schema of the tool.
+          #
+          #     This schema is expected to conform to the OpenAPI Schema standard (see
+          #     https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the
+          #     structure of the output produced by this node.
+          # @!attribute [r] type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::Node::Type]
+          #     Output only. The type of the node.
+          class Node
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Identifies the type of the node in the agent flow.
+            module Type
+              # Unspecified type.
+              TYPE_UNSPECIFIED = 0
+
+              # Trigger type.
+              TRIGGER = 1
+
+              # Flow type.
+              FLOW = 2
+
+              # Connector type.
+              CONNECTOR = 3
+            end
+          end
+
+          # The type of the widget's parent data store.
+          module DataStoreType
+            # Unspecified data store type.
+            DATA_STORE_TYPE_UNSPECIFIED = 0
+
+            # The parent data store contains a site search engine.
+            SITE_SEARCH = 1
+
+            # The parent data store contains a search engine for structured data.
+            STRUCTURED = 2
+
+            # The parent data store contains a search engine for unstructured data.
+            UNSTRUCTURED = 3
+
+            # The parent data store is served for blended search with multiple data
+            # stores.
+            BLENDED = 4
+          end
+
+          # The type of result to display in the ucs widget.
+          module ResultDisplayType
+            # Unspecified display type (default to showing snippet).
+            RESULT_DISPLAY_TYPE_UNSPECIFIED = 0
+
+            # Display results from the snippet field.
+            SNIPPET = 1
+
+            # Display results from extractive answers field.
+            EXTRACTIVE_ANSWER = 2
+          end
+        end
+
+        # Selects which "view" of the model selector configuration the backend
+        # computes for `WidgetConfig.UiSettings.ModelConfigInfo`.
+        #
+        # The end-user views (`END_USER_WEB`, `END_USER_MOBILE`) return the
+        # user-facing model selector for their respective surface; the `ADMIN` view
+        # returns the set surfaced on the Cloud Console admin "Feature Control" page,
+        # with `ModelConfigInfo.ResolvedModel.admin_view` populated on each entry.
+        module ModelInfoView
+          # Not specified.
+          MODEL_INFO_VIEW_UNSPECIFIED = 0
+
+          # The end-user web model selector view.
+          END_USER_WEB = 1
+
+          # The Cloud Console admin "Feature Control" view that displays model toggles.
+          # Returns admin-surfaced models with `ResolvedModel.admin_view` populated.
+          ADMIN = 2
+
+          # The end-user model selector view for the Gemini Enterprise mobile app.
+          # Returns only mobile-surfaced models, with the mobile default selected.
+          # Set explicitly by the mobile client.
+          END_USER_MOBILE = 3
+        end
+      end
+    end
+  end
+end