Class GoogleCloudDiscoveryengineV1alphaWidgetConfig

WidgetConfig captures configs at the Widget level.

Inheritance

object

GoogleCloudDiscoveryengineV1alphaWidgetConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class GoogleCloudDiscoveryengineV1alphaWidgetConfig : IDirectResponseSchema

Properties

AccessSettings

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

Declaration

[JsonProperty("accessSettings")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings AccessSettings { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings

AllowPublicAccess

Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.

Declaration

[JsonProperty("allowPublicAccess")]
public virtual bool? AllowPublicAccess { get; set; }

Property Value

Type	Description
bool?

AllowlistedDomains

Allowlisted domains that can load this widget.

Declaration

[JsonProperty("allowlistedDomains")]
public virtual IList<string> AllowlistedDomains { get; set; }

Property Value

Type	Description
IList<string>

AssistantSettings

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

Declaration

[JsonProperty("assistantSettings")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings AssistantSettings { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings

CollectionComponents

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.

Declaration

[JsonProperty("collectionComponents")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent> CollectionComponents { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent>

ConfigId

Output only. Unique obfuscated identifier of a WidgetConfig.

Declaration

[JsonProperty("configId")]
public virtual string ConfigId { get; set; }

Property Value

Type	Description
string

ContentSearchSpec

The content search spec that configs the desired behavior of content search.

Declaration

[JsonProperty("contentSearchSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec ContentSearchSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp the WidgetConfig was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

CustomerProvidedConfig

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

Declaration

[JsonProperty("customerProvidedConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig CustomerProvidedConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig

DataStoreType

Output only. The type of the parent data store.

Declaration

[JsonProperty("dataStoreType")]
public virtual string DataStoreType { get; set; }

Property Value

Type	Description
string

DataStoreUiConfigs

Configurable UI configurations per data store.

Declaration

[JsonProperty("dataStoreUiConfigs")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig> DataStoreUiConfigs { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig>

DefaultSearchRequestOrderBy

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

Declaration

[JsonProperty("defaultSearchRequestOrderBy")]
public virtual string DefaultSearchRequestOrderBy { get; set; }

Property Value

Type	Description
string

DisplayName

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.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnableAutocomplete

Whether or not to enable autocomplete.

Declaration

[JsonProperty("enableAutocomplete")]
public virtual bool? EnableAutocomplete { get; set; }

Property Value

Type	Description
bool?

EnableConversationalSearch

Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).

Declaration

[JsonProperty("enableConversationalSearch")]
public virtual bool? EnableConversationalSearch { get; set; }

Property Value

Type	Description
bool?

EnablePrivateKnowledgeGraph

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

Declaration

[JsonProperty("enablePrivateKnowledgeGraph")]
public virtual bool? EnablePrivateKnowledgeGraph { get; set; }

Property Value

Type	Description
bool?

EnableQualityFeedback

Turn on or off collecting the search result quality feedback from end users.

Declaration

[JsonProperty("enableQualityFeedback")]
public virtual bool? EnableQualityFeedback { get; set; }

Property Value

Type	Description
bool?

EnableResultScore

Whether to show the result score.

Declaration

[JsonProperty("enableResultScore")]
public virtual bool? EnableResultScore { get; set; }

Property Value

Type	Description
bool?

EnableSafeSearch

Whether to enable safe search.

Declaration

[JsonProperty("enableSafeSearch")]
public virtual bool? EnableSafeSearch { get; set; }

Property Value

Type	Description
bool?

EnableSearchAsYouType

Whether to enable search-as-you-type behavior for the search widget

Declaration

[JsonProperty("enableSearchAsYouType")]
public virtual bool? EnableSearchAsYouType { get; set; }

Property Value

Type	Description
bool?

EnableSnippetResultSummary

Turn on or off summary for each snippets result.

Declaration

[JsonProperty("enableSnippetResultSummary")]
public virtual bool? EnableSnippetResultSummary { get; set; }

Property Value

Type	Description
bool?

EnableSummarization

Turn on or off summarization for the search response.

Declaration

[JsonProperty("enableSummarization")]
public virtual bool? EnableSummarization { get; set; }

Property Value

Type	Description
bool?

EnableWebApp

Whether to enable standalone web app.

Declaration

[JsonProperty("enableWebApp")]
public virtual bool? EnableWebApp { get; set; }

Property Value

Type	Description
bool?

ExperimentalFeatures

Allows to toggle unstable/experimental features in the widget (or web app)

Declaration

[JsonProperty("experimentalFeatures")]
public virtual IDictionary<string, string> ExperimentalFeatures { get; set; }

Property Value

Type	Description
IDictionary<string, string>

FacetField

The configuration and appearance of facets in the end user view.

Declaration

[JsonProperty("facetField")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField> FacetField { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>

FieldsUiComponentsMap

The key is the UI component. Mock. Currently supported title, thumbnail, url, custom1, custom2, custom3. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. title, thumbnail, url are required UI components that cannot be removed.

Declaration

[JsonProperty("fieldsUiComponentsMap")]
public virtual IDictionary<string, GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField> FieldsUiComponentsMap { get; set; }

Property Value

Type	Description
IDictionary<string, GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField>

HomepageSetting

Optional. Describes the homepage settings of the widget.

Declaration

[JsonProperty("homepageSetting")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting HomepageSetting { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting

IndustryVertical

Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.

Declaration

[JsonProperty("industryVertical")]
public virtual string IndustryVertical { get; set; }

Property Value

Type	Description
string

LlmEnabled

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

Declaration

[JsonProperty("llmEnabled")]
public virtual bool? LlmEnabled { get; set; }

Property Value

Type	Description
bool?

MinimumDataTermAccepted

Output only. Whether the customer accepted data use terms.

Declaration

[JsonProperty("minimumDataTermAccepted")]
public virtual bool? MinimumDataTermAccepted { get; set; }

Property Value

Type	Description
bool?

Name

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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ResultDisplayType

The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.

Declaration

[JsonProperty("resultDisplayType")]
public virtual string ResultDisplayType { get; set; }

Property Value

Type	Description
string

SolutionType

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

Declaration

[JsonProperty("solutionType")]
public virtual string SolutionType { get; set; }

Property Value

Type	Description
string

UiBranding

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

Declaration

[JsonProperty("uiBranding")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings UiBranding { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings

UiSettings

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

Declaration

[JsonProperty("uiSettings")]
public virtual GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings UiSettings { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp the WidgetConfig was updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema