Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WidgetConfig (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WidgetConfig.

WidgetConfig captures configs at the Widget level.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access_settings

def access_settings() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AccessSettings
Returns

#access_settings=

def access_settings=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AccessSettings
Parameter
Returns

#assistant_settings

def assistant_settings() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::AssistantSettings
Returns

#batch_auth_statuses

def batch_auth_statuses() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::BatchAuthStatus>
Returns

#collection_components

def collection_components() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CollectionComponent>
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::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).

#config_id

def config_id() -> ::String
Returns
  • (::String) — Output only. Unique obfuscated identifier of a WidgetConfig.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#customer_provided_config

def customer_provided_config() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CustomerProvidedConfig
Returns

#data_store_type

def data_store_type() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreType
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — 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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#enable_private_knowledge_graph

def enable_private_knowledge_graph() -> ::Boolean
Returns
  • (::Boolean) — Optional. Output only. Whether to enable private knowledge graph.

#enable_result_score

def enable_result_score() -> ::Boolean
Returns
  • (::Boolean) — Whether to show the result score.

#enable_result_score=

def enable_result_score=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to show the result score.
Returns
  • (::Boolean) — Whether to show the result score.

#gemini_bundle

def gemini_bundle() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether the subscription is gemini bundle or not.

#homepage_setting

def homepage_setting() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::HomepageSetting
Returns

#homepage_setting=

def homepage_setting=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::HomepageSetting
Parameter
Returns

#industry_vertical

def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical
Returns

#llm_enabled

def llm_enabled() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether LLM is enabled in the corresponding data store.

#minimum_data_term_accepted

def minimum_data_term_accepted() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether the customer accepted data use terms.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#nodes

def nodes() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::Node>
Returns

#solution_type

def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1::SolutionType
Returns

#solution_type=

def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SolutionType
Parameter
Returns

#ui_branding

def ui_branding() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiBrandingSettings
Returns

#ui_branding=

def ui_branding=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiBrandingSettings
Parameter
Returns

#ui_settings

def ui_settings() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings
Returns

#ui_settings=

def ui_settings=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns