WidgetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)WidgetConfig captures configs at the Widget level.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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.
|
display_name |
str
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. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the WidgetConfig was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the WidgetConfig was updated. |
data_store_type |
google.cloud.discoveryengine_v1.types.WidgetConfig.DataStoreType
Output only. The type of the parent data store. |
config_id |
str
Output only. Unique obfuscated identifier of a WidgetConfig. |
solution_type |
google.cloud.discoveryengine_v1.types.SolutionType
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
industry_vertical |
google.cloud.discoveryengine_v1.types.IndustryVertical
Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. |
llm_enabled |
bool
Output only. Whether LLM is enabled in the corresponding data store. |
enable_result_score |
bool
Whether to show the result score. |
minimum_data_term_accepted |
bool
Output only. Whether the customer accepted data use terms. |
collection_components |
MutableSequence[google.cloud.discoveryengine_v1.types.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).
|
ui_settings |
google.cloud.discoveryengine_v1.types.WidgetConfig.UiSettings
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
access_settings |
google.cloud.discoveryengine_v1.types.WidgetConfig.AccessSettings
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
ui_branding |
google.cloud.discoveryengine_v1.types.WidgetConfig.UiBrandingSettings
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
homepage_setting |
google.cloud.discoveryengine_v1.types.WidgetConfig.HomepageSetting
Optional. Describes the homepage settings of the widget. |
assistant_settings |
google.cloud.discoveryengine_v1.types.WidgetConfig.AssistantSettings
Optional. Output only. Describes the assistant settings of the widget. |
customer_provided_config |
google.cloud.discoveryengine_v1.types.WidgetConfig.CustomerProvidedConfig
Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. |
enable_private_knowledge_graph |
bool
Optional. Output only. Whether to enable private knowledge graph. |
gemini_bundle |
bool
Output only. Whether the subscription is gemini bundle or not. |
batch_auth_statuses |
MutableSequence[google.cloud.discoveryengine_v1.types.WidgetConfig.BatchAuthStatus]
Output only. The batch authorization statuses for the widget's connectors. |
nodes |
MutableSequence[google.cloud.discoveryengine_v1.types.WidgetConfig.Node]
Output only. The nodes associated with the Widget Config. |
Classes
AccessSettings
AccessSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes widget access settings.
AssistantSettings
AssistantSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes the assistant settings of the widget.
BatchAuthStatus
BatchAuthStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes the batch authorization status for a batch_authorization_group.
CollectionComponent
CollectionComponent(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
ConnectorAuthState
ConnectorAuthState(mapping=None, *, ignore_unknown_fields=False, **kwargs)Read-only connector in CollectionComponent auth state.
CustomerProvidedConfig
CustomerProvidedConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Customer provided configurations.
DataStoreComponent
DataStoreComponent(mapping=None, *, ignore_unknown_fields=False, **kwargs)Read-only data store component that contains data stores fields that
may be used for filtering, it's the child of
CollectionComponent.
DataStoreType
DataStoreType(value)The type of the widget's parent data store.
DataStoreUiConfig
DataStoreUiConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)UI component configuration for data store.
FacetField
FacetField(mapping=None, *, ignore_unknown_fields=False, **kwargs)Facet fields that store the mapping of fields to end user widget appearance.
HomepageSetting
HomepageSetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
Image
Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)Options to store an image.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Node
Node(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents a single reusable computational or logical unit.
ResultDisplayType
ResultDisplayType(value)The type of result to display in the ucs widget.
UIComponentField
UIComponentField(mapping=None, *, ignore_unknown_fields=False, **kwargs)Facet field that maps to a UI Component.
UiBrandingSettings
UiBrandingSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes widget UI branding settings.
UiSettings
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