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

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

方法

get

 获取 WidgetConfig。