UiSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
interaction_type |
google.cloud.discoveryengine_v1.types.WidgetConfig.UiSettings.InteractionType
Describes widget (or web app) interaction type |
generative_answer_config |
google.cloud.discoveryengine_v1.types.WidgetConfig.UiSettings.GenerativeAnswerConfig
Describes generative answer configuration. |
result_description_type |
google.cloud.discoveryengine_v1.types.WidgetConfig.ResultDisplayType
Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. |
enable_autocomplete |
bool
Whether or not to enable autocomplete. |
enable_safe_search |
bool
Whether to enable safe search. |
enable_quality_feedback |
bool
Turn on or off collecting the search result quality feedback from end users. |
enable_search_as_you_type |
bool
Whether to enable search-as-you-type behavior for the search widget. |
default_search_request_order_by |
str
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 |
data_store_ui_configs |
MutableSequence[google.cloud.discoveryengine_v1.types.WidgetConfig.DataStoreUiConfig]
Per data store configuration. |
disable_user_events_collection |
bool
If set to true, the widget will not collect user events. |
enable_visual_content_summary |
bool
If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. |
enable_people_search |
bool
Optional. If set to true, the widget will enable people search. |
enable_create_agent_button |
bool
Optional. If set to true, the widget will enable the create agent button. |
features |
MutableMapping[str, google.cloud.discoveryengine_v1.types.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
|
model_configs |
MutableMapping[str, google.cloud.discoveryengine_v1.types.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. |
search_addon_spec |
google.cloud.discoveryengine_v1.types.WidgetConfig.UiSettings.SearchAddonSpec
Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. |
onedrive_picker_enabled |
bool
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).
This field is a member of oneof_ _onedrive_picker_enabled.
|
google_drive_picker_enabled |
bool
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.
This field is a member of oneof_ _google_drive_picker_enabled.
|
model_config_info |
google.cloud.discoveryengine_v1.types.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.
|
source_admin_display_name_enabled |
bool
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. |
Classes
FeatureState
FeatureState(value)The state of the feature for the engine.
FeaturesEntry
FeaturesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
GenerativeAnswerConfig
GenerativeAnswerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes configuration for generative answer.
InteractionType
InteractionType(value)Describes interaction type.
ModelConfigInfo
ModelConfigInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
ModelConfigsEntry
ModelConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
ModelState
ModelState(value)The state of the model for the engine.
SearchAddonSpec
SearchAddonSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.