Discovery Engine v1 API - Class WidgetConfig.Types.UiSettings (1.17.0) 

public sealed class WidgetConfig.Types.UiSettings : IMessage<WidgetConfig.Types.UiSettings>, IEquatable<WidgetConfig.Types.UiSettings>, IDeepCloneable<WidgetConfig.Types.UiSettings>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class WidgetConfig.Types.UiSettings.

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

Inheritance

object > WidgetConfig.Types.UiSettings

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

UiSettings()

public UiSettings()

UiSettings(UiSettings)

public UiSettings(WidgetConfig.Types.UiSettings other)
Parameter
Name Description
other WidgetConfigTypesUiSettings

Properties

DataStoreUiConfigs

public RepeatedField<WidgetConfig.Types.DataStoreUiConfig> DataStoreUiConfigs { get; }

Per data store configuration.

Property Value
Type Description
RepeatedFieldWidgetConfigTypesDataStoreUiConfig

DefaultSearchRequestOrderBy

public string DefaultSearchRequestOrderBy { get; set; }

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

Property Value
Type Description
string

DisableUserEventsCollection

public bool DisableUserEventsCollection { get; set; }

If set to true, the widget will not collect user events.

Property Value
Type Description
bool

EnableAutocomplete

public bool EnableAutocomplete { get; set; }

Whether or not to enable autocomplete.

Property Value
Type Description
bool

EnableCreateAgentButton

public bool EnableCreateAgentButton { get; set; }

Optional. If set to true, the widget will enable the create agent button.

Property Value
Type Description
bool

EnablePeopleSearch

public bool EnablePeopleSearch { get; set; }

Optional. If set to true, the widget will enable people search.

Property Value
Type Description
bool

EnableQualityFeedback

public bool EnableQualityFeedback { get; set; }

Turn on or off collecting the search result quality feedback from end users.

Property Value
Type Description
bool

EnableSafeSearch

public bool EnableSafeSearch { get; set; }

Whether to enable safe search.

Property Value
Type Description
bool

EnableSearchAsYouType

public bool EnableSearchAsYouType { get; set; }

Whether to enable search-as-you-type behavior for the search widget.

Property Value
Type Description
bool

EnableVisualContentSummary

public bool EnableVisualContentSummary { get; set; }

If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

Property Value
Type Description
bool

Features

public MapField<string, WidgetConfig.Types.UiSettings.Types.FeatureState> Features { get; }

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
Property Value
Type Description
MapFieldstringWidgetConfigTypesUiSettingsTypesFeatureState

GenerativeAnswerConfig

public WidgetConfig.Types.UiSettings.Types.GenerativeAnswerConfig GenerativeAnswerConfig { get; set; }

Describes generative answer configuration.

Property Value
Type Description
WidgetConfigTypesUiSettingsTypesGenerativeAnswerConfig

GoogleDrivePickerEnabled

public bool GoogleDrivePickerEnabled { get; set; }

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.

Property Value
Type Description
bool

HasGoogleDrivePickerEnabled

public bool HasGoogleDrivePickerEnabled { get; }

Gets whether the "google_drive_picker_enabled" field is set

Property Value
Type Description
bool

HasOnedrivePickerEnabled

public bool HasOnedrivePickerEnabled { get; }

Gets whether the "onedrive_picker_enabled" field is set

Property Value
Type Description
bool

InteractionType

public WidgetConfig.Types.UiSettings.Types.InteractionType InteractionType { get; set; }

Describes widget (or web app) interaction type

Property Value
Type Description
WidgetConfigTypesUiSettingsTypesInteractionType

ModelConfigInfo

public WidgetConfig.Types.UiSettings.Types.ModelConfigInfo ModelConfigInfo { get; set; }

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.

Property Value
Type Description
WidgetConfigTypesUiSettingsTypesModelConfigInfo

ModelConfigs

public MapField<string, WidgetConfig.Types.UiSettings.Types.ModelState> ModelConfigs { get; }

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.

Property Value
Type Description
MapFieldstringWidgetConfigTypesUiSettingsTypesModelState

OnedrivePickerEnabled

public bool OnedrivePickerEnabled { get; set; }

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).

Property Value
Type Description
bool

ResultDescriptionType

public WidgetConfig.Types.ResultDisplayType ResultDescriptionType { get; set; }

Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.

Property Value
Type Description
WidgetConfigTypesResultDisplayType

SearchAddonSpec

public WidgetConfig.Types.UiSettings.Types.SearchAddonSpec SearchAddonSpec { get; set; }

Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.

Property Value
Type Description
WidgetConfigTypesUiSettingsTypesSearchAddonSpec

SourceAdminDisplayNameEnabled

public bool SourceAdminDisplayNameEnabled { get; set; }

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.

Property Value
Type Description
bool