Method: projects.locations.collections.engines.conversations.converse

Memulai percakapan.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource Percakapan yang akan didapatkan. Format projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Gunakan projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- untuk mengaktifkan mode sesi otomatis, yang secara otomatis membuat percakapan baru dalam sesi conversations.converse.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
Kolom
query

object (TextInput)

Wajib. Input pengguna saat ini.
servingConfig

string

Nama resource Konfigurasi Penayangan yang akan digunakan. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} Jika tidak disetel, konfigurasi penayangan default akan digunakan.
conversation

object (Conversation)

Percakapan yang akan digunakan oleh sesi otomatis saja. Kolom nama akan diabaikan karena kami otomatis menetapkan nama baru untuk percakapan dalam sesi otomatis.
userLabels

map (key: string, value: string)

Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut:

  • Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label.
  • Setiap label harus berupa pasangan nilai kunci.
  • Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter.
  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan.
  • Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.

Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.
summarySpec

object (SummarySpec)

Spesifikasi untuk mengonfigurasi ringkasan yang ditampilkan dalam respons.
filter

string

Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil. Hal ini akan digunakan untuk memfilter hasil penelusuran yang dapat memengaruhi respons ringkasan.

Jika kolom ini tidak dapat dikenali, INVALID_ARGUMENT akan ditampilkan.

Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")'

Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter
boostSpec

object (BoostSpec)

Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu dalam hasil penelusuran yang dapat memengaruhi respons percakapan. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi

Isi respons

Jika berhasil, isi respons akan berisi instance ConverseConversationResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.conversations.converse

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.