Resource: WidgetConfig
WidgetConfig captures configs at the Widget level.
JSON representation |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object ( |
Fields | |
---|---|
name |
Immutable. The full resource name of the widget config. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
display |
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. |
create |
Output only. timestamp the 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: |
update |
Output only. timestamp the 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: |
enableAutocomplete |
Whether or not to enable autocomplete. |
fieldsUiComponentsMap |
The key is the UI component. Mock. Currently supported 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. |
facetField[] |
The configuration and appearance of facets in the end user view. |
data |
Output only. The type of the parent data store. |
contentSearchSpec |
The content search spec that configs the desired behavior of content search. |
enableSummarization |
Turn on or off summarization for the search response. |
enableSnippetResultSummary |
Turn on or off summary for each snippets result. |
config |
Output only. Unique obfuscated identifier of a |
enableQualityFeedback |
Turn on or off collecting the search result quality feedback from end users. |
solution |
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
industry |
Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated |
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. |
allowlistedDomains[] |
Allowlisted domains that can load this widget. |
enableSafeSearch |
Whether to enable safe search. |
enableConversationalSearch |
Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). |
llm |
Output only. Whether LLM is enabled in the corresponding data store. |
enable |
Whether to show the result score. |
resultDisplayType |
The type of snippet to display in UCS widget.
|
minimum |
Output only. Whether the customer accepted data use terms. |
enableWebApp |
Whether to enable standalone web app. |
dataStoreUiConfigs[] |
Configurable UI configurations per data store. |
collection |
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 |
Whether to enable search-as-you-type behavior for the search widget |
defaultSearchRequestOrderBy |
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 |
experimental |
Allows to toggle unstable/experimental features in the widget (or web app) |
ui |
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
access |
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
ui |
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
homepage |
Optional. Describes the homepage settings of the widget. |
assistant |
Optional. Output only. Describes the assistant settings of the widget. |
Methods |
|
---|---|
|
Gets a WidgetConfig . |