Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings.

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_store_ui_configs

def data_store_ui_configs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreUiConfig>
Returns

#data_store_ui_configs=

def data_store_ui_configs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreUiConfig>
Parameter
Returns

#default_search_request_order_by

def default_search_request_order_by() -> ::String
Returns
  • (::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

#default_search_request_order_by=

def default_search_request_order_by=(value) -> ::String
Parameter
  • value (::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

Returns
  • (::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

#disable_user_events_collection

def disable_user_events_collection() -> ::Boolean
Returns
  • (::Boolean) — If set to true, the widget will not collect user events.

#disable_user_events_collection=

def disable_user_events_collection=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, the widget will not collect user events.
Returns
  • (::Boolean) — If set to true, the widget will not collect user events.

#enable_autocomplete

def enable_autocomplete() -> ::Boolean
Returns
  • (::Boolean) — Whether or not to enable autocomplete.

#enable_autocomplete=

def enable_autocomplete=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether or not to enable autocomplete.
Returns
  • (::Boolean) — Whether or not to enable autocomplete.

#enable_create_agent_button

def enable_create_agent_button() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, the widget will enable the create agent button.

#enable_create_agent_button=

def enable_create_agent_button=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, the widget will enable the create agent button.
Returns
  • (::Boolean) — Optional. If set to true, the widget will enable the create agent button.

#enable_people_search

def enable_people_search() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, the widget will enable people search.

#enable_people_search=

def enable_people_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, the widget will enable people search.
Returns
  • (::Boolean) — Optional. If set to true, the widget will enable people search.

#enable_quality_feedback

def enable_quality_feedback() -> ::Boolean
Returns
  • (::Boolean) — Turn on or off collecting the search result quality feedback from end users.

#enable_quality_feedback=

def enable_quality_feedback=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Turn on or off collecting the search result quality feedback from end users.
Returns
  • (::Boolean) — Turn on or off collecting the search result quality feedback from end users.

#enable_safe_search

def enable_safe_search() -> ::Boolean
Returns
  • (::Boolean) — Whether to enable safe search.

#enable_safe_search=

def enable_safe_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to enable safe search.
Returns
  • (::Boolean) — Whether to enable safe search.

#enable_search_as_you_type

def enable_search_as_you_type() -> ::Boolean
Returns
  • (::Boolean) — Whether to enable search-as-you-type behavior for the search widget.

#enable_search_as_you_type=

def enable_search_as_you_type=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to enable search-as-you-type behavior for the search widget.
Returns
  • (::Boolean) — Whether to enable search-as-you-type behavior for the search widget.

#enable_visual_content_summary

def enable_visual_content_summary() -> ::Boolean
Returns
  • (::Boolean) — If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

#enable_visual_content_summary=

def enable_visual_content_summary=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
Returns
  • (::Boolean) — If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

#features

def features() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::FeatureState}
Returns
  • (::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

#generative_answer_config

def generative_answer_config() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig
Returns

#generative_answer_config=

def generative_answer_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig
Parameter
Returns

#google_drive_picker_enabled

def google_drive_picker_enabled() -> ::Boolean
Returns
  • (::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.

#interaction_type

def interaction_type() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::InteractionType
Returns

#interaction_type=

def interaction_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::InteractionType
Parameter
Returns

#model_config_info

def model_config_info() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelConfigInfo
Returns
  • (::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.

#model_configs

def model_configs() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::ModelState}
Returns
  • (::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.

#onedrive_picker_enabled

def onedrive_picker_enabled() -> ::Boolean
Returns
  • (::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).

#result_description_type

def result_description_type() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ResultDisplayType
Returns

#result_description_type=

def result_description_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ResultDisplayType
Parameter
Returns

#search_addon_spec

def search_addon_spec() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::SearchAddonSpec
Returns

#search_addon_spec=

def search_addon_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::SearchAddonSpec
Parameter
Returns

#source_admin_display_name_enabled

def source_admin_display_name_enabled() -> ::Boolean
Returns
  • (::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.

#source_admin_display_name_enabled=

def source_admin_display_name_enabled=(value) -> ::Boolean
Parameter
  • value (::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.
Returns
  • (::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.