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

资源：WidgetConfig

WidgetConfig 用于捕获 widget 级别的配置。

JSON 表示法 
{
  "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)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean
}
字段
name

string

不可变。微件配置的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
displayName

string

必需。直观易懂的 widget 配置显示名称。在发现界面中使用。

此字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
createTime

string (Timestamp format)

仅限输出。WidgetConfig 的创建时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。WidgetConfig的更新时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
enableAutocomplete
(deprecated)

boolean

是否启用自动补全功能。
fieldsUiComponentsMap
(deprecated)

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

关键在于界面组件。模拟。目前支持 title、thumbnail、url、custom1、custom2、custom3。

该值是字段的名称及其设备公开范围。

这 3 个自定义字段是可选的，可以添加或移除。title、thumbnail、url 是必需的界面组件，无法移除。
facetField[]
(deprecated)

object (FacetField)

最终用户视图中各个方面的配置和外观。
dataStoreType

enum (DataStoreType)

仅限输出。父数据存储区的类型。
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

用于配置内容搜索所需行为的内容搜索规范。
enableSummarization
(deprecated)

boolean

开启或关闭搜索回答的总结功能。
enableSnippetResultSummary
(deprecated)

boolean

为每个摘要结果开启或关闭摘要。
configId

string

仅限输出。WidgetConfig 的唯一混淆处理标识符。
enableQualityFeedback
(deprecated)

boolean

开启或关闭收集最终用户提供的搜索结果质量反馈。
solutionType

enum (SolutionType)

必需。不可变。指定相应 WidgetConfig 可用于的解决方案类型。
industryVertical

enum (IndustryVertical)

仅限输出。WidgetConfig 注册的行业纵向市场。WidgetConfig 行业垂直领域基于关联的 Engine。
allowPublicAccess
(deprecated)

boolean

是否允许与 widget 进行无身份验证集成。如果设置为 true，则允许公开访问 widget 中的搜索或其他解决方案，而无需客户托管的后端服务器提供的身份验证令牌。
allowlistedDomains[]
(deprecated)

string

可加载此 widget 的列入许可名单的网域。
llmEnabled

boolean

仅限输出。相应数据存储区中是否已启用 LLM。
enableResultScore

boolean

是否显示结果得分。
resultDisplayType
(deprecated)

enum (ResultDisplayType)

要在 UCS widget 中显示的摘要类型。

  • 针对现有用户的 RESULT_DISPLAY_TYPE_UNSPECIFIED。
  • 面向新的非企业搜索用户的摘要。
  • 面向企业搜索新用户的 EXTRACTIVE_ANSWER。
minimumDataTermAccepted

boolean

仅限输出。客户是否接受了数据使用条款。
enableWebApp
(deprecated)

boolean

是否启用独立式 Web 应用。
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

每个数据存储区可配置的界面配置。
collectionComponents[]

object (CollectionComponent)

仅限输出。列出与 widget 配置关联的所有集合和子数据存储区的集合组件，这些数据源可用于在 widget 服务 API 中进行过滤，用户可以返回来自所选数据源的结果。
enableSearchAsYouType
(deprecated)

boolean

是否为搜索 widget 启用即输即搜行为
defaultSearchRequestOrderBy
(deprecated)

string

搜索结果的默认排序（如果已指定）。

用于在适用的请求中设置 SearchRequest#orderBy。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)

允许在 widget（或 Web 应用）中切换不稳定/实验性功能
uiSettings

object (UiSettings)

介绍了在云控制台 widget 配置页面中看到的常规 widget 搜索设置。替换已弃用的顶级属性。
accessSettings

object (AccessSettings)

将用于在 Cloud 控制台集成页面中显示的所有 widget 访问权限设置。替换已弃用的顶级属性。
uiBranding

object (UiBrandingSettings)

描述搜索微件界面品牌推广设置，例如微件标题、徽标、收藏夹图标和颜色。
homepageSetting

object (HomepageSetting)

可选。描述 widget 的首页设置。
assistantSettings

object (AssistantSettings)

可选。仅限输出。描述 widget 的助理设置。
customerProvidedConfig

object (CustomerProvidedConfig)

可选。仅限输出。描述了客户相关配置，目前仅供政府客户使用。项目完成初始配置后，此字段便无法修改。
enablePrivateKnowledgeGraph

boolean

可选。仅限输出。是否启用私有知识图谱。

UIComponentField

映射到界面组件的分面字段。

JSON 表示法 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
字段
field

string

必需。已注册的字段名称。格式为 field.abc。
deviceVisibility[]

enum (DeviceVisibility)

不同类型设备上的字段显示情况。
displayTemplate

string

用于自定义字段显示方式的模板。示例值可以是如下所示的字符串：“价格：{value}”。

DeviceVisibility

不同类型设备上字段的可见性。

枚举
DEVICE_VISIBILITY_UNSPECIFIED 未指定时的默认值。如果在请求中使用，服务器会返回 INVALID_ARGUMENT。
MOBILE 界面组件在移动设备上可见。
DESKTOP 界面组件在基于浏览器的客户端上可见。

FacetField

存储字段到最终用户 widget 外观的映射关系的 facet 字段。

JSON 表示法 
{
  "field": string,
  "displayName": string
}
字段
field

string

必需。已注册的字段名称。格式为 field.abc。
displayName

string

可选。最终用户将看到的字段名称。

DataStoreType

相应 widget 的父数据存储区的类型。

枚举
DATA_STORE_TYPE_UNSPECIFIED 未指定的数据存储区类型。
STRUCTURED 父数据存储区包含一个用于结构化数据的搜索引擎。
UNSTRUCTURED 父数据存储区包含一个非结构化数据搜索引擎。
BLENDED 父数据存储区用于包含多个数据存储区的混合搜索。

ResultDisplayType

要在 UCS widget 中显示的结果类型。

枚举
RESULT_DISPLAY_TYPE_UNSPECIFIED 未指定的展示类型（默认为显示摘要）。
SNIPPET 显示代码段字段中的结果。
EXTRACTIVE_ANSWER 显示从提取式答案字段中获得的结果。

DataStoreUiConfig

数据存储区的界面组件配置。

JSON 表示法 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
字段
name

string

数据存储区的名称。应为数据存储区资源名称，格式为：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。对于 WidgetService 下的 API（例如 [WidgetService.LookUpWidgetConfig][]），此字段中会清除项目编号和位置部分。
id

string

仅限输出。数据存储区的标识符，用于 widget 服务。目前，它指的是 dataStoreId，未来我们将把该字段迁移到加密的数据存储区名称 UUID。
facetField[]

object (FacetField)

存储字段到最终用户 widget 外观的映射关系的 facet 字段。
fieldsUiComponentsMap

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

关键在于界面组件。模拟。目前支持 title、thumbnail、url、custom1、custom2、custom3。

该值是字段的名称及其设备公开范围。

这 3 个自定义字段是可选的，可以添加或移除。title、thumbnail、url 是必需的界面组件，无法移除。

CollectionComponent

只读集合组件，包含可用于过滤的数据存储区集合字段

JSON 表示法 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string
}
字段
name

string

集合的名称。应为集合资源名称。格式：projects/{project}/locations/{location}/collections/{collectionId}。对于 WidgetService 下的 API（例如 [WidgetService.LookUpWidgetConfig][]），此字段中会清除项目编号和位置部分。
id

string

仅限输出。用于 widget 服务的集合的标识符。目前，它指的是 collectionId，未来我们将把该字段迁移到加密的集合名称 UUID。
displayName

string

集合的显示名称。
dataStoreComponents[]

object (DataStoreComponent)

对于数据存储区集合，子数据存储区的列表。
dataSource

string

从 Collection.data_connector.data_source 检索到的数据源名称。
dataSourceDisplayName

string

仅限输出。数据源的显示名称。

DataStoreComponent

只读数据存储区组件，包含可用于过滤的数据存储区字段，是 CollectionComponent 的子级。

JSON 表示法 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
字段
name

string

数据存储区的名称。应为数据存储区资源名称，格式为：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。对于 WidgetService 下的 API（例如 [WidgetService.LookUpWidgetConfig][]），此字段中会清除项目编号和位置部分。
id

string

仅限输出。数据存储区的标识符，用于 widget 服务。目前，它指的是 dataStoreId，未来我们将把该字段迁移到加密的数据存储区名称 UUID。
displayName

string

数据存储区的显示名称。
entityName

string

从 Collection.data_connector.entities.entityName 中检索到的实体的名称。
workspaceType

enum (Type)

仅限输出。从 DataStore.workspace_config.type 检索到的工作区数据的工作区来源类型。
contentConfig

enum (ContentConfig)

仅限输出。数据存储区的内容配置。
dataStoreConfigType

enum (DataStoreConfigType)

仅限输出。数据存储区配置的类型。

DataStoreConfigType

数据存储区配置的类型。

枚举
DATA_STORE_CONFIG_TYPE_UNSPECIFIED 默认值。此值未使用。
ALLOW_DB_CONFIG 数据存储区已连接到 AlloyDB
THIRD_PARTY_OAUTH_CONFIG 数据存储区已连接到第三方数据源。
NOTEBOOKLM_CONFIG 数据存储区已关联到 NotebookLM Enterprise。

UiSettings

介绍了在云控制台界面配置页面中看到的常规 widget（或 Web 应用）界面设置。

JSON 表示法 
{
  "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,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  }
}
字段
interactionType

enum (InteractionType)

描述 widget（或 Web 应用）互动类型
generativeAnswerConfig

object (GenerativeAnswerConfig)

描述生成式答案配置。
resultDescriptionType

enum (ResultDisplayType)

控制是否显示结果提取内容以及显示方式（摘要或提取式答案）。如果未指定，则默认为无结果。
enableAutocomplete

boolean

是否启用自动补全功能。
enableQualityFeedback

boolean

开启或关闭收集最终用户提供的搜索结果质量反馈。
enableSearchAsYouType

boolean

是否为搜索 widget 启用即输即搜行为。
defaultSearchRequestOrderBy

string

搜索结果的默认排序（如果已指定）。

用于在适用的请求中设置 SearchRequest#orderBy。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

每个数据存储区的配置。
disableUserEventsCollection

boolean

如果设置为 true，widget 将不会收集用户事件。
enableVisualContentSummary

boolean

如果设置为 true，widget 将在适用的搜索请求中启用视觉内容摘要。仅供医疗保健搜索使用。
enableCreateAgentButton

boolean

可选。如果设置为 true，该 widget 将启用“创建代理”按钮。
features

map (key: string, value: enum (FeatureState))

仅限输出。供引擎选择启用或停用功能的特征配置。支持的密钥：

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload

InteractionType

描述互动类型。

枚举
INTERACTION_TYPE_UNSPECIFIED 未指定。默认值为 SEARCH_ONLY。
SEARCH_ONLY 搜索但不生成答案。
SEARCH_WITH_ANSWER 使用生成式答案进行搜索。
SEARCH_WITH_FOLLOW_UPS 使用支持跟进问题的生成式回答进行搜索。也称为多轮搜索。

GenerativeAnswerConfig

描述生成式答案的配置。

JSON 表示法 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
字段
resultCount

integer

用于生成答案的热门结果数量。最多 10 个。
modelVersion

string

用于生成回答的模型版本。
modelPromptPreamble

string

提示开头用于指示生成答案的模型的文本。
maxRephraseSteps

integer

重新表述步骤数上限。最多 5 个步骤。如果未设置或设置为小于 1 的值，则默认设置为 1。
languageCode

string

摘要的语言代码。使用 BCP47 定义的语言标记。注意：这是一项实验性功能。
ignoreNonAnswerSeekingQuery

boolean

可选。指定是否过滤掉非寻求答案的查询。默认值为 false。

如果搜索查询被归类为非答案寻求型查询，则不会返回任何答案。如果此字段设置为 true，我们会跳过为非寻求答案的查询生成答案，而是返回回退消息。
ignoreAdversarialQuery

boolean

可选。指定是否过滤掉对抗性查询。
ignoreLowRelevantContent

boolean

可选。指定是否过滤掉与内容无关的查询。
imageSource

enum (ImageSource)

可选。回答中返回的图片的来源。

ImageSource

回答中返回的图片的来源。

枚举
IMAGE_SOURCE_UNSPECIFIED 未指定图片来源（多模态功能默认处于停用状态）
ALL_AVAILABLE_SOURCES 当服务从所有可用来源中选择内容时的行为。
CORPUS_IMAGE_ONLY 在回答中包含语料库中的图片。
FIGURE_GENERATION_ONLY 触发回答中的图表生成。

FeatureState

引擎的功能状态。

枚举
FEATURE_STATE_UNSPECIFIED 未指定功能状态。
FEATURE_STATE_ON 此功能已开启，可供使用。
FEATURE_STATE_OFF 该功能已关闭，无法使用。

AccessSettings

介绍 widget 访问权限设置。

JSON 表示法 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
字段
allowPublicAccess

boolean

是否允许未经身份验证的公开访问。
allowlistedDomains[]

string

允许集成搜索 widget 的网域列表。
enableWebApp

boolean

Web 应用访问权限是否已启用。
workforceIdentityPoolProvider

string

可选。用于访问 widget 的员工身份池提供方。
languageCode

string

可选。用户界面的语言代码。使用 BCP47 定义的语言标记。如果未设置，则默认语言代码为“en-US”。

UiBrandingSettings

描述 widget 界面品牌设置。

JSON 表示法 
{
  "logo": {
    object (Image)
  }
}
字段

图片

存储图片的选项。

JSON 表示法 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
字段
联合字段 storage_method。存储图片的各种方式，例如以网址或 base64 编码字符串的形式存储。storage_method 只能是下列其中一项：
url

string

图片网址。

HomepageSetting

描述 widget 的首页设置。它包含所有与首页相关的设置和配置，例如快捷方式。

JSON 表示法 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
字段
shortcuts[]

object (Shortcut)

可选。要在首页上显示的快捷方式。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)

快捷键

用于描述首页上的快捷方式实体（也称为固定内容）。首页将按照 API 返回的顺序呈现这些快捷方式。如果客户想要重新排序或移除快捷方式，界面应始终提供新的完整快捷方式列表。

JSON 表示法 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
字段
title

string

可选。快捷方式的标题。
icon

object (Image)

可选。快捷方式的图标网址。
destinationUri

string

可选。快捷方式的目标网址。

AssistantSettings

描述 widget 的助理设置。

JSON 表示法 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
字段
googleSearchGroundingEnabled
(deprecated)

boolean

是否显示 Google 搜索接地切换开关。已弃用。请改用 webGroundingType。
webGroundingType

enum (WebGroundingType)

可选。要使用的网页接地类型。
defaultWebGroundingToggleOff

boolean

仅限输出。如果 webGroundingType 设置为 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 或 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH，此字段将控制最终用户的默认网络接地切换开关。此字段默认设置为 false。如果 webGroundingType 为 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 或 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH，最终用户将在界面上默认启用网络接地。如果为 true，则默认在界面上停用接地切换开关。如果启用了网页接地，最终用户仍可在界面中启用网页接地。
disableLocationContext

boolean

可选。仅限输出。是否停用用户位置信息上下文。

WebGroundingType

要使用的网页接地类型。

枚举
WEB_GROUNDING_TYPE_UNSPECIFIED 默认的未指定设置。这与“已停用”相同。
WEB_GROUNDING_TYPE_DISABLED 网页接地已停用。

CustomerProvidedConfig

客户提供的配置。

JSON 表示法 
{
  "customerType": enum (CustomerType)
}
字段
customerType

enum (CustomerType)

客户类型。

CustomerType

客户类型。

枚举
DEFAULT_CUSTOMER 默认客户类型。
GOVERNMENT_CUSTOMER 政府客户类型。由于法律要求，部分功能已针对政府客户停用。

方法

get

 获取 WidgetConfig。