Method: projects.locations.collections.engines.completionConfig.completeQuery

Melengkapi input pengguna dengan saran kata kunci lanjutan.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
completionConfig

string

Wajib. completionConfig dari nama resource induk dataStore atau mesin yang penyelesaiannya dilakukan, seperti projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Kolom
query

string

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

Kueri tidak boleh kosong untuk sebagian besar jenis saran. Jika kosong, error INVALID_ARGUMENT akan ditampilkan. Pengecualiannya adalah jika suggestionTypes hanya berisi jenis RECENT_SEARCH, kueri dapat berupa string kosong. Fitur ini disebut "awalan nol", yang menampilkan kueri yang baru-baru ini ditelusuri pengguna dengan kueri kosong.
queryModel

string

Menentukan model kueri pelengkapan otomatis, yang hanya berlaku untuk SuggestionType QUERY. 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
userInfo

object (UserInfo)

Opsional. Informasi tentang pengguna akhir.

Informasi ID ini harus sama dengan UserEvent.user_info dan SearchRequest.user_info.
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.
boostSpec

object (BoostSpec)

Opsional. Spesifikasi untuk meningkatkan saran yang cocok dengan kondisi.
suggestionTypes[]

enum (SuggestionType)

Opsional. Jenis saran yang akan ditampilkan. Jika kosong atau tidak ditentukan, saran kueri akan ditampilkan. Saat ini hanya satu jenis saran yang didukung.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Opsional. Spesifikasi setiap jenis saran.
experimentIds[]

string

Opsional. ID eksperimen untuk permintaan ini.

Isi respons

Jika berhasil, isi respons akan berisi instance AdvancedCompleteQueryResponse.

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/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource completionConfig:

  • discoveryengine.completionConfigs.completeQuery

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.