REST Resource: projects.locations.collections.dataStores.widgetConfigs

Sumber: WidgetConfig

WidgetConfig mengambil konfigurasi di tingkat Widget.

Representasi 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,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
Kolom
name

string

Tidak dapat diubah. Nama lengkap resource konfigurasi widget. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
displayName

string

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

string (Timestamp format)

Hanya output. Stempel waktu WidgetConfig dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. Cap waktu WidgetConfig diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Apakah akan mengaktifkan pelengkapan otomatis atau tidak.
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

Kuncinya adalah komponen UI. Tiruan. Saat ini didukung title, thumbnail, url, custom1, custom2, custom3.

Nilainya adalah nama kolom beserta visibilitasnya di perangkat.

3 kolom kustom bersifat opsional dan dapat ditambahkan atau dihapus. title, thumbnail, url adalah komponen UI wajib yang tidak dapat dihapus.
facetField[]
(deprecated)

object (FacetField)

Konfigurasi dan tampilan faset pada pandangan pengguna akhir.
dataStoreType

enum (DataStoreType)

Hanya output. Tipe penyimpanan data induk.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

Spesifikasi penelusuran konten yang mengonfigurasi perilaku penelusuran konten yang diinginkan.
enableSummarization
(deprecated)

boolean

Mengaktifkan atau menonaktifkan ringkasan untuk respons penelusuran.
enableSnippetResultSummary
(deprecated)

boolean

Aktifkan atau nonaktifkan ringkasan untuk setiap hasil cuplikan.
configId

string

Hanya output. Pengidentifikasi unik yang disamarkan dari WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Mengaktifkan atau menonaktifkan pengumpulan masukan kualitas hasil penelusuran dari pengguna akhir.
solutionType

enum (SolutionType)

Wajib. Tidak dapat diubah. Menentukan tipe solusi yang dapat digunakan untuk WidgetConfig ini.
industryVertical

enum (IndustryVertical)

Hanya output. Vertikal industri tempat WidgetConfig mendaftar. Vertical industri WidgetConfig didasarkan pada Engine terkait.
allowPublicAccess
(deprecated)

boolean

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[]
(deprecated)

string

Daftar domain yang diizinkan untuk memuat widget ini.
llmEnabled

boolean

Hanya output. Apakah LLM diaktifkan di penyimpanan data yang sesuai.
enableResultScore

boolean

Apakah akan menampilkan skor hasil atau tidak.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Jenis cuplikan yang akan ditampilkan di widget UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED untuk pengguna lama.
  • SNIPPET untuk pengguna penelusuran non-perusahaan baru.
  • EXTRACTIVE_ANSWER untuk pengguna penelusuran Enterprise baru.
minimumDataTermAccepted

boolean

Hanya output. Apakah pelanggan menyetujui persyaratan penggunaan data.
enableWebApp
(deprecated)

boolean

Apakah akan mengaktifkan aplikasi web mandiri.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Konfigurasi UI yang dapat diatur per penyimpanan data.
collectionComponents[]

object (CollectionComponent)

Hanya output. Komponen koleksi yang mencantumkan semua koleksi dan penyimpanan data anak yang terkait dengan konfigurasi widget, sumber data tersebut dapat digunakan untuk penyaringan dalam API layanan widget, pengguna dapat mengembalikan hasil dari sumber data yang dipilih.

Untuk mesin SaaS / Bisnis, saat LookupWidgetConfig dipanggil dengan view = WITH_AVAILABLE_CONNECTORS, daftar ini juga dilengkapi dengan entri placeholder sintetis untuk konektor yang dapat dilampirkan oleh pemanggil, tetapi belum dilampirkan (lihat CollectionComponent untuk kontrak placeholder). Oleh karena itu, antarmuka pengguna dapat menampilkan daftar terpadu dari sumber yang sudah terpasang dan yang tersedia untuk dipasang dengan mengulangi bidang tunggal ini. Untuk mesin Enterprise dan view default, hanya konektor yang sudah terlampir yang ditampilkan (perilaku saat ini).
enableSearchAsYouType
(deprecated)

boolean

Apakah akan mengaktifkan perilaku telusuri sambil mengetik untuk widget penelusuran
defaultSearchRequestOrderBy
(deprecated)

string

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
uiSettings

object (UiSettings)

Menjelaskan pengaturan pencarian widget umum seperti yang terlihat di halaman konfigurasi widget konsol cloud. Menggantikan properti tingkat teratas yang tidak digunakan lagi.
accessSettings

object (AccessSettings)

Akan digunakan untuk semua pengaturan akses widget yang terlihat di halaman integrasi konsol cloud. Menggantikan properti tingkat teratas yang tidak digunakan lagi.
uiBranding

object (UiBrandingSettings)

Mendeskripsikan setelan branding UI widget penelusuran, seperti judul widget, logo, favicon, dan warna.
homepageSetting

object (HomepageSetting)

Opsional. Menjelaskan setelan halaman beranda widget.
assistantSettings

object (AssistantSettings)

Opsional. Hanya output. Menjelaskan setelan asisten widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Opsional. Hanya output. Menjelaskan konfigurasi terkait pelanggan, saat ini hanya digunakan untuk pelanggan pemerintah. Kolom ini tidak dapat diubah setelah proses onboarding proyek.
enablePrivateKnowledgeGraph

boolean

Opsional. Hanya output. Apakah akan mengaktifkan pustaka pengetahuan pribadi.
geminiBundle

boolean

Hanya output. Apakah langganan tersebut merupakan paket Gemini atau bukan.
batchAuthStatuses[]

object (BatchAuthStatus)

Hanya output. Status otorisasi batch untuk konektor widget.
nodes[]

object (Node)

Hanya output. Node yang terkait dengan Konfigurasi Widget.

UIComponentField

Kolom facet yang dipetakan ke Komponen UI.

Representasi JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Kolom
field

string

Wajib. Nama kolom terdaftar. Formatnya adalah field.abc.
deviceVisibility[]

enum (DeviceVisibility)

Visibilitas kolom di berbagai jenis perangkat.
displayTemplate

string

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

string

Wajib. Nama kolom terdaftar. Formatnya adalah field.abc.
displayName

string

Opsional. Nama kolom yang akan dilihat pengguna akhir.

DataStoreType

Jenis penyimpanan data induk widget.

Enum
DATA_STORE_TYPE_UNSPECIFIED Jenis penyimpanan data tidak ditentukan.
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 untuk 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 (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Kolom
name

string

Nama penyimpanan data. Harus berupa nama resource penyimpanan data Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Untuk API di bawah WidgetService, seperti WidgetService.LookupWidgetConfig, nomor proyek dan bagian lokasi akan dihapus di bidang ini.
id

string

Hanya output. Pengidentifikasi penyimpanan data, digunakan untuk layanan widget. Untuk saat ini, ini mengacu pada dataStoreId, di masa mendatang kami akan memindahkan kolom ini ke UUID nama penyimpanan data terenkripsi.
facetField[]

object (FacetField)

Kolom facet yang menyimpan pemetaan kolom ke tampilan widget pengguna akhir.
fieldsUiComponentsMap

map (key: string, value: object (UIComponentField))

Kuncinya adalah komponen UI. Tiruan. Saat ini didukung title, thumbnail, url, custom1, custom2, custom3.

Nilainya adalah nama kolom beserta visibilitasnya di perangkat.

3 kolom kustom bersifat opsional dan dapat ditambahkan atau dihapus. title, thumbnail, url adalah komponen UI yang wajib ada dan tidak dapat dihapus.

CollectionComponent

Komponen koleksi hanya baca yang berisi kolom koleksi penyimpanan data yang dapat digunakan untuk pemfilteran.

Untuk mesin SaaS / Bisnis, ketika LookupWidgetConfig dipanggil dengan view = WITH_AVAILABLE_CONNECTORS, contoh pesan ini juga digunakan untuk mewakili entri placeholder sintetis untuk konektor yang mungkin dilampirkan oleh pemanggil tetapi belum dilampirkan. Entri placeholder memiliki connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (atau NO_AUTH), connectorAuthState.authorization_uri kosong (widget memanggil WidgetBuildAuthorizationUrl saat pengguna mengklik "Hubungkan"), dan nilai placeholder sintetis di name / id (lihat komentar bidang). Kolom yang hanya masuk akal untuk konektor yang diwujudkan (dataStoreComponents, tenant, actionConnector) dibiarkan tidak disetel untuk entri placeholder.

Representasi JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceVersion": number,
  "dataSourceDisplayName": string,
  "dataSourceEndUserDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  },
  "metadata": {
    object (ConnectorMetadata)
  },
  "isFirstParty": boolean
}
Kolom
name

string

Nama koleksi. Nilainya harus berupa nama resource koleksi. Format: projects/{project}/locations/{location}/collections/{collectionId}. Untuk API di bagian WidgetService, seperti WidgetService.LookupWidgetConfig, bagian nomor project dan lokasi dihapus di kolom ini.

Untuk entri placeholder sintetis (lihat komentar tingkat pesan), ID ini membawa ID kumpulan placeholder sintetis yang tidak sesuai dengan kumpulan nyata. Pemanggil tidak boleh mencoba menyelesaikan / MENDAPATKAN resource ini hingga pengguna mengizinkan penghubung.
id

string

Khusus output. ID koleksi, yang digunakan untuk layanan widget. Untuk saat ini, kolom tersebut merujuk pada collectionId. Pada masa mendatang, kami akan memigrasikan kolom tersebut ke UUID nama kumpulan terenkripsi.

Untuk entri placeholder sintetis (lihat komentar tingkat pesan), ini adalah ID placeholder sintetis, bukan collectionId sebenarnya.
displayName

string

Nama tampilan koleksi.
dataStoreComponents[]

object (DataStoreComponent)

Untuk kumpulan penyimpanan data, daftar penyimpanan data turunan.
dataSource

string

Nama sumber data, diambil dari Collection.data_connector.data_source.
dataSourceVersion

number

Hanya output. Versi definisi konektor yang mendukung koleksi ini, yang mencerminkan DataConnector.data_source_version.
dataSourceDisplayName

string

Hanya output. Nama tampilan sumber data.
dataSourceEndUserDisplayName

string

Hanya output. Nama tampilan sumber data yang ditampilkan kepada pengguna akhir, yang bersumber dari ConnectorSource.end_user_display_name. Jika tidak disetel, klien akan kembali ke dataSourceDisplayName.
connectorAuthState

object (ConnectorAuthState)

Hanya output. URI otentikasi dari sumber konektor.
metadata

object (ConnectorMetadata)

Hanya output. Metadata konektor yang ditampilkan kepada pengguna (title, description, shortDescription, author, note), diambil dari registry ConnectorSource.metadata (digabungkan menurut sumber data). Ditampilkan di halaman detail konektor.
isFirstParty

boolean

Hanya output. Apakah ini konektor pihak pertama (milik Google), bukan konektor pihak ketiga. Digunakan oleh frontend untuk mengelompokkan konektor 1P dan 3P.

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,
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Kolom
name

string

Nama penyimpanan data. Harus berupa nama resource penyimpanan data Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Untuk API di bawah WidgetService, seperti WidgetService.LookupWidgetConfig, nomor proyek dan bagian lokasi akan dihapus di bidang ini.
id

string

Hanya output. Pengidentifikasi penyimpanan data, digunakan untuk layanan widget. Untuk saat ini, kolom tersebut merujuk ke dataStoreId, dan pada masa mendatang kita akan memigrasikan kolom tersebut ke UUID nama penyimpanan data terenkripsi.
displayName

string

Nama tampilan penyimpanan data.
entityName

string

Nama entitas, diambil dari Collection.data_connector.entities.entityName.
dataStoreConfigType

enum (DataStoreConfigType)

Hanya output. Jenis konfigurasi penyimpanan data.

DataStoreConfigType

Tipe 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.

ConnectorAuthState

Konektor hanya baca dalam status otentikasi CollectionComponent.

Representasi JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Kolom
authState

enum (AuthState)

Hanya output. Status otorisasi konektor data.
authorizationUri

string

Hanya output. URI otorisasi untuk konektor data.

Untuk entri placeholder sintetis CollectionComponent (yang ditampilkan oleh LookupWidgetConfig dengan view = WITH_AVAILABLE_CONNECTORS di mesin SaaS / Business), kolom ini dibiarkan kosong. Widget harus memanggil WidgetService.WidgetBuildAuthorizationUrl saat pengguna mengklik "Hubungkan" untuk mendapatkan URL otorisasi yang baru dibuat.
updateTime

string (Timestamp format)

Hanya output. Stempel waktu pembaruan status otorisasi.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

AuthState

Status otorisasi konektor data.

Enum
AUTH_STATE_UNSPECIFIED Nilai default. Juga ditampilkan untuk entri placeholder sintetis CollectionComponent yang ditampilkan oleh LookupWidgetConfig dengan view = WITH_AVAILABLE_CONNECTORS (khusus SaaS / Bisnis) — entri tersebut merepresentasikan konektor yang dapat dilampirkan oleh pemanggil, tetapi belum dilampirkan.
AUTHORIZED Pengguna telah mengizinkan konektor data.
EXPIRED Otorisasi pengguna untuk konektor data telah kedaluwarsa.
ACTIONS_DISABLED Pengguna masih dapat membuat permintaan pencarian, tetapi tindakan perlu diaktifkan.
NO_AUTH Konektor data tidak memerlukan otorisasi apa pun. Juga digunakan untuk entri placeholder yang konektor dasarnya tidak memerlukan OAuth pengguna.

ConnectorMetadata

Metadata yang ditampilkan kepada pengguna untuk konektor, yang ditampilkan di halaman detail konektor (title, description, shortDescription, author, note).

Representasi JSON 
{
  "title": string,
  "description": string,
  "shortDescription": string,
  "author": string,
  "note": string
}
Kolom
title

string

Opsional. Judul tampilan konektor.
description

string

Opsional. Deskripsi konektor yang mudah dibaca manusia, ditampilkan pada halaman detail konektor. Satu konektor hanya memiliki satu deskripsi.
shortDescription

string

Opsional. Deskripsi konektor yang singkat dan panjangnya sama dengan teks terjemahan (misalnya, ditampilkan di bawah nama konektor dalam tampilan daftar dan detail).
author

string

Opsional. Pihak yang membuat konektor, misalnya "Google" atau nama penyedia pihak ketiga. Memungkinkan pengguna akhir melihat siapa yang membuat konektor (pada masa mendatang: konektor buatan pihak ketiga).
note

string

Opsional. Catatan multi-baris bentuk bebas tentang kemampuan konektor atau catatan kustom yang dapat ditetapkan untuk konektor.

UiSettings

Menjelaskan pengaturan UI widget (atau aplikasi web) umum seperti yang terlihat di halaman konfigurasi UI konsol cloud.

Representasi JSON 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
Kolom
interactionType

enum (InteractionType)

Mendeskripsikan jenis interaksi widget (atau aplikasi web)
generativeAnswerConfig

object (GenerativeAnswerConfig)

Menjelaskan konfigurasi jawaban generatif.
resultDescriptionType

enum (ResultDisplayType)

Mengontrol apakah ekstrak hasil ditampilkan dan bagaimana (cuplikan atau jawaban ekstraktif). Default ke tidak ada hasil jika tidak ditentukan.
enableAutocomplete

boolean

Apakah akan mengaktifkan pelengkapan otomatis atau tidak.
enableQualityFeedback

boolean

Mengaktifkan atau menonaktifkan pengumpulan masukan kualitas hasil penelusuran dari pengguna akhir.
enableSearchAsYouType

boolean

Apakah akan mengaktifkan perilaku telusuri-sambil-kata-diketik untuk widget penelusuran.
defaultSearchRequestOrderBy

string

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[]

object (DataStoreUiConfig)

Konfigurasi per penyimpanan data.
disableUserEventsCollection

boolean

Jika disetel ke benar (true), widget tidak akan mengumpulkan peristiwa pengguna.
enableVisualContentSummary

boolean

Jika disetel ke benar (true), widget akan mengaktifkan ringkasan konten visual pada permintaan penelusuran yang berlaku. Hanya digunakan oleh penelusuran layanan kesehatan.
enableCreateAgentButton

boolean

Opsional. Jika disetel ke benar (true), widget akan mengaktifkan tombol buat agen.
features

map (key: string, value: enum (FeatureState))

Hanya output. Konfigurasi fitur untuk mesin guna mengaktifkan atau menonaktifkan fitur. Kunci yang didukung:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
modelConfigs

map (key: string, value: enum (ModelState))

Hanya output. Memetakan nama model ke konfigurasi spesifiknya untuk mesin ini. Hal ini memungkinkan pengguna admin mengaktifkan/menonaktifkan setiap model. Objek ini hanya menyimpan model yang statusnya diganti oleh admin.

Jika status tidak ditentukan, atau modelConfigs kosong untuk model ini, sistem akan memutuskan apakah model ini harus tersedia atau tidak berdasarkan konfigurasi default. Misalnya, model pratinjau harus dinonaktifkan secara default jika admin belum memilih untuk mengaktifkannya.
searchAddonSpec

object (SearchAddonSpec)

Opsional. SearchAddonSpec digunakan untuk menonaktifkan add-on untuk penelusuran. Kolom ini hanya didukung untuk permintaan penelusuran.
modelConfigInfo

object (ModelConfigInfo)

Hanya output. Tampilan konfigurasi pemilih model sisi server yang telah diselesaikan. Menampung daftar model yang diurutkan yang harus muncul di dropdown pemilih model dan model yang harus dipilih secara default.

Klien harus merender ini secara langsung tanpa menerapkan pemfilteran, pengurutan, atau pelokalan sendiri. Peta modelConfigs lama di atas dipertahankan untuk kompatibilitas mundur dengan klien yang belum bermigrasi untuk menggunakan bidang ini.
sourceAdminDisplayNameEnabled

boolean

Opsional. Apakah akan menampilkan nama tampilan yang dikonfigurasi admin untuk konektor data di UI sumber widget (bukan jenis konektor). Persetujuan; nilai defaultnya adalah false (salah).
onedrivePickerEnabled

boolean

Hanya output. Apakah pemilih file OneDrive tersedia untuk pengguna akhir. Dihitung oleh backend dari pengaktifan konektor admin (edisi Business) atau konektor OneDrive terlampir (edisi Enterprise), yang dikombinasikan dengan fitur admin disable-onedrive-upload yang ada.

Dideklarasikan optional sehingga false yang dihitung secara eksplisit diserialkan dengan keberadaan field. bool proto3 biasa akan menghilangkan false default di jaringan, yang mencegah klien membedakan "pemilih dinonaktifkan" (false) dari "kolom tidak diisi" (tidak disetel).
googleDrivePickerEnabled

boolean

Hanya output. Apakah pemilih file Google Drive tersedia untuk pengguna akhir. Dideklarasikan optional untuk alasan keberadaan field yang sama seperti onedrivePickerEnabled di atas.

InteractionType

Menjelaskan jenis interaksi.

Enum
INTERACTION_TYPE_UNSPECIFIED Tidak ditentukan. Default-nya adalah SEARCH_ONLY.
SEARCH_ONLY Penelusuran tanpa jawaban generatif.
SEARCH_WITH_ANSWER Lakukan pencarian dengan jawaban generatif.
SEARCH_WITH_FOLLOW_UPS Menelusuri dengan jawaban generatif yang mendukung pertanyaan lanjutan. Juga dikenal sebagai pencarian 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 (ImageSource)
}
Kolom
resultCount

integer

Jumlah hasil teratas untuk menghasilkan jawaban. Maksimal 10.
modelVersion

string

Versi model yang digunakan untuk membuat jawaban.
modelPromptPreamble

string

Teks di awal perintah yang menginstruksikan model yang menghasilkan jawaban.
maxRephraseSteps

integer

Langkah-langkah parafrasa maksimum. Jumlah maksimum adalah 5 langkah. Jika tidak diatur atau diatur ke < 1, maka secara default akan diatur ke 1.
languageCode

string

Kode bahasa untuk Ringkasan. Gunakan tag bahasa yang ditentukan oleh BCP47. Catatan: Ini adalah fitur eksperimental.
ignoreNonAnswerSeekingQuery

boolean

Opsional. Menentukan apakah akan menyaring kueri yang bukan merupakan pencarian jawaban. Nilai defaultnya adalah false.

Tidak ada jawaban yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang tidak mencari jawaban. Jika kolom ini disetel ke true, kami akan melewati pembuatan jawaban untuk kueri yang tidak mencari jawaban dan menampilkan pesan penggantian.
ignoreAdversarialQuery

boolean

Opsional. Menentukan apakah akan menyaring kueri yang bersifat antagonis.
ignoreLowRelevantContent

boolean

Opsional. Menentukan apakah akan mengecualikan kueri yang tidak relevan dengan konten.
imageSource

enum (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 Sertakan 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.

ModelState

Kondisi model untuk mesin tersebut.

Enum
MODEL_STATE_UNSPECIFIED Status model tidak ditentukan.
MODEL_ENABLED Model diaktifkan oleh admin.
MODEL_DISABLED Model dinonaktifkan oleh admin.

SearchAddonSpec

SearchAddonSpec digunakan untuk menonaktifkan add-on untuk pencarian. Secara default, jika kolom ini tidak ditentukan, add-on akan diaktifkan di mana pun berlaku.

Representasi JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Kolom
semanticAddOnDisabled

boolean

Opsional. Jika benar, add-on semantik akan dinonaktifkan. Add-on semantik mencakup embedding dan jetstream.
kpiPersonalizationAddOnDisabled

boolean

Opsional. Jika benar, menonaktifkan pemeringkatan ulang dan personalisasi peristiwa untuk mengoptimalkan KPI & mempersonalisasi hasil.
generativeAnswerAddOnDisabled

boolean

Opsional. Jika benar (true), add-on jawaban generatif akan dinonaktifkan. Add-on jawaban generatif mencakup bahasa alami untuk filter dan jawaban sederhana.

ModelConfigInfo

Tampilan konfigurasi pemilih model sisi server yang telah diselesaikan untuk pengguna akhir. Backend menghitung ini per permintaan dengan menerapkan, secara berurutan: evaluasi flag Mendel, aturan ketersediaan regional berdasarkan lokasi mesin, dan penggantian panel admin dari modelConfigs.

Backend adalah sumber kebenaran tunggal untuk konfigurasi ini; klien harus merender resolvedModels secara langsung di dropdown pemilih model, dalam urutan yang diberikan, tanpa menerapkan pemfilteran, pengurutan, atau pelokalan sendiri.

Representasi JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string
}
Kolom
resolvedModels[]

object (ResolvedModel)

Hanya output. Daftar model yang tersedia untuk pengguna akhir di pemilih model, dalam urutan yang seharusnya ditampilkan.
defaultModelId

string

Hanya output. modelId model yang harus dipilih secara default di pemilih model saat pengguna akhir belum membuat pilihan eksplisit. Nilainya selalu salah satu modelId yang ada di resolvedModels.

ResolvedModel

Sebuah model tunggal yang dipastikan tersedia bagi pengguna akhir di pemilih model, beserta semua metadata tampilan yang telah dilokalisasi.

Representasi JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean
}
Kolom
modelId

string

Hanya output. ID unik model (misalnya, gemini-2.5-flash, gemini-3.1-pro-preview).

Ini adalah pengidentifikasi yang sama yang dikirimkan kembali oleh klien ke layanan asisten untuk memilih model ini. Model virtual / "pseudo" (misalnya, gemini-fast) juga merupakan nilai yang valid di sini; model tersebut diselesaikan ke model konkret yang mendasarinya di backend.
displayName

string

Hanya output. Nama tampilan model yang dilokalkan (misalnya, Gemini 3.1 Pro). Dilokalkan di sisi server berdasarkan LookupWidgetConfigRequest.language_code dan LookupWidgetConfigRequest.region_code permintaan.
icon

string

Hanya output. Token ikon yang kompatibel dengan GM3 yang terkait dengan model (misalnya, rocket_launch, bolt, graph_5).
description

string

Hanya output. Teks deskripsi yang dilokalkan (misalnya, state-of-the-art reasoning). Dilokalkan menggunakan lokalitas yang sama dengan displayName.
isPreview

boolean

Hanya output. Apakah model saat ini dalam pratinjau. Klien harus menampilkannya melalui badge "Pratinjau" di UI pemilih.
label

string

Hanya output. Label singkat ditampilkan di chip kolom pemilih ringkas (mis. 3.x Flash) dan bukan displayName lengkap (Gemini 3.x Flash). Kembali ke displayName jika registry backend tidak menentukan label singkat yang berbeda.
adminView

object (AdminView)

Hanya output. Metadata antarmuka admin; hanya diisi untuk halaman Kontrol Fitur admin Konsol (lihat AdminView). Tidak diatur untuk antarmuka pengguna akhir.
promoted

boolean

Hanya output. Apakah model ini sebaiknya dipromosikan di banner halaman utama obrolan GE.

AdminView

Metadata yang ditampilkan admin. Diisi hanya jika permintaan berasal dari halaman "Kontrol Fitur" admin Konsol Cloud; tidak disetel untuk platform pengguna akhir (Web, Seluler). Memungkinkan halaman admin untuk merender tabel pengaktifan/penonaktifan langsung dari backend, bukan dari registri sisi klien yang dikodekan secara permanen.

Representasi JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Kolom
adminOverridable

boolean

Hanya output. Apakah admin dapat mengubah status aktif/nonaktif model ini melalui UiSettings.model_configs. Diperoleh dari MODEL_TAG_ADMIN_OVERRIDABLE. Jika bernilai false, model tersebut "dipaksa" dan keadaannya diatur oleh enabledByDefault.
enabledByDefault

boolean

Hanya output. Apakah model diaktifkan ketika admin tidak menetapkan penggantian eksplisit di UiSettings.model_configs. Diperoleh dari MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Hanya output. Wilayah tempat model ini diluncurkan.

AccessSettings

Menjelaskan setelan akses widget.

Representasi JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Kolom
allowPublicAccess

boolean

Apakah akses publik tanpa otentikasi diperbolehkan.
allowlistedDomains[]

string

Daftar domain yang diizinkan untuk mengintegrasikan widget penelusuran.
enableWebApp

boolean

Apakah akses aplikasi web diaktifkan.
workforceIdentityPoolProvider

string

Opsional. Penyedia workforce identity pool yang digunakan untuk mengakses widget.
languageCode

string

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 (Image)
  }
}
Kolom

Gambar

Opsi untuk menyimpan gambar.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "url": string
  // End of mutually exclusive fields.
}
Kolom
Berbagai cara untuk menyimpan gambar, yaitu sebagai URL atau string berenkode base64. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
url

string

URL Gambar.
Akhir kolom yang saling eksklusif.

HomepageSetting

Menjelaskan setelan halaman beranda widget. Bagian ini mencakup semua setelan dan konfigurasi terkait halaman beranda, seperti pintasan.

Representasi JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Kolom
shortcuts[]

object (Shortcut)

Opsional. Pintasan yang akan ditampilkan di halaman beranda.

Pintasan

Menjelaskan entitas pintasan (atau konten yang disematkan) di halaman beranda. Halaman beranda akan menampilkan pintasan-pintasan ini dalam urutan yang sama seperti yang dikembalikan oleh API. Jika pelanggan ingin mengubah urutan atau menghapus pintasan, antarmuka pengguna (UI) harus selalu menyediakan daftar pintasan lengkap yang baru.

Representasi JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Kolom
title

string

Opsional. Judul pintasan.
icon

object (Image)

Opsional. URL ikon pintasan.
destinationUri

string

Opsional. URL tujuan pintasan.

AssistantSettings

Menjelaskan setelan asisten widget.

Representasi JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Kolom
googleSearchGroundingEnabled
(deprecated)

boolean

Apakah tombol perujukan penelusuran Google ditampilkan atau tidak. Tidak digunakan lagi. Sebagai gantinya, gunakan webGroundingType.
webGroundingType

enum (WebGroundingType)

Opsional. Jenis perujukan web yang akan digunakan.
defaultWebGroundingToggleOff

boolean

Hanya output. Kolom ini mengontrol tombol perujukan web default untuk pengguna akhir jika webGroundingType disetel ke WEB_GROUNDING_TYPE_GOOGLE_SEARCH atau WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Secara default, kolom ini disetel ke false. Jika webGroundingType adalah WEB_GROUNDING_TYPE_GOOGLE_SEARCH atau WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, pengguna akhir akan mengaktifkan perujukan web secara default di UI. Jika benar, tombol perujukan akan dinonaktifkan secara default di UI. Pengguna akhir tetap dapat mengaktifkan perujukan web di UI jika perujukan web diaktifkan.
disableLocationContext

boolean

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.

CustomerProvidedConfig

Konfigurasi yang disediakan pelanggan.

Representasi JSON 
{
  "customerType": enum (CustomerType),
  "complianceLevel": enum (ComplianceLevel)
}
Kolom
customerType

enum (CustomerType)

Jenis pelanggan.
complianceLevel

enum (ComplianceLevel)

Hanya output. Tingkat kepatuhan Assured Workloads pelanggan.

customerType menggabungkan setiap tingkat kepatuhan menjadi satu nilai GOVERNMENT_CUSTOMER tunggal, sehingga klien yang membatasi fitur pada satu tingkat tertentu dan bukan pada status pemerintah secara keseluruhan harus membaca bidang ini sebagai gantinya.

CustomerType

Jenis pelanggan.

Enum
DEFAULT_CUSTOMER Jenis pelanggan default.
GOVERNMENT_CUSTOMER Jenis pelanggan pemerintah. Beberapa fitur dinonaktifkan untuk pelanggan pemerintah karena persyaratan hukum.

ComplianceLevel

Tingkat kepatuhan Assured Workloads untuk project pelanggan.

Tidak dibekukan: level lebih lanjut dapat ditambahkan seiring dengan didukungnya lebih banyak rezim kepatuhan, sehingga klien harus memperlakukan nilai yang tidak diakui sebagai nilai yang dibatasi pemerintah, bukan sebagai nilai yang tidak dibatasi.

Enum
COMPLIANCE_LEVEL_UNSPECIFIED Project tidak memiliki tingkat kepatuhan Assured Workloads, atau melaporkan tingkat yang tidak dimodelkan oleh versi API ini.
COMPLIANCE_LEVEL_FEDRAMP_HIGH Tingkat kepatuhan FedRAMP High.
COMPLIANCE_LEVEL_IL4 Tingkat kepatuhan Impact Level 4 (IL4).
COMPLIANCE_LEVEL_IL5 Tingkat kepatuhan Impact Level 5 (IL5).

BatchAuthStatus

Menjelaskan status otorisasi batch untuk batchAuthorizationGroup.

Representasi JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Kolom
placeholder

string

Hanya output. Ini adalah nama sumber daya lengkap placeholder grup otorisasi batch. Ini bukan konektor data yang sebenarnya (tidak ada di tabel DataConnector di spanner). Ini adalah nama sumber daya yang hanya ada di connector_authorization dalam tabel pengguna. Contoh: projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

Hanya output. Grup otorisasi batch tempat placeholder berada.
connectorAuthState

object (ConnectorAuthState)

Hanya output. Status otorisasi saat ini untuk konektor ini.

Node

Mewakili satu unit komputasi atau logika yang dapat digunakan kembali.

Representasi JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Kolom
displayName

string

Hanya output. Nama yang dapat dibaca manusia untuk node.
iconUrl

string

Hanya output. Pengidentifikasi atau URL yang mengarah ke ikon yang mewakili jenis node ini.
description

string

Hanya output. Deskripsi rinci tentang fungsi node tersebut.
parameterSchema

object (Struct format)

Hanya output. Skema parameter alat.

Skema ini diharapkan sesuai dengan standar Skema OpenAPI (lihat https://spec.openapis.org/oas/v3.0.3.html dan AIP-146). Ini menjelaskan struktur parameter yang diharapkan yang diterima oleh node ini.
outputSchema

object (Struct format)

Hanya output. Skema output alat.

Skema ini diharapkan sesuai dengan standar Skema OpenAPI (lihat https://spec.openapis.org/oas/v3.0.3.html/ dan AIP-146). Ini menjelaskan struktur keluaran yang dihasilkan oleh node ini.
type

enum (Type)

Hanya output. Jenis node.

Jenis

Mengidentifikasi jenis node dalam alur agen.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
TRIGGER Jenis pemicu.
FLOW jenis alur.
CONNECTOR Jenis konektor.

Metode

get

 Mendapatkan WidgetConfig.

patch

 Perbarui WidgetConfig.