Method: projects.locations.dataStores.widgetConfigs.get

取得 WidgetConfig。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/dataStores/*/widgetConfigs/*}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

這是必要旗標，完整的 WidgetConfig 資源名稱。格式：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

查詢參數

參數
acceptCache

boolean

選用。是否可從快取載入小工具設定。如果設為 true，小工具設定的近期變更可能需要幾分鐘才會反映在使用者檢視畫面中。建議您為已成熟開發的小工具設為 true，因為這樣可以提升小工具效能。如果小工具仍在開發階段，請設為 false，以便立即在正式版中查看變更。
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

選用。GetWidgetConfigRequest 的選項。
languageCode

string

選用。BCP-47 語言代碼 (例如「en」、「fr-CA」)。用於將回應中可供使用者閱讀的字串本地化，例如 WidgetConfig.UiSettings.ModelConfigInfo 上的模型選取器 displayName / description。如果留空 / 未設定，系統會改回預設語言 (英文)。
modelInfoView

enum (ModelInfoView)

選用。選取後端計算的 WidgetConfig.UiSettings.ModelConfigInfo 檢視畫面。MODEL_INFO_VIEW_ADMIN 是由 Cloud 控制台管理員在「功能管理」頁面 (畫面/4Vn9gQKbN8tb7gm) 中設定，用來接收以 ResolvedModel.admin_view 填入的管理員顯示模型集；取消設定 / MODEL_INFO_VIEW_WEB 則會傳回使用者選取器。系統會改為從 X-Goog-Gemini-Enterprise-Mobile 標頭偵測行動裝置介面 (請參閱 ModelInfoView)。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 WidgetConfig 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • discoveryengine.widgetConfigs.get

詳情請參閱 IAM 說明文件。