Method: projects.locations.collections.dataStores.servingConfigs.answer

Metode kueri jawaban.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
servingConfig

string

Wajib. Nama resource konfigurasi penayangan servingConfigs.search, seperti projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, atau projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. Kolom ini digunakan untuk mengidentifikasi nama konfigurasi penayangan, kumpulan model yang digunakan untuk melakukan penelusuran.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Kolom
query

object (Query)

Wajib. Kueri pengguna saat ini.
session

string

Nama resource sesi. Tidak diperlukan.

Jika kolom sesi tidak disetel, API berada dalam mode tanpa sesi.

Kami mendukung mode sesi otomatis: pengguna dapat menggunakan simbol pengganti - sebagai ID sesi. ID baru akan otomatis dibuat dan ditetapkan.
safetySpec

object (SafetySpec)

Spesifikasi model.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Spesifikasi pertanyaan terkait.
groundingSpec

object (GroundingSpec)

Opsional. Spesifikasi perujukan.
answerGenerationSpec

object (AnswerGenerationSpec)

Spesifikasi pembuatan jawaban.
searchSpec

object (SearchSpec)

spesifikasi servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Spesifikasi pemahaman kueri.
asynchronousMode
(deprecated)

boolean

Tidak digunakan lagi: Kolom ini tidak digunakan lagi. Streaming Answer API akan didukung.

Kontrol mode asinkron.

Jika diaktifkan, respons akan ditampilkan dengan nama resource jawaban/sesi tanpa jawaban akhir. Pengguna API perlu melakukan polling untuk mendapatkan status jawaban/sesi terbaru dengan memanggil metode ConversationalSearchService.GetAnswer atau ConversationalSearchService.GetSession.
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.

Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
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.
endUserSpec

object (EndUserSpec)

Opsional. Spesifikasi pengguna akhir.

Isi respons

Jika berhasil, isi respons akan berisi instance AnswerQueryResponse.

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 servingConfig:

  • discoveryengine.servingConfigs.answer

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.