Discovery Engine v1 API - Class WidgetConfig (1.17.0)

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

WidgetConfig captures configs at the Widget level.

Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.

Optional. Output only. Describes the assistant settings of the widget.

Output only. The batch authorization statuses for the widget's connectors.

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

Output only. Unique obfuscated identifier of a [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig].

Output only. Timestamp the [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig] was created.

Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.

Output only. The type of the parent data store.

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.

Optional. Output only. Whether to enable private knowledge graph.

Whether to show the result score.

Output only. Whether the subscription is gemini bundle or not.

Optional. Describes the homepage settings of the widget.

Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated [Engine][google.cloud.discoveryengine.v1.Engine].

Output only. Whether LLM is enabled in the corresponding data store.

Output only. Whether the customer accepted data use terms.

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.

Output only. The nodes associated with the Widget Config.

Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.

Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.

Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.

Output only. Timestamp the [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig] was updated.

WidgetConfigName-typed view over the Name resource name property.