REST Resource: projects.locations.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,
  "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}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

必須。人が読める形式のウィジェット構成の表示名。Discovery UI で使用されます。

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、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))

key は UI コンポーネントです。モック。現在は title、thumbnail、url、custom1、custom2、custom3 をサポートしています。

value は、フィールドの名前とそのデバイスの可視性です。

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 の難読化された一意の識別子。
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: 既存のユーザーの場合。
  • SNIPPET: 新しい非エンタープライズ検索ユーザーの場合。
  • 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)

Cloud コンソールのウィジェット構成ページに表示される一般的なウィジェット検索設定を記述します。非推奨の最上位プロパティを置き換えます。
accessSettings

object (AccessSettings)

Cloud コンソールの統合ページに表示されるすべてのウィジェット アクセス設定に使用されます。非推奨の最上位プロパティを置き換えます。
uiBranding

object (UiBrandingSettings)

検索ウィジェットの UI ブランディング設定（ウィジェットのタイトル、ロゴ、ファビコン、色など）を記述します。
homepageSetting

object (HomepageSetting)

省略可。ウィジェットのホームページ設定を記述します。
assistantSettings

object (AssistantSettings)

省略可。出力専用。ウィジェットのアシスタント設定を記述します。
customerProvidedConfig

object (CustomerProvidedConfig)

省略可。出力専用。お客様関連の構成を記述します。現在は政府機関のお客様にのみ使用されています。このフィールドは、プロジェクトのオンボーディング後に変更することはできません。
enablePrivateKnowledgeGraph

boolean

省略可。出力専用。非公開ナレッジグラフを有効にするかどうか。

メソッド

get

 WidgetConfig を取得します。