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,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
字段
name

string

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

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

string

必需。人类可读的 WidgetConfig 显示名称。在发现界面中使用。

此字段必须是采用 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))

键是界面组件。Mock。目前支持 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 中进行过滤，用户可以返回来自所选数据源的结果。

对于 SaaS / 业务引擎，当使用 view = WITH_AVAILABLE_CONNECTORS 调用 LookupWidgetConfig 时，此列表还会添加调用方可能附加但尚未附加的连接器的合成占位符条目（请参阅 CollectionComponent 了解占位符合同）。因此，前端可以通过迭代此单个字段来呈现已附加和可附加来源的统一列表。对于企业版引擎和默认的 view，仅返回已附加的连接器（当前行为）。
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
uiSettings

object (UiSettings)

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

object (AccessSettings)

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

object (UiBrandingSettings)

描述搜索widget界面品牌推广设置，例如widget标题、徽标、网站图标和颜色。
homepageSetting

object (HomepageSetting)

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

object (AssistantSettings)

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

object (CustomerProvidedConfig)

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

boolean

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

boolean

仅限输出。订阅是否为 Gemini 套餐。
batchAuthStatuses[]

object (BatchAuthStatus)

仅限输出。相应 widget 连接器的批量授权状态。
nodes[]

object (Node)

仅限输出。与 widget 配置关联的节点。

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 外观的映射关系的分面字段。

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 外观的映射关系的分面字段。
fieldsUiComponentsMap

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

键是界面组件。Mock。目前支持 title、thumbnail、url、custom1、custom2、custom3。

该值是字段的名称及其设备可见性。

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

CollectionComponent

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

对于 SaaS / 业务引擎，当使用 view = WITH_AVAILABLE_CONNECTORS 调用 LookupWidgetConfig 时，此消息的实例还用于表示调用者可能附加但尚未附加的连接器的合成占位符条目。占位条目具有 connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED（或 NO_AUTH）、空的 connectorAuthState.authorization_uri（微件在用户点击“连接”时调用 WidgetBuildAuthorizationUrl），以及 name / id 中的合成占位值（请参阅字段注释）。对于仅对具体化连接器有意义的字段（dataStoreComponents、tenant、actionConnector），占位条目会将其保留为未设置状态。

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

string

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

对于合成占位条目（请参阅消息级注释），此字段包含与实际集合不对应的合成占位集合 ID。在用户授权连接器之前，调用方不得尝试解析 / 获取此资源。
id

string

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

对于合成占位条目（请参阅消息级注释），这是合成占位 ID，而不是真实的 collectionId。
displayName

string

集合的显示名称。
dataStoreComponents[]

object (DataStoreComponent)

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

string

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

string

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

object (ConnectorAuthState)

仅限输出。连接器来源的授权 URI。

DataStoreComponent

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

JSON 表示法 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "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 中检索到的实体的名称。
dataStoreConfigType

enum (DataStoreConfigType)

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

DataStoreConfigType

数据存储区配置的类型。

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

ConnectorAuthState

处于 CollectionComponent 身份验证状态的只读连接器。

JSON 表示法 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
字段
authState

enum (AuthState)

仅限输出。数据连接器的授权状态。
authorizationUri

string

仅限输出。数据连接器的授权 URI。

对于合成占位符 CollectionComponent 条目（由 LookupWidgetConfig 返回，在 SaaS / Business 引擎上具有 view = WITH_AVAILABLE_CONNECTORS），此字段留空。当用户点击“关联”时，该 widget 应调用 WidgetService.WidgetBuildAuthorizationUrl 以获取新构建的授权网址。
updateTime

string (Timestamp format)

仅限输出。授权状态更新时间戳。

采用 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"。

AuthState

数据连接器的授权状态。

枚举
AUTH_STATE_UNSPECIFIED 默认值。还针对 LookupWidgetConfig 通过 view = WITH_AVAILABLE_CONNECTORS（仅限 SaaS / 企业）显示的合成占位符 CollectionComponent 条目返回 - 这些条目表示调用方可以附加但尚未附加的连接器。
AUTHORIZED 用户已授权数据连接器。
EXPIRED 数据连接器的用户授权已过期。
ACTIONS_DISABLED 用户仍然可以提出搜索请求，但需要启用操作。
NO_AUTH 数据连接器不需要任何授权。还用于不需要用户 OAuth 的底层连接器的占位条目。

UiSettings

介绍了在 Cloud 控制台界面配置页面中看到的常规 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),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
字段
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，微件将启用“创建代理”按钮。
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
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • disable-skills
  • disable-projects
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • deep-research
modelConfigs

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

仅限输出。将模型名称映射到相应引擎的特定配置。这让管理员用户能够单独开启/关闭各个模型。此字段仅存储其状态已被管理员覆盖的模型。

如果未指定状态，或者相应模型对应的 modelConfigs 为空，系统将根据默认配置来决定该模型是否可用。例如，如果管理员未选择启用某个预览版模型，则该模型默认应处于停用状态。
modelConfigInfo

object (ModelConfigInfo)

仅限输出。模型选择器配置的已解析服务器端视图。用于保存应显示在模型选择器下拉菜单中的模型有序列表，以及应默认选择的模型。

客户端应直接呈现此内容，而不应用自己的过滤、排序或本地化设置。为了向后兼容尚未迁移到使用此字段的客户端，我们保留了上述旧版 modelConfigs 映射。
onedrivePickerEnabled

boolean

仅限输出。OneDrive 文件选择器是否可供最终用户使用。由后端根据管理员连接器启用情况（商务版）或附加的 OneDrive 连接器（企业版）计算得出，并与现有的 disable-onedrive-upload 管理员功能相结合。

声明了 optional，以便将显式计算的 false 与字段存在性一起序列化。纯 proto3 bool 会在网络上放置默认 false，这会使客户端无法区分“选择器已停用”(false) 和“字段未填充”（未设置）。
googleDrivePickerEnabled

boolean

仅限输出。Google 云端硬盘文件选择器是否可供最终用户使用。声明了 optional，原因与上述 onedrivePickerEnabled 的字段存在性原因相同。

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 相应功能已关闭，无法使用。

ModelState

引擎的模型状态。

枚举
MODEL_STATE_UNSPECIFIED 模型状态未指定。
MODEL_ENABLED 模型已由管理员启用。
MODEL_DISABLED 模型已被管理员停用。

ModelConfigInfo

面向最终用户的模型选择器配置的已解析服务器端视图。后端按以下顺序计算每个请求的此值：Mendel 标志评估、基于引擎位置的区域可用性规则，以及来自 modelConfigs 的管理面板替换项。

后端是此配置的唯一可信来源；客户端应按提供的顺序直接在模型选择器下拉菜单中呈现 resolvedModels，而不应用自己的过滤、排序或本地化。

JSON 表示法 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string
}
字段
resolvedModels[]

object (ResolvedModel)

仅限输出。模型选择器中可供最终用户使用的模型列表，按应显示的顺序列出。
defaultModelId

string

仅限输出。当最终用户未做出明确选择时，应在模型选择器中默认选择的模型的 modelId。该值始终是 resolvedModels 中存在的某个 modelId。

ResolvedModel

一个已解析为可在模型选择器中供最终用户使用的单个模型，包含其所有本地化展示元数据。

JSON 表示法 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "adminView": {
    object (AdminView)
  }
}
字段
modelId

string

仅限输出。模型的唯一标识符（例如 gemini-2.5-flash、gemini-3.1-pro-preview）。

这是客户端传递回 Google 助理服务以选择相应模型的同一标识符。虚拟模型/“伪”模型（例如 gemini-fast）也是此处有效的价值；它们会在后端解析为底层具体模型。
displayName

string

仅限输出。模型的本地化显示名称（例如 Gemini 3.1 Pro）。基于请求的 LookupWidgetConfigRequest.language_code 和 LookupWidgetConfigRequest.region_code 在服务器端进行本地化。
icon

string

仅限输出。与模型关联的兼容 GM3 的图标令牌（例如 rocket_launch、bolt、graph_5）。
description

string

仅限输出。本地化说明文本（例如 state-of-the-art reasoning）。使用与 displayName 相同的语言区域进行本地化。
isPreview

boolean

仅限输出。模型目前是否处于预览版阶段。客户端应通过选择器界面中的“预览”徽章显示此信息。
adminView

object (AdminView)

仅限输出。管理员界面元数据；仅针对控制台管理员功能控制页面（请参阅 AdminView）填充。对于最终用户界面，此字段处于未设置状态。

AdminView

管理员界面元数据。仅当请求来自 Cloud 控制台管理员的“功能控制”页面时填充；对于最终用户界面（Web、移动设备），则保持未设置状态。使管理页面能够直接从后端（而非硬编码的客户端注册表）渲染其切换表。

JSON 表示法 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
字段
adminOverridable

boolean

仅限输出。管理员是否可以通过 UiSettings.model_configs 切换此模型的启用/停用状态。派生自 MODEL_TAG_ADMIN_OVERRIDABLE。如果为 false，则模型为“强制”模型，其状态由 enabledByDefault 控制。
enabledByDefault

boolean

仅限输出。当管理员未在 UiSettings.model_configs 中设置明确的替换项时，模型是否处于启用状态。派生自 MODEL_TAG_ENABLED_BY_DEFAULT。
regions[]

string

仅限输出。相应模型已推出的地区。

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)
  }
}
字段

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)

可选。要在首页上显示的快捷方式。

快捷键

描述首页上的快捷方式（也称为固定内容）实体。首页将按照 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)

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

boolean

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

boolean

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

WebGroundingType

要使用的 Web 接地的类型。

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

CustomerProvidedConfig

客户提供的配置。

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

enum (CustomerType)

客户类型。

CustomerType

客户类型。

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

BatchAuthStatus

描述 batchAuthorizationGroup 的批量授权状态。

JSON 表示法 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
字段
placeholder

string

仅限输出。它是批量授权组占位符的完整资源名称。这不是真实的数据连接器（在 Spanner 的 DataConnector 表中不存在）。它是一个仅存在于用户表中的 connector_authorization 中的资源名称。例如：projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector。
batchAuthorizationGroup

string

仅限输出。占位符所属的批量授权组。
connectorAuthState

object (ConnectorAuthState)

仅限输出。相应连接器的当前授权状态。

节点

表示单个可重用的计算或逻辑单元。

JSON 表示法 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
字段
displayName

string

仅限输出。节点的人类可读名称。
iconUrl

string

仅限输出。指向表示相应节点类型的图标的标识符或网址。
description

string

仅限输出。节点的详细说明。
parameterSchema

object (Struct format)

仅限输出。工具的参数架构。

此架构应符合 OpenAPI 架构标准（请参阅 https://spec.openapis.org/oas/v3.0.3.html 和 AIP-146）。它描述了相应节点接受的参数的预期结构。
outputSchema

object (Struct format)

仅限输出。工具的输出架构。

此架构应符合 OpenAPI 架构标准（请参阅 https://spec.openapis.org/oas/v3.0.3.html/ 和 AIP-146）。它描述了相应节点生成的输出的结构。
type

enum (Type)

仅限输出。节点的类型。

类型

标识代理流程中的节点类型。

枚举
TYPE_UNSPECIFIED 未指定的类型。
TRIGGER 触发器类型。
FLOW 流类型。
CONNECTOR 连接器类型。

方法

get

 获取 WidgetConfig。

patch

 更新 WidgetConfig。