Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UiSettings.
Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.UiSettings
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ interaction_type |
int
Describes widget (or web app) interaction type |
↳ generative_answer_config |
UiSettings\GenerativeAnswerConfig
Describes generative answer configuration. |
↳ result_description_type |
int
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 |
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 |
↳ data_store_ui_configs |
array<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 |
array|Google\Protobuf\Internal\MapField
Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * * |
↳ model_configs |
array|Google\Protobuf\Internal\MapField
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 |
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 |
↳ google_drive_picker_enabled |
bool
Output only. Whether the Google Drive file picker is available to end-users. Declared |
↳ model_config_info |
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 |
↳ 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. |
getInteractionType
Describes widget (or web app) interaction type
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type InteractionType. |
setInteractionType
Describes widget (or web app) interaction type
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type InteractionType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGenerativeAnswerConfig
Describes generative answer configuration.
| Returns | |
|---|---|
| Type | Description |
UiSettings\GenerativeAnswerConfig|null |
|
hasGenerativeAnswerConfig
clearGenerativeAnswerConfig
setGenerativeAnswerConfig
Describes generative answer configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
UiSettings\GenerativeAnswerConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResultDescriptionType
Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ResultDisplayType. |
setResultDescriptionType
Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ResultDisplayType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableAutocomplete
Whether or not to enable autocomplete.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableAutocomplete
Whether or not to enable autocomplete.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableSafeSearch
Whether to enable safe search.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableSafeSearch
Whether to enable safe search.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableQualityFeedback
Turn on or off collecting the search result quality feedback from end users.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableQualityFeedback
Turn on or off collecting the search result quality feedback from end users.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableSearchAsYouType
Whether to enable search-as-you-type behavior for the search widget.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableSearchAsYouType
Whether to enable search-as-you-type behavior for the search widget.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultSearchRequestOrderBy
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 | |
|---|---|
| Type | Description |
string |
|
setDefaultSearchRequestOrderBy
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataStoreUiConfigs
Per data store configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<DataStoreUiConfig> |
|
setDataStoreUiConfigs
Per data store configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataStoreUiConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableUserEventsCollection
If set to true, the widget will not collect user events.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableUserEventsCollection
If set to true, the widget will not collect user events.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableVisualContentSummary
If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableVisualContentSummary
If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnablePeopleSearch
Optional. If set to true, the widget will enable people search.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnablePeopleSearch
Optional. If set to true, the widget will enable people search.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableCreateAgentButton
Optional. If set to true, the widget will enable the create agent button.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableCreateAgentButton
Optional. If set to true, the widget will enable the create agent button.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFeatures
Output only. Feature config for the engine to opt in or opt out of features. Supported keys:
agent-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiospeech-to-textfeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvascanvas-workspacecanvas-app-builderskillsskill-sharingskill-sharing-without-admin-approvaldisable-projectssobienable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligenceworkflow-agentsin-app-notificationscode-extractionremote-vmlicense-tier-badge
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setFeatures
Output only. Feature config for the engine to opt in or opt out of features. Supported keys:
agent-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiospeech-to-textfeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvascanvas-workspacecanvas-app-builderskillsskill-sharingskill-sharing-without-admin-approvaldisable-projectssobienable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligenceworkflow-agentsin-app-notificationscode-extractionremote-vmlicense-tier-badge
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModelConfigs
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setModelConfigs
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchAddonSpec
Optional. SearchAddonSpec is used to disable add-ons for search.
This field is only supported for search requests.
| Returns | |
|---|---|
| Type | Description |
UiSettings\SearchAddonSpec|null |
|
hasSearchAddonSpec
clearSearchAddonSpec
setSearchAddonSpec
Optional. SearchAddonSpec is used to disable add-ons for search.
This field is only supported for search requests.
| Parameter | |
|---|---|
| Name | Description |
var |
UiSettings\SearchAddonSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOnedrivePickerEnabled
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).
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasOnedrivePickerEnabled
clearOnedrivePickerEnabled
setOnedrivePickerEnabled
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).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGoogleDrivePickerEnabled
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasGoogleDrivePickerEnabled
clearGoogleDrivePickerEnabled
setGoogleDrivePickerEnabled
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModelConfigInfo
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.
| Returns | |
|---|---|
| Type | Description |
UiSettings\ModelConfigInfo|null |
|
hasModelConfigInfo
clearModelConfigInfo
setModelConfigInfo
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.
| Parameter | |
|---|---|
| Name | Description |
var |
UiSettings\ModelConfigInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceAdminDisplayNameEnabled
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 | |
|---|---|
| Type | Description |
bool |
|
setSourceAdminDisplayNameEnabled
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|