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

資源：WidgetConfig

WidgetConfig 會擷取小工具層級的設定。

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

這是必要旗標，使用者可判讀的小工具設定顯示名稱。用於探索使用者介面。

這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個半形字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
createTime

string (Timestamp format)

僅供輸出。建立 WidgetConfig 的時間戳記。

使用 RFC 3339，產生的輸出內容一律會經過 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 標準化，並使用 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))

這個鍵是 UI 元件。模擬。目前支援 title、thumbnail、url、custom1、custom2、custom3。

這個值是欄位名稱和裝置分享設定。

這 3 個自訂欄位為選填，可新增或移除。title、thumbnail、url 是必要 UI 元件，無法移除。
facetField[]
(deprecated)

object (FacetField)

使用者檢視畫面中構面的設定和外觀。
dataStoreType

enum (DataStoreType)

僅供輸出。父項資料儲存庫的類型。
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

內容搜尋規格，可設定內容搜尋的所需行為。
enableSummarization
(deprecated)

boolean

開啟或關閉搜尋結果摘要功能。
enableSnippetResultSummary
(deprecated)

boolean

開啟或關閉每筆摘要結果的摘要。
configId

string

僅供輸出。WidgetConfig的專屬模糊處理 ID。
enableQualityFeedback
(deprecated)

boolean

開啟或關閉收集使用者對搜尋結果品質的意見回饋。
solutionType

enum (SolutionType)

這是必要旗標，不可變動。指定這個 WidgetConfig 可使用的解決方案類型。
industryVertical

enum (IndustryVertical)

僅供輸出。WidgetConfig 註冊的產業別。WidgetConfig 產業類別是以相關聯的 Engine 為準。
allowPublicAccess
(deprecated)

boolean

是否允許與小工具進行無驗證整合。如果設為 true，使用者可從小工具公開存取搜尋或其他解決方案，不必提供客戶代管後端伺服器提供的驗證權杖。
allowlistedDomains[]
(deprecated)

string

可載入這個小工具的許可網域。
llmEnabled

boolean

僅供輸出。是否在相應的資料儲存庫中啟用 LLM。
enableResultScore

boolean

是否顯示結果分數。
resultDisplayType
(deprecated)

enum (ResultDisplayType)

要在 UCS 小工具中顯示的程式碼片段類型。

  • 現有使用者的 RESULT_DISPLAY_TYPE_UNSPECIFIED。
  • 適用於新非企業搜尋使用者的程式碼片段。
  • EXTRACTIVE_ANSWER，適合企業搜尋新使用者。
minimumDataTermAccepted

boolean

僅供輸出。顧客是否接受資料使用條款。
enableWebApp
(deprecated)

boolean

是否啟用獨立網頁應用程式。
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

每個資料儲存庫可設定不同的 UI 設定。
collectionComponents[]

object (CollectionComponent)

僅供輸出。列出與小工具設定相關聯的所有集合和子資料儲存區的集合元件，這些資料來源可用於小工具服務 API 中的篩選作業，使用者可以從所選資料來源傳回結果。
enableSearchAsYouType
(deprecated)

boolean

是否要為搜尋小工具啟用即時搜尋行為
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)

允許在小工具 (或網頁應用程式) 中切換不穩定/實驗性功能
uiSettings

object (UiSettings)

說明雲端控制台小工具設定頁面中顯示的一般小工具搜尋設定。取代已淘汰的頂層屬性。
accessSettings

object (AccessSettings)

用於雲端控制台整合頁面中顯示的所有小工具存取設定。取代已淘汰的頂層屬性。
uiBranding

object (UiBrandingSettings)

說明搜尋小工具的使用者介面品牌宣傳設定，例如小工具標題、標誌、網站圖示和顏色。
homepageSetting

object (HomepageSetting)

(選用步驟) 說明小工具的首頁設定。
assistantSettings

object (AssistantSettings)

(選用步驟) 僅供輸出。說明小工具的輔助設定。
customerProvidedConfig

object (CustomerProvidedConfig)

(選用步驟) 僅供輸出。說明與客戶相關的設定，目前僅供政府機關客戶使用。專案加入後，這個欄位即無法修改。
enablePrivateKnowledgeGraph

boolean

(選用步驟) 僅供輸出。是否啟用私人知識圖譜。

UIComponentField

對應至 UI 元件的側邊欄位。

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

儲存欄位對應的側邊欄位，可供使用者小工具顯示。

JSON 表示法 
{
  "field": string,
  "displayName": string
}
欄位
field

string

這是必要旗標，已註冊的欄位名稱。格式為 field.abc。
displayName

string

(選用步驟) 使用者看到的欄位名稱。

DataStoreType

小工具父項資料儲存庫的類型。

列舉
DATA_STORE_TYPE_UNSPECIFIED 未指定資料儲存庫類型。
STRUCTURED 父項資料儲存庫包含結構化資料的搜尋引擎。
UNSTRUCTURED 父項資料儲存庫包含非結構化資料的搜尋引擎。
BLENDED 如果混合搜尋使用多個資料儲存庫，系統會提供父項資料儲存庫。

ResultDisplayType

要在 ucs 小工具中顯示的結果類型。

列舉
RESULT_DISPLAY_TYPE_UNSPECIFIED 未指定顯示類型 (預設為顯示摘要)。
SNIPPET 顯示程式碼片段欄位的結果。
EXTRACTIVE_ANSWER 顯示從擷取式答案欄位取得的結果。

DataStoreUiConfig

資料儲存庫的 UI 元件設定。

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

僅供輸出。資料儲存庫的 ID，用於小工具服務。目前是指 dataStoreId，未來我們會將這個欄位遷移至加密資料儲存庫名稱 UUID。
facetField[]

object (FacetField)

儲存欄位對應的側邊欄位，可供使用者小工具顯示。
fieldsUiComponentsMap

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

這個鍵是 UI 元件。模擬。目前支援 title、thumbnail、url、custom1、custom2、custom3。

這個值是欄位名稱和裝置分享設定。

這 3 個自訂欄位為選填，可新增或移除。title、thumbnail、url 是必要 UI 元件，無法移除。

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

僅供輸出。集合的 ID，用於小工具服務。目前是指 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

僅供輸出。資料儲存庫的 ID，用於小工具服務。目前是指 dataStoreId，未來我們會將這個欄位遷移至加密資料儲存庫名稱 UUID。
displayName

string

資料儲存庫的顯示名稱。
entityName

string

從 Collection.data_connector.entities.entityName 擷取的實體名稱。
workspaceType

enum (Type)

僅供輸出。Workspace 資料的 Workspace 來源類型，可從 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

說明一般小工具 (或網頁應用程式) UI 設定，如雲端控制台 UI 設定頁面所示。

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)

說明小工具 (或網路應用程式) 互動類型
generativeAnswerConfig

object (GenerativeAnswerConfig)

說明如何設定生成式答案。
resultDescriptionType

enum (ResultDisplayType)

控制是否顯示結果摘要，以及顯示方式 (摘要或擷取式答案)。如未指定，則預設為無結果。
enableAutocomplete

boolean

是否要啟用自動完成功能。
enableQualityFeedback

boolean

開啟或關閉收集使用者對搜尋結果品質的意見回饋。
enableSearchAsYouType

boolean

是否要為搜尋小工具啟用即時搜尋行為。
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，小工具就不會收集使用者事件。
enableVisualContentSummary

boolean

如果設為 true，小工具會在適用的搜尋要求中啟用視覺內容摘要。僅供醫療保健搜尋使用。
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
  • 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)

(選用步驟) 回覆中圖像的來源。

圖片來源

回覆中圖像的來源。

列舉
IMAGE_SOURCE_UNSPECIFIED 未指定圖片來源 (多模態功能預設為停用)
ALL_AVAILABLE_SOURCES 服務從所有可用來源中選取時的行為。
CORPUS_IMAGE_ONLY 在回覆中加入語料庫中的圖片。
FIGURE_GENERATION_ONLY 在答案中觸發圖表生成。

FeatureState

引擎的特徵狀態。

列舉
FEATURE_STATE_UNSPECIFIED 未指定功能狀態。
FEATURE_STATE_ON 這項功能已開啟，因此可供存取。
FEATURE_STATE_OFF 這項功能已關閉，因此無法存取。

AccessSettings

說明小工具存取權設定。

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

boolean

是否允許未經驗證的公開存取。
allowlistedDomains[]

string

允許整合搜尋小工具的網域清單。
enableWebApp

boolean

是否啟用網頁應用程式存取權。
workforceIdentityPoolProvider

string

(選用步驟) 用於存取小工具的員工身分集區提供者。
languageCode

string

(選用步驟) 使用者介面的語言代碼。請使用 BCP47 定義的語言標記。如未設定，預設語言代碼為「en-US」。

UiBrandingSettings

說明小工具 UI 品牌宣傳設定。

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

說明小工具的首頁設定。包括所有與首頁相關的設定和配置，例如快速鍵。

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 傳回的順序，顯示這些捷徑。如果顧客想重新排序或移除捷徑，UI 應一律提供新的完整捷徑清單。

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

string

(選用步驟) 捷徑的名稱。
icon

object (Image)

(選用步驟) 捷徑的圖示網址。
destinationUri

string

(選用步驟) 捷徑的到達網頁網址。

AssistantSettings

說明小工具的輔助設定。

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，UI 上的基礎切換按鈕預設會停用。啟用網頁基準後，使用者仍可在使用者介面中啟用網頁基準。
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。