- Resource: WidgetConfig
- Representasi JSON
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- Gambar
- HomepageSetting
- Pintasan
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- Metode
Resource: WidgetConfig
WidgetConfig merekam konfigurasi di tingkat Widget.
Representasi JSON |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object ( |
Kolom | |
---|---|
name |
Tidak dapat diubah. Nama lengkap resource konfigurasi widget. Format Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter. |
displayName |
Wajib. Nama tampilan konfigurasi widget yang dapat dibaca manusia. Digunakan di UI Discovery. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. |
createTime |
Hanya output. Stempel waktu Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
updateTime |
Hanya output. Stempel waktu Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
enableAutocomplete |
Apakah akan mengaktifkan pelengkapan otomatis atau tidak. |
fieldsUiComponentsMap |
Kuncinya adalah komponen UI. Tiruan. Saat ini mendukung Nilainya adalah nama kolom beserta visibilitas perangkatnya. Ketiga kolom kustom bersifat opsional dan dapat ditambahkan atau dihapus. |
facetField[] |
Konfigurasi dan tampilan aspek di tampilan pengguna akhir. |
dataStoreType |
Hanya output. Jenis penyimpanan data induk. |
contentSearchSpec |
Spesifikasi penelusuran konten yang mengonfigurasi perilaku penelusuran konten yang diinginkan. |
enableSummarization |
Mengaktifkan atau menonaktifkan ringkasan untuk respons penelusuran. |
enableSnippetResultSummary |
Aktifkan atau nonaktifkan ringkasan untuk setiap hasil cuplikan. |
configId |
Hanya output. ID unik yang di-obfuscate dari |
enableQualityFeedback |
Mengaktifkan atau menonaktifkan pengumpulan masukan kualitas hasil penelusuran dari pengguna akhir. |
solutionType |
Wajib. Tidak dapat diubah. Menentukan jenis solusi yang dapat digunakan WidgetConfig ini. |
industryVertical |
Hanya output. Vertical industri tempat WidgetConfig mendaftar. Vertical industri WidgetConfig didasarkan pada |
allowPublicAccess |
Apakah mengizinkan integrasi tanpa autentikasi dengan widget. Jika disetel ke benar (true), akses publik ke penelusuran atau solusi lain dari widget diizinkan tanpa token autentikasi yang disediakan oleh server backend yang dihosting pelanggan. |
allowlistedDomains[] |
Domain yang diizinkan yang dapat memuat widget ini. |
enableSafeSearch |
Apakah akan mengaktifkan safe search. |
enableConversationalSearch |
Apakah akan mengizinkan penelusuran percakapan (LLM, multi-turn) atau tidak (non-LLM, single-turn). |
llmEnabled |
Hanya output. Apakah LLM diaktifkan di penyimpanan data yang sesuai. |
enableResultScore |
Apakah akan menampilkan skor hasil atau tidak. |
resultDisplayType |
Jenis cuplikan yang akan ditampilkan di widget UCS.
|
minimumDataTermAccepted |
Hanya output. Apakah pelanggan menyetujui persyaratan penggunaan data. |
enableWebApp |
Apakah akan mengaktifkan aplikasi web mandiri atau tidak. |
dataStoreUiConfigs[] |
Konfigurasi UI yang dapat dikonfigurasi per penyimpanan data. |
collectionComponents[] |
Hanya output. Komponen pengumpulan yang mencantumkan semua kumpulan dan penyimpanan data turunan yang terkait dengan konfigurasi widget, sumber data tersebut dapat digunakan untuk pemfilteran di API layanan widget, pengguna dapat menampilkan hasil dari sumber data yang dipilih. |
enableSearchAsYouType |
Apakah akan mengaktifkan perilaku telusuri-sambil-kata-diketik untuk widget penelusuran |
defaultSearchRequestOrderBy |
Urutan default untuk hasil penelusuran jika ditentukan. Digunakan untuk menyetel SearchRequest#orderBy pada permintaan yang berlaku. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
experimentalFeatures |
Memungkinkan untuk mengaktifkan/menonaktifkan fitur tidak stabil/eksperimental di widget (atau aplikasi web) |
uiSettings |
Menjelaskan setelan penelusuran widget umum seperti yang terlihat di halaman konfigurasi widget konsol cloud. Menggantikan properti tingkat teratas yang tidak digunakan lagi. |
accessSettings |
Akan digunakan untuk semua setelan akses widget yang terlihat di halaman integrasi konsol cloud. Menggantikan properti tingkat teratas yang tidak digunakan lagi. |
uiBranding |
Menjelaskan setelan branding UI widget penelusuran, seperti judul widget, logo, favicon, dan warna. |
homepageSetting |
Opsional. Menjelaskan setelan halaman beranda widget. |
assistantSettings |
Opsional. Hanya output. Menjelaskan setelan asisten widget. |
customerProvidedConfig |
Opsional. Hanya output. Menjelaskan konfigurasi terkait pelanggan, saat ini hanya digunakan untuk pelanggan pemerintah. Kolom ini tidak dapat diubah setelah aktivasi project. |
enablePrivateKnowledgeGraph |
Opsional. Hanya output. Apakah akan mengaktifkan pustaka pengetahuan pribadi atau tidak. |
UIComponentField
Kolom facet yang dipetakan ke Komponen UI.
Representasi JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Kolom | |
---|---|
field |
Wajib. Nama kolom terdaftar. Formatnya adalah |
deviceVisibility[] |
Visibilitas kolom di berbagai jenis perangkat. |
displayTemplate |
Template untuk menyesuaikan cara kolom ditampilkan. Contoh nilainya adalah string yang terlihat seperti: "Harga: {value}". |
DeviceVisibility
Visibilitas kolom di berbagai jenis perangkat.
Enum | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
Nilai default jika tidak ditentukan. Server menampilkan INVALID_ARGUMENT jika digunakan dalam permintaan. |
MOBILE |
Komponen UI terlihat di perangkat Seluler. |
DESKTOP |
Komponen UI terlihat di Klien berbasis browser. |
FacetField
Kolom facet yang menyimpan pemetaan kolom ke tampilan widget pengguna akhir.
Representasi JSON |
---|
{ "field": string, "displayName": string } |
Kolom | |
---|---|
field |
Wajib. Nama kolom terdaftar. Formatnya adalah |
displayName |
Opsional. Nama kolom yang akan dilihat pengguna akhir. |
DataStoreType
Jenis penyimpanan data induk widget.
Enum | |
---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Jenis penyimpanan data tidak ditentukan. |
SITE_SEARCH |
Penyimpanan data induk berisi mesin penelusuran situs. |
STRUCTURED |
Penyimpanan data induk berisi mesin telusur untuk data terstruktur. |
UNSTRUCTURED |
Penyimpanan data induk berisi mesin telusur untuk data tidak terstruktur. |
BLENDED |
Penyimpanan data induk ditayangkan untuk penelusuran gabungan dengan beberapa penyimpanan data. |
ResultDisplayType
Jenis hasil yang akan ditampilkan di widget ucs.
Enum | |
---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
Jenis tampilan tidak ditentukan (default menampilkan cuplikan). |
SNIPPET |
Menampilkan hasil dari kolom cuplikan. |
EXTRACTIVE_ANSWER |
Menampilkan hasil dari kolom jawaban ekstraktif. |
DataStoreUiConfig
Konfigurasi komponen UI untuk penyimpanan data.
Representasi JSON |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
Kolom | |
---|---|
name |
Nama penyimpanan data. Harus berupa nama resource penyimpanan data Format: |
id |
Khusus output. ID penyimpanan data, yang digunakan untuk layanan widget. Untuk saat ini, kolom tersebut merujuk ke dataStoreId. Pada masa mendatang, kita akan memigrasikan kolom tersebut ke UUID nama penyimpanan data terenkripsi. |
facetField[] |
Kolom facet yang menyimpan pemetaan kolom ke tampilan widget pengguna akhir. |
fieldsUiComponentsMap |
Kuncinya adalah komponen UI. Tiruan. Saat ini mendukung Nilainya adalah nama kolom beserta visibilitas perangkatnya. Ketiga kolom kustom bersifat opsional dan dapat ditambahkan atau dihapus. |
CollectionComponent
Komponen koleksi hanya baca yang berisi kolom koleksi penyimpanan data yang dapat digunakan untuk pemfilteran
Representasi JSON |
---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
Kolom | |
---|---|
name |
Nama koleksi. Nilainya harus berupa nama resource koleksi. Format |
id |
Khusus output. ID koleksi, yang digunakan untuk layanan widget. Untuk saat ini, kolom ini merujuk pada collectionId. Pada masa mendatang, kami akan memigrasikan kolom ini ke UUID nama kumpulan terenkripsi. |
displayName |
Nama tampilan koleksi. |
dataStoreComponents[] |
Untuk kumpulan penyimpanan data, daftar penyimpanan data turunan. |
dataSource |
Nama sumber data, diambil dari |
dataSourceDisplayName |
Hanya output. Nama tampilan sumber data. |
connectorIconLink |
Hanya output. Link ikon sumber konektor. |
DataStoreComponent
Komponen penyimpanan data hanya baca yang berisi kolom penyimpanan data yang dapat digunakan untuk pemfilteran, merupakan turunan dari CollectionComponent
.
Representasi JSON |
---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
Kolom | |
---|---|
name |
Nama penyimpanan data. Harus berupa nama resource penyimpanan data Format: |
id |
Khusus output. ID penyimpanan data, yang digunakan untuk layanan widget. Untuk saat ini, kolom tersebut merujuk ke dataStoreId. Pada masa mendatang, kita akan memigrasikan kolom tersebut ke UUID nama penyimpanan data terenkripsi. |
displayName |
Nama tampilan penyimpanan data. |
entityName |
Nama entitas, diambil dari |
workspaceType |
Hanya output. Jenis Sumber Workspace untuk data workspace, yang diambil dari |
contentConfig |
Hanya output. Konfigurasi konten penyimpanan data. |
dataStoreConfigType |
Hanya output. Jenis konfigurasi penyimpanan data. |
DataStoreConfigType
Jenis konfigurasi penyimpanan data.
Enum | |
---|---|
DATA_STORE_CONFIG_TYPE_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
ALLOW_DB_CONFIG |
Penyimpanan data terhubung ke AlloyDB |
THIRD_PARTY_OAUTH_CONFIG |
Penyimpanan data terhubung ke sumber data pihak ketiga. |
NOTEBOOKLM_CONFIG |
Penyimpanan data terhubung ke NotebookLM Enterprise. |
UiSettings
Menjelaskan setelan UI widget (atau aplikasi web) umum seperti yang terlihat di halaman konfigurasi UI konsol cloud.
Representasi JSON |
---|
{ "interactionType": enum ( |
Kolom | |
---|---|
interactionType |
Mendeskripsikan jenis interaksi widget (atau aplikasi web) |
generativeAnswerConfig |
Menjelaskan konfigurasi jawaban generatif. |
resultDescriptionType |
Mengontrol apakah ekstrak hasil ditampilkan dan bagaimana (cuplikan atau jawaban ekstraktif). Default ke tidak ada hasil jika tidak ditentukan. |
enableAutocomplete |
Apakah akan mengaktifkan pelengkapan otomatis atau tidak. |
enableSafeSearch |
Apakah akan mengaktifkan safe search. |
enableQualityFeedback |
Mengaktifkan atau menonaktifkan pengumpulan masukan kualitas hasil penelusuran dari pengguna akhir. |
enableSearchAsYouType |
Apakah akan mengaktifkan perilaku telusuri-sambil-kata-diketik untuk widget penelusuran. |
defaultSearchRequestOrderBy |
Urutan default untuk hasil penelusuran jika ditentukan. Digunakan untuk menyetel SearchRequest#orderBy pada permintaan yang berlaku. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
dataStoreUiConfigs[] |
Konfigurasi per penyimpanan data. |
disableUserEventsCollection |
Jika disetel ke benar (true), widget tidak akan mengumpulkan peristiwa pengguna. |
enableVisualContentSummary |
Jika disetel ke benar (true), widget akan mengaktifkan ringkasan konten visual pada permintaan penelusuran yang berlaku. Hanya digunakan oleh penelusuran layanan kesehatan. |
enablePeopleSearch |
Opsional. Jika disetel ke benar (true), widget akan mengaktifkan penelusuran orang. |
enableCreateAgentButton |
Opsional. Jika disetel ke benar (true), widget akan mengaktifkan tombol buat agen. |
features |
Hanya output. Konfigurasi fitur untuk mesin agar dapat mengaktifkan atau menonaktifkan fitur. Kunci yang didukung:
|
InteractionType
Menjelaskan jenis interaksi.
Enum | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Tidak ditentukan. Default-nya adalah SEARCH_ONLY. |
SEARCH_ONLY |
Penelusuran tanpa jawaban generatif. |
SEARCH_WITH_ANSWER |
Menelusuri dengan jawaban generatif. |
SEARCH_WITH_FOLLOW_UPS |
Melakukan penelusuran dengan jawaban generatif yang mendukung pertanyaan lanjutan. Juga dikenal sebagai penelusuran multi-putaran. |
GenerativeAnswerConfig
Menjelaskan konfigurasi untuk jawaban generatif.
Representasi JSON |
---|
{
"resultCount": integer,
"modelVersion": string,
"modelPromptPreamble": string,
"maxRephraseSteps": integer,
"languageCode": string,
"disableRelatedQuestions": boolean,
"ignoreNonAnswerSeekingQuery": boolean,
"ignoreAdversarialQuery": boolean,
"ignoreLowRelevantContent": boolean,
"imageSource": enum ( |
Kolom | |
---|---|
resultCount |
Jumlah hasil teratas yang akan digunakan untuk membuat jawaban. Maksimal 10. |
modelVersion |
Versi model yang digunakan untuk membuat jawaban. |
modelPromptPreamble |
Teks di awal perintah yang menginstruksikan model yang menghasilkan jawaban. |
maxRephraseSteps |
Langkah-langkah parafrasa maksimum. Jumlah maksimum adalah 5 langkah. Jika tidak disetel atau disetel ke < 1, nilai defaultnya adalah 1. |
languageCode |
Kode bahasa untuk Ringkasan. Gunakan tag bahasa yang ditentukan oleh BCP47. Catatan: Ini adalah fitur eksperimental. |
disableRelatedQuestions |
Apakah jawaban yang dibuat berisi saran pertanyaan terkait. |
ignoreNonAnswerSeekingQuery |
Opsional. Menentukan apakah akan mengecualikan kueri yang tidak mencari jawaban. Nilai defaultnya adalah Tidak ada jawaban yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang tidak mencari jawaban. Jika kolom ini disetel ke |
ignoreAdversarialQuery |
Opsional. Menentukan apakah akan memfilter kueri yang bersifat merugikan. |
ignoreLowRelevantContent |
Opsional. Menentukan apakah akan memfilter kueri yang tidak relevan dengan konten. |
imageSource |
Opsional. Sumber gambar yang ditampilkan dalam jawaban. |
ImageSource
Sumber gambar yang ditampilkan dalam jawaban.
Enum | |
---|---|
IMAGE_SOURCE_UNSPECIFIED |
Sumber gambar tidak ditentukan (fitur multimodal dinonaktifkan secara default) |
ALL_AVAILABLE_SOURCES |
Perilaku saat layanan menentukan pilihan dari semua sumber yang tersedia. |
CORPUS_IMAGE_ONLY |
Menyertakan gambar dari korpus dalam jawaban. |
FIGURE_GENERATION_ONLY |
Memicu pembuatan gambar dalam jawaban. |
FeatureState
Status fitur untuk mesin telusur.
Enum | |
---|---|
FEATURE_STATE_UNSPECIFIED |
Status fitur tidak ditentukan. |
FEATURE_STATE_ON |
Fitur diaktifkan agar dapat diakses. |
FEATURE_STATE_OFF |
Fitur ini dinonaktifkan agar tidak dapat diakses. |
AccessSettings
Menjelaskan setelan akses widget.
Representasi JSON |
---|
{ "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } |
Kolom | |
---|---|
allowPublicAccess |
Apakah akses publik yang tidak diautentikasi diizinkan. |
allowlistedDomains[] |
Daftar domain yang diizinkan untuk mengintegrasikan widget penelusuran. |
enableWebApp |
Apakah akses aplikasi web diaktifkan. |
workforceIdentityPoolProvider |
Opsional. Penyedia workforce identity pool yang digunakan untuk mengakses widget. |
languageCode |
Opsional. Kode bahasa untuk antarmuka pengguna. Gunakan tag bahasa yang ditentukan oleh BCP47. Jika tidak disetel, kode bahasa defaultnya adalah "en-US". |
UiBrandingSettings
Menjelaskan setelan branding UI widget.
Representasi JSON |
---|
{
"logo": {
object ( |
Kolom | |
---|---|
logo |
Gambar logo. |
Gambar
Opsi untuk menyimpan gambar.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union storage_method . Berbagai cara untuk menyimpan gambar, yaitu sebagai URL atau string berenkode base64. storage_method hanya ada berupa salah satu diantara berikut: |
|
url |
URL Gambar. |
HomepageSetting
Menjelaskan setelan halaman beranda widget. Bagian ini mencakup semua setelan dan konfigurasi terkait halaman beranda, seperti pintasan.
Representasi JSON |
---|
{
"shortcuts": [
{
object ( |
Kolom | |
---|---|
shortcuts[] |
Opsional. Pintasan yang akan ditampilkan di halaman beranda. 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) |
Pintasan
Menjelaskan entitas pintasan (alias konten yang disematkan) di beranda. Halaman beranda akan merender pintasan ini dalam urutan yang sama dengan yang ditampilkan API. Jika pelanggan ingin menyusun ulang atau menghapus pintasan, UI harus selalu memberikan daftar lengkap pintasan yang baru.
Representasi JSON |
---|
{
"title": string,
"icon": {
object ( |
Kolom | |
---|---|
title |
Opsional. Judul pintasan. |
icon |
Opsional. URL ikon pintasan. |
destinationUri |
Opsional. URL tujuan pintasan. |
AssistantSettings
Menjelaskan setelan asisten widget.
Representasi JSON |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
Kolom | |
---|---|
googleSearchGroundingEnabled |
Apakah tombol perujukan penelusuran Google ditampilkan atau tidak. Tidak digunakan lagi. Sebagai gantinya, gunakan |
webGroundingType |
Opsional. Jenis perujukan web yang akan digunakan. |
defaultWebGroundingToggleOff |
Hanya output. Kolom ini mengontrol tombol perujukan web default untuk pengguna akhir jika |
disableLocationContext |
Opsional. Hanya output. Apakah akan menonaktifkan konteks lokasi pengguna. |
WebGroundingType
Jenis perujukan web yang akan digunakan.
Enum | |
---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
Setelan default, tidak ditentukan. Ini sama dengan dinonaktifkan. |
WEB_GROUNDING_TYPE_DISABLED |
Grounding web dinonaktifkan. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
Grounding dengan Google Penelusuran diaktifkan. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
Grounding dengan Penelusuran Web Perusahaan diaktifkan. |
CustomerProvidedConfig
Konfigurasi yang disediakan pelanggan.
Representasi JSON |
---|
{
"customerType": enum ( |
Kolom | |
---|---|
customerType |
Jenis pelanggan. |
CustomerType
Jenis pelanggan.
Enum | |
---|---|
DEFAULT_CUSTOMER |
Jenis pelanggan default. |
GOVERNMENT_CUSTOMER |
Jenis pelanggan pemerintah. Beberapa fitur dinonaktifkan untuk pelanggan pemerintah karena persyaratan hukum. |
Metode |
|
---|---|
|
Mendapatkan WidgetConfig . |