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

Resource: WidgetConfig

WidgetConfig merekam 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,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean
}
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. Stempel 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 mendukung title, thumbnail, url, custom1, custom2, custom3.

Nilainya adalah nama kolom beserta visibilitas perangkatnya.

Ketiga 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 aspek di tampilan pengguna akhir.
dataStoreType

enum (DataStoreType)

Hanya output. Jenis 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. ID unik yang di-obfuscate dari WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

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

enum (SolutionType)

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

enum (IndustryVertical)

Hanya output. Vertical 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

Domain yang diizinkan yang dapat 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 perusahaan baru.
minimumDataTermAccepted

boolean

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

boolean

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

object (DataStoreUiConfig)

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

object (CollectionComponent)

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

boolean

Apakah akan mengaktifkan perilaku telusuri-sambil-kata-diketik 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
experimentalFeatures

map (key: string, value: string)

Memungkinkan untuk mengaktifkan/menonaktifkan fitur tidak stabil/eksperimental di widget (atau aplikasi web)
uiSettings

object (UiSettings)

Menjelaskan setelan penelusuran 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 setelan akses widget yang terlihat di halaman integrasi konsol cloud. Menggantikan properti tingkat teratas yang tidak digunakan lagi.
uiBranding

object (UiBrandingSettings)

Menjelaskan 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 aktivasi project.
enablePrivateKnowledgeGraph

boolean

Opsional. Hanya output. Apakah akan mengaktifkan pustaka pengetahuan pribadi atau tidak.

Metode

get

 Mendapatkan WidgetConfig.