REST Resource: projects.locations.collections.engines.widgetConfigs

Resource: WidgetConfig

WidgetConfig captures configs at the Widget level.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  }
}
Fields
name

string

Immutable. The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.
displayName

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

string (Timestamp format)

Output only. timestamp the WidgetConfig was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. timestamp the WidgetConfig was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Whether or not to enable autocomplete.
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

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.
facetField[]
(deprecated)

object (FacetField)

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

enum (DataStoreType)

Output only. The type of the parent data store.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

The content search spec that configs the desired behavior of content search.
enableSummarization
(deprecated)

boolean

Turn on or off summarization for the search response.
enableSnippetResultSummary
(deprecated)

boolean

Turn on or off summary for each snippets result.
configId

string

Output only. Unique obfuscated identifier of a WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

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

enum (SolutionType)

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

enum (IndustryVertical)

Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
allowPublicAccess
(deprecated)

boolean

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.
allowlistedDomains[]
(deprecated)

string

Allowlisted domains that can load this widget.
llmEnabled

boolean

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

boolean

Whether to show the result score.
resultDisplayType
(deprecated)

enum (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.
minimumDataTermAccepted

boolean

Output only. Whether the customer accepted data use terms.
enableWebApp
(deprecated)

boolean

Whether to enable standalone web app.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurable UI configurations per data store.
collectionComponents[]

object (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.
enableSearchAsYouType
(deprecated)

boolean

Whether to enable search-as-you-type behavior for the search widget
defaultSearchRequestOrderBy
(deprecated)

string

The default ordering for search results if specified.

Used to set SearchRequest#orderBy on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
experimentalFeatures

map (key: string, value: string)

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

object (UiSettings)

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

object (AccessSettings)

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

object (UiBrandingSettings)

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

object (HomepageSetting)

Optional. Describes the homepage settings of the widget.
assistantSettings

object (AssistantSettings)

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

Methods

get

 Gets a WidgetConfig.