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

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

方法

get

 取得 WidgetConfig。