- リソース: WidgetConfig
- JSON 表現
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- 画像
- HomepageSetting
- ショートカット
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- メソッド
リソース: WidgetConfig
WidgetConfig は、Widget レベルで構成をキャプチャします。
| JSON 表現 |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object ( |
| フィールド | |
|---|---|
name |
変更不可。ウィジェット構成の完全なリソース名。形式: このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。 |
displayName |
必須。人が読める形式のウィジェット構成の表示名。Discovery UI で使用されます。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 |
createTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
updateTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
enableAutocomplete |
予測入力を有効にするかどうか。 |
fieldsUiComponentsMap |
キーは UI コンポーネントです。Mock. 現在サポートされている 値は、フィールドの名前とそのデバイスの公開設定です。 3 つのカスタム フィールドは省略可能で、追加または削除できます。 |
facetField[] |
エンドユーザー ビューでのファセットの構成と外観。 |
dataStoreType |
出力専用。親データストアのタイプ。 |
contentSearchSpec |
コンテンツ検索の目的の動作を設定するコンテンツ検索仕様。 |
enableSummarization |
検索レスポンスの要約をオンまたはオフにします。 |
enableSnippetResultSummary |
各スニペット結果の要約をオンまたはオフにします。 |
configId |
出力専用。 |
enableQualityFeedback |
エンドユーザーからの検索結果の品質に関するフィードバックの収集をオンまたはオフにします。 |
solutionType |
必須。変更不可。この WidgetConfig を使用できるソリューション タイプを指定します。 |
industryVertical |
出力専用。WidgetConfig が登録する業種。WidgetConfig の業種は、関連付けられた |
allowPublicAccess |
ウィジェットとの認証なしの統合を許可するかどうか。true に設定すると、お客様がホストするバックエンド サーバーから提供された認証トークンなしで、ウィジェットから検索やその他のソリューションへの一般公開アクセスが許可されます。 |
allowlistedDomains[] |
このウィジェットを読み込むことができる許可リスト登録済みドメイン。 |
enableSafeSearch |
セーフサーチを有効にするかどうか。 |
enableConversationalSearch |
会話型検索(LLM、マルチターン)を許可するかどうか(非 LLM、シングルターン)。 |
llmEnabled |
出力専用。対応するデータストアで LLM が有効になっているかどうか。 |
enableResultScore |
結果のスコアを表示するかどうか。 |
resultDisplayType |
UCS ウィジェットに表示するスニペットのタイプ。
|
minimumDataTermAccepted |
出力専用。お客様がデータ使用条件に同意したかどうか。 |
enableWebApp |
スタンドアロン ウェブアプリを有効にするかどうか。 |
dataStoreUiConfigs[] |
データストアごとに構成可能な UI 構成。 |
collectionComponents[] |
出力専用。ウィジェット設定に関連付けられているすべてのコレクションと子データストアを一覧表示するコレクション コンポーネント。これらのデータソースは、ウィジェット サービス API でのフィルタリングに使用できます。ユーザーは、選択したデータソースから結果を返すことができます。 |
enableSearchAsYouType |
検索ウィジェットの入力逐次検索動作を有効にするかどうか |
defaultSearchRequestOrderBy |
指定されている場合、検索結果のデフォルトの順序。 該当するリクエストで SearchRequest#orderBy を設定するために使用されます。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
experimentalFeatures |
ウィジェット(またはウェブアプリ)で不安定な機能や試験運用版機能を切り替えることができます |
uiSettings |
クラウド コンソールのウィジェット構成ページに表示される一般的なウィジェット検索設定について説明します。非推奨の最上位プロパティを置き換えます。 |
accessSettings |
クラウド コンソールの統合ページに表示されるすべてのウィジェット アクセス設定に使用されます。非推奨の最上位プロパティを置き換えます。 |
uiBranding |
ウィジェットのタイトル、ロゴ、ファビコン、色など、検索ウィジェットの UI ブランディング設定について説明します。 |
homepageSetting |
省略可。ウィジェットのホームページ設定について説明します。 |
assistantSettings |
省略可。出力専用。ウィジェットのアシスタント設定について説明します。 |
customerProvidedConfig |
省略可。出力専用。お客様関連の構成について説明します。現在は政府機関のお客様にのみ使用されています。このフィールドは、プロジェクトのオンボーディング後に変更することはできません。 |
enablePrivateKnowledgeGraph |
省略可。出力専用。非公開ナレッジグラフを有効にするかどうか。 |
UIComponentField
UI コンポーネントにマッピングされるファセット フィールド。
| JSON 表現 |
|---|
{
"field": string,
"deviceVisibility": [
enum ( |
| フィールド | |
|---|---|
field |
必須。登録されたフィールド名。形式は |
deviceVisibility[] |
さまざまなタイプのデバイスでのフィールドの可視性。 |
displayTemplate |
フィールドの表示方法をカスタマイズするためのテンプレート。値の例: 「Price: {value}」のような文字列。 |
DeviceVisibility
さまざまなタイプのデバイスでのフィールドの表示設定。
| 列挙型 | |
|---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
指定しない場合のデフォルト値。リクエストで使用された場合、サーバーは INVALID_ARGUMENT を返します。 |
MOBILE |
UI コンポーネントはモバイル デバイスで表示されます。 |
DESKTOP |
UI コンポーネントはブラウザベースのクライアントに表示されます。 |
FacetField
フィールドとエンドユーザー ウィジェットの表示の対応付けを保存するファセット フィールド。
| JSON 表現 |
|---|
{ "field": string, "displayName": string } |
| フィールド | |
|---|---|
field |
必須。登録されたフィールド名。形式は |
displayName |
省略可。エンドユーザーに表示されるフィールド名。 |
DataStoreType
ウィジェットの親データストアのタイプ。
| 列挙型 | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
未指定のデータストア タイプ。 |
SITE_SEARCH |
親データストアにはサイト検索エンジンが含まれています。 |
STRUCTURED |
親データストアには、構造化データの検索エンジンが含まれています。 |
UNSTRUCTURED |
親データストアには、非構造化データの検索エンジンが含まれています。 |
BLENDED |
親データストアは、複数のデータストアを使用した統合検索に使用されます。 |
ResultDisplayType
ucs ウィジェットに表示する結果のタイプ。
| 列挙型 | |
|---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
表示タイプが指定されていません(デフォルトではスニペットが表示されます)。 |
SNIPPET |
スニペット フィールドの結果を表示します。 |
EXTRACTIVE_ANSWER |
抽出回答フィールドの結果を表示します。 |
DataStoreUiConfig
データストアの UI コンポーネント構成。
| JSON 表現 |
|---|
{ "name": string, "id": string, "facetField": [ { object ( |
| フィールド | |
|---|---|
name |
データストアの名前。データストア リソース名にする必要があります。形式: |
id |
出力専用。ウィジェット サービスで使用されるデータストアの識別子。現時点では dataStoreId を参照していますが、今後、このフィールドは暗号化されたデータストア名 UUID に移行されます。 |
facetField[] |
フィールドとエンドユーザー ウィジェットの表示の対応付けを保存するファセット フィールド。 |
fieldsUiComponentsMap |
キーは UI コンポーネントです。Mock. 現在サポートされている 値は、フィールドの名前とそのデバイスの公開設定です。 3 つのカスタム フィールドは省略可能で、追加または削除できます。 |
CollectionComponent
フィルタリングに使用できるデータストア コレクション フィールドを含む読み取り専用のコレクション コンポーネント
| JSON 表現 |
|---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
| フィールド | |
|---|---|
name |
コレクションの名前。コレクション リソース名にする必要があります。形式: |
id |
出力専用。ウィジェット サービスで使用されるコレクションの識別子。現時点では collectionId を参照していますが、今後、このフィールドは暗号化されたコレクション名 UUID に移行されます。 |
displayName |
コレクションの表示名。 |
dataStoreComponents[] |
データストア コレクションの場合、子データストアのリスト。 |
dataSource |
|
dataSourceDisplayName |
出力専用。データソースの表示名。 |
connectorIconLink |
出力専用。コネクタ ソースのアイコンリンク。 |
DataStoreComponent
フィルタリングに使用できるデータストア フィールドを含む読み取り専用のデータストア コンポーネント。CollectionComponent の子です。
| JSON 表現 |
|---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
| フィールド | |
|---|---|
name |
データストアの名前。データストア リソース名にする必要があります。形式: |
id |
出力専用。ウィジェット サービスで使用されるデータストアの識別子。現時点では dataStoreId を参照していますが、今後、このフィールドは暗号化されたデータストア名 UUID に移行されます。 |
displayName |
データストアの表示名。 |
entityName |
|
workspaceType |
出力専用。 |
contentConfig |
出力専用。データストアのコンテンツ構成。 |
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 |
生成回答の構成について説明します。 |
resultDescriptionType |
結果の抽出を表示するかどうか、またその方法(スニペットまたは抽出回答)を制御します。指定しない場合は、デフォルトで結果なしになります。 |
enableAutocomplete |
予測入力を有効にするかどうか。 |
enableSafeSearch |
セーフサーチを有効にするかどうか。 |
enableQualityFeedback |
エンドユーザーからの検索結果の品質に関するフィードバックの収集をオンまたはオフにします。 |
enableSearchAsYouType |
検索ウィジェットの入力逐次検索動作を有効にするかどうか。 |
defaultSearchRequestOrderBy |
指定されている場合、検索結果のデフォルトの順序。 該当するリクエストで SearchRequest#orderBy を設定するために使用されます。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
dataStoreUiConfigs[] |
データストア構成ごと。 |
disableUserEventsCollection |
true に設定すると、ウィジェットはユーザー イベントを収集しません。 |
enableVisualContentSummary |
true に設定すると、ウィジェットは該当する検索リクエストで視覚コンテンツのサマリーを有効にします。医療検索でのみ使用されます。 |
enablePeopleSearch |
省略可。true に設定すると、ウィジェットでユーザー検索が有効になります。 |
enableCreateAgentButton |
省略可。true に設定すると、ウィジェットでエージェント作成ボタンが有効になります。 |
features |
出力専用。エンジンが機能をオプトインまたはオプトアウトするための機能構成。サポートされているキー:
|
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 ( |
| フィールド | |
|---|---|
resultCount |
回答の生成に使用する上位の結果の数。最大 10 個。 |
modelVersion |
回答の生成に使用されたモデル バージョン。 |
modelPromptPreamble |
回答を生成するモデルに指示するプロンプトの冒頭のテキスト。 |
maxRephraseSteps |
言い換えステップの最大数。最大ステップ数は 5 です。設定されていない場合、または 1 未満に設定されている場合は、デフォルトで 1 に設定されます。 |
languageCode |
要約の言語コード。BCP47 で定義されている言語タグを使用します。注: これは試験運用版の機能です。 |
disableRelatedQuestions |
生成された回答に、関連する質問の候補が含まれているかどうか。 |
ignoreNonAnswerSeekingQuery |
省略可。回答を求めていないクエリをフィルタで除外するかどうかを指定します。デフォルト値は 検索クエリが回答を求めていないクエリに分類された場合、回答は返されません。このフィールドが |
ignoreAdversarialQuery |
省略可。敵対的なクエリをフィルタで除外するかどうかを指定します。 |
ignoreLowRelevantContent |
省略可。コンテンツに関連しないクエリを除外するかどうかを指定します。 |
imageSource |
省略可。回答で返される画像のソース。 |
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 |
公開未認証アクセスが許可されているかどうか。 |
allowlistedDomains[] |
検索ウィジェットの統合が許可されているドメインのリスト。 |
enableWebApp |
ウェブアプリへのアクセスが有効かどうか。 |
workforceIdentityPoolProvider |
省略可。ウィジェットへのアクセスに使用される Workforce Identity プール プロバイダ。 |
languageCode |
省略可。ユーザー インターフェースの言語コード。BCP47 で定義されている言語タグを使用します。設定されていない場合、デフォルトの言語コードは「en-US」です。 |
UiBrandingSettings
ウィジェットの UI ブランド設定について説明します。
| JSON 表現 |
|---|
{
"logo": {
object ( |
| フィールド | |
|---|---|
logo |
ロゴ画像。 |
画像
画像を保存するためのオプション。
| JSON 表現 |
|---|
{ // Union field |
| Fields | |
|---|---|
共用体フィールド storage_method。画像を保存するさまざまな方法(URL や base64 エンコード文字列など)。storage_method は次のいずれかになります。 |
|
url |
画像の URL。 |
HomepageSetting
ウィジェットのホームページ設定について説明します。ショートカットなど、ホームページに関連するすべての設定と構成が含まれます。
| JSON 表現 |
|---|
{
"shortcuts": [
{
object ( |
| フィールド | |
|---|---|
shortcuts[] |
省略可。ホームページに表示するショートカット。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 ( |
| フィールド | |
|---|---|
title |
省略可。ショートカットのタイトル。 |
icon |
省略可。ショートカットのアイコン URL。 |
destinationUri |
省略可。ショートカットのリンク先 URL。 |
AssistantSettings
ウィジェットのアシスタント設定について説明します。
| JSON 表現 |
|---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
| フィールド | |
|---|---|
googleSearchGroundingEnabled |
Google 検索のグラウンディング切り替えボタンが表示されるかどうか。非推奨。 |
webGroundingType |
省略可。使用するウェブ グラウンディングのタイプ。 |
defaultWebGroundingToggleOff |
出力専用。このフィールドは、 |
disableLocationContext |
省略可。出力専用。ユーザーの現在地のコンテキストを無効にするかどうか。 |
WebGroundingType
使用するウェブ グラウンディングのタイプ。
| 列挙型 | |
|---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
デフォルトの未指定の設定。これは無効と同じです。 |
WEB_GROUNDING_TYPE_DISABLED |
ウェブ グラウンディングが無効になっています。 |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
Google 検索によるグラウンディングが有効になっている。 |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
Enterprise Web Search を使用したグラウンディングが有効になっている。 |
CustomerProvidedConfig
お客様が提供した構成。
| JSON 表現 |
|---|
{
"customerType": enum ( |
| フィールド | |
|---|---|
customerType |
お客様のタイプ。 |
CustomerType
お客様のタイプ。
| 列挙型 | |
|---|---|
DEFAULT_CUSTOMER |
デフォルトの顧客タイプ。 |
GOVERNMENT_CUSTOMER |
政府機関のお客様のタイプ。法的要件により、政府機関のお客様向けに一部の機能が無効になっています。 |
メソッド |
|
|---|---|
|
WidgetConfig を取得します。 |