CompletionConfig

Konfigurasi untuk menyesuaikan respons Autocomplete API untuk mesin dan penyimpanan data. Beberapa kolom hanya berlaku untuk salah satu di antaranya.

Representasi JSON 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
Kolom
name

string

Wajib. Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

Urutan pencocokan untuk saran pelengkapan otomatis, misalnya, kueri yang terdiri dari sh dengan out-of-order yang ditentukan akan menyarankan women's shoes, sedangkan kueri red s dengan exact-prefix yang ditentukan akan menyarankan red shoes. Nilai yang saat ini didukung:

  • out-of-order
  • exact-prefix

Nilai default: exact-prefix.
maxSuggestions

integer

Jumlah maksimum saran pelengkapan otomatis yang ditampilkan per istilah.

maxSuggestions harus berada dalam rentang [1, 20]. Jika tidak disetel atau disetel ke 0, nilai defaultnya adalah 20 saran.
minPrefixLength

integer

Jumlah minimum karakter yang perlu diketik untuk mendapatkan saran.

minPrefixLength harus berada dalam rentang [1, 20]. Jika tidak disetel atau disetel ke 0, nilai defaultnya adalah 1 karakter.
queryModel

string

Model data saran kueri untuk penayangan.

Nilai yang saat ini didukung:

  • automatic - backend pelengkapan otomatis secara otomatis memilih atau menggabungkan saran dari berbagai model.
  • document - Menggunakan saran yang dihasilkan dari dokumen yang diimpor pengguna.
  • search-history - Menggunakan saran yang dihasilkan dari histori panggilan API SearchService.Search sebelumnya. Jangan gunakan saat tidak ada traffic untuk Search API.
  • user-event - Menggunakan saran yang dihasilkan dari peristiwa penelusuran yang diimpor pengguna.
  • document-completable - Menggunakan saran yang diambil langsung dari kolom dokumen yang diimpor pengguna dan ditandai sebagai dapat diselesaikan.

Jika model kueri kosong, penayangan akan menerapkan model "otomatis" secara default.
queryFrequencyThreshold

integer

Kolom ini hanya bermakna untuk saran yang dibuat dari peristiwa pengguna atau histori penelusuran. Jika kueri muncul kurang dari nilai minimum ini, hal ini dapat menunjukkan bahwa kueri jarang ditelusuri dan oleh karena itu tidak akan dibuat sebagai saran. Kolom ini dapat membantu mencegah kueri PII menjadi saran, karena kueri tersebut biasanya ditelusuri secara unik. Jika tidak disetel, nilai defaultnya adalah 8 yang digunakan dalam pipeline pembuatan.
numUniqueUsersThreshold

integer

Kolom ini hanya relevan untuk saran yang dihasilkan dari aktivitas pengguna atau riwayat pencarian, yang mungkin memiliki ID pengguna terlampir. Jika jumlah pengguna unik yang telah menelusuri kueri kurang dari nilai minimum ini, kueri tidak akan dibuat sebagai saran. Kolom ini dapat membantu mencegah kueri PII menjadi saran, karena kueri tersebut biasanya ditelusuri secara unik. Jika tidak disetel, nilai defaultnya adalah 3 yang digunakan dalam pipeline pembuatan.
shouldServeContentSuggestions

boolean

Apakah akan membuat dan menyajikan saran konten. Hal ini memungkinkan saran konten ditayangkan selain saran kueri.
filterPiiSuggestionsUsingDlp
(deprecated)

boolean

Tidak digunakan lagi: kolom ini tidak berpengaruh. Mulai Mei 2025, pemfilteran saran PII menggunakan DLP akan selalu aktif untuk semua penyimpanan data dan tidak dapat dikonfigurasi per penyimpanan data.
enableMode

enum (EnableMode)

Mengaktifkan mode pipeline pembuatan pelengkapan otomatis. Jika kolom ini tidak disetel, perilaku server akan ditetapkan secara default ke CompletionConfig.EnableMode.AUTOMATIC. Hanya berlaku untuk DataStore. Diabaikan untuk Engine.

EnableMode

Menentukan mode pengaktifan pipeline pembuatan pelengkapan otomatis.

Enum
ENABLE_MODE_UNSPECIFIED Jika mode pengaktifan AutoComplete tidak ditentukan, mode ini akan ditetapkan secara default ke mode OTOMATIS.
AUTOMATIC Pelengkapan Otomatis akan diaktifkan saat penyimpanan data memenuhi kriteria.
MANUAL Pelengkapan Otomatis akan diaktifkan terlepas dari persyaratan data UCS.