REST Resource: projects.locations.collections.dataStores.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.

UIComponentField

Facet field that maps to a UI Component.

JSON representation 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Fields
field

string

Required. Registered field name. The format is field.abc.
deviceVisibility[]

enum (DeviceVisibility)

The field visibility on different types of devices.
displayTemplate

string

The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".

DeviceVisibility

The visibility of the field on different type of devices.

Enums
DEVICE_VISIBILITY_UNSPECIFIED Default value when not specified. Server returns INVALID_ARGUMENT if used in requests.
MOBILE The UI component is visible on Mobile devices.
DESKTOP The UI component is visible on Browser-based client.

FacetField

Facet fields that store the mapping of fields to end user widget appearance.

JSON representation 
{
  "field": string,
  "displayName": string
}
Fields
field

string

Required. Registered field name. The format is field.abc.
displayName

string

Optional. The field name that end users will see.

DataStoreType

The type of the widget's parent data store.

Enums
DATA_STORE_TYPE_UNSPECIFIED Unspecified data store type.
STRUCTURED The parent data store contains a search engine for structured data.
UNSTRUCTURED The parent data store contains a search engine for unstructured data.
BLENDED The parent data store is served for blended search with multiple data stores.

ResultDisplayType

The type of result to display in the ucs widget.

Enums
RESULT_DISPLAY_TYPE_UNSPECIFIED Unspecified display type (default to showing snippet).
SNIPPET Display results from the snippet field.
EXTRACTIVE_ANSWER Display results from extractive answers field.

DataStoreUiConfig

UI component configuration for data store.

JSON representation 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Fields
name

string

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
id

string

Output only. the identifier of the data store, used for widget service. For now it refers to dataStoreId, in the future we will migrate the field to encrypted data store name UUID.
facetField[]

object (FacetField)

Facet fields that store the mapping of fields to end user widget appearance.
fieldsUiComponentsMap

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.

CollectionComponent

Read-only collection component that contains data store collections fields that may be used for filtering

JSON representation 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "connectorIconLink": string
}
Fields
name

string

The name of the collection. It should be collection resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
id

string

Output only. the identifier of the collection, used for widget service. For now it refers to collectionId, in the future we will migrate the field to encrypted collection name UUID.
displayName

string

The display name of the collection.
dataStoreComponents[]

object (DataStoreComponent)

For the data store collection, list of the children data stores.
dataSource

string

The name of the data source, retrieved from Collection.data_connector.data_source.

DataStoreComponent

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of CollectionComponent.

JSON representation 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig)
}
Fields
name

string

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. For APIs under WidgetService, such as [WidgetService.LookUpWidgetConfig][], the project number and location part is erased in this field.
id

string

Output only. the identifier of the data store, used for widget service. For now it refers to dataStoreId, in the future we will migrate the field to encrypted data store name UUID.
displayName

string

The display name of the data store.
entityName

string

The name of the entity, retrieved from Collection.data_connector.entities.entityName.
workspaceType

enum (Type)

Output only. Workspace Source Types for workspace data, retrieved from DataStore.workspace_config.type.
contentConfig

enum (ContentConfig)

Output only. The content config of the data store.

UiSettings

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

JSON representation 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean
}
Fields
interactionType

enum (InteractionType)

Describes widget (or web app) interaction type
generativeAnswerConfig

object (GenerativeAnswerConfig)

Describes generative answer configuration.
resultDescriptionType

enum (ResultDisplayType)

Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
enableAutocomplete

boolean

Whether or not to enable autocomplete.
enableQualityFeedback

boolean

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

boolean

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

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
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Per data store configuration.
disableUserEventsCollection

boolean

If set to true, the widget will not collect user events.
enableVisualContentSummary

boolean

If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

InteractionType

Describes interaction type.

Enums
INTERACTION_TYPE_UNSPECIFIED Not specified. Defaults to SEARCH_ONLY.
SEARCH_ONLY Search without a generative answer.
SEARCH_WITH_ANSWER Search with the generative answer.
SEARCH_WITH_FOLLOW_UPS Search with the generative answer that supports follow up questions. Also known as multi-turn search.

GenerativeAnswerConfig

Describes configuration for generative answer.

JSON representation 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean
}
Fields
resultCount

integer

The number of top results to generate the answer from. Up to 10.
modelVersion

string

The model version used to generate the answer.
modelPromptPreamble

string

Text at the beginning of the prompt that instructs the model that generates the answer.
maxRephraseSteps

integer

Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
languageCode

string

Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
ignoreNonAnswerSeekingQuery

boolean

Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is false.

No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead.
ignoreAdversarialQuery

boolean

Optional. Specifies whether to filter out queries that are adversarial.
ignoreLowRelevantContent

boolean

Optional. Specifies whether to filter out queries that are not relevant to the content.

AccessSettings

Describes widget access settings.

JSON representation 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean
}
Fields
allowPublicAccess

boolean

Whether public unauthenticated access is allowed.
allowlistedDomains[]

string

List of domains that are allowed to integrate the search widget.
enableWebApp

boolean

Whether web app access is enabled.

UiBrandingSettings

Describes widget UI branding settings.

JSON representation 
{
  "logo": {
    object (Image)
  }
}
Fields

Image

Options to store an image.

JSON representation 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
Fields
Union field storage_method. Various ways to store an image, i.e., as a URL or base64 encoded string. storage_method can be only one of the following:
url

string

Image URL.

HomepageSetting

Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.

JSON representation 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Fields
shortcuts[]

object (Shortcut)

Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)

Shortcut

Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.

JSON representation 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Fields
title

string

Optional. title of the shortcut.
icon

object (Image)

Optional. Icon URL of shortcut.
destinationUri

string

Optional. Destination URL of shortcut.

AssistantSettings

Describes the assistant settings of the widget.

JSON representation 
{
  "googleSearchGroundingEnabled": boolean
}
Fields
googleSearchGroundingEnabled

boolean

Whether or not the Google search grounding toggle is shown.

Methods

get

 Gets a WidgetConfig.