Method: projects.locations.collections.dataStores.completeQuery

Melengkapi input pengguna yang ditentukan dengan saran kata kunci.

Permintaan HTTP

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
dataStore

string

Wajib. Nama resource penyimpanan data induk yang penyelesaiannya dilakukan, seperti projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Parameter kueri

Parameter
query

string

Wajib. Input typeahead yang digunakan untuk mengambil saran. Panjang maksimum adalah 128 karakter.
queryModel

string

Menentukan model data pelengkapan otomatis. Tindakan ini akan menggantikan model apa pun yang ditentukan di bagian Konfigurasi > Pelengkapan otomatis di konsol Cloud. Nilai yang saat ini didukung:

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

Nilai default:

  • document adalah model default untuk dataStore reguler.
  • search-history adalah model default untuk dataStore penelusuran situs.
userPseudoId

string

ID unik untuk melacak pengunjung. Misalnya, hal ini dapat diterapkan dengan cookie HTTP, yang harus dapat mengidentifikasi pengunjung secara unik di satu perangkat. ID unik ini tidak boleh berubah jika pengunjung login atau logout dari situs.

Kolom ini TIDAK boleh memiliki nilai tetap seperti unknown_visitor.

ID ini harus sama dengan UserEvent.user_pseudo_id dan SearchRequest.user_pseudo_id.

Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
includeTailSuggestions

boolean

Menunjukkan apakah saran ekor harus ditampilkan jika tidak ada saran yang cocok dengan kueri lengkap. Meskipun disetel ke benar (true), jika ada saran yang cocok dengan kueri lengkap, saran tersebut akan ditampilkan dan tidak ada saran ekor yang ditampilkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance CompleteQueryResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource dataStore:

  • discoveryengine.dataStores.completeQuery

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.