Method: projects.locations.collections.engines.assistants.assist

Membantu pengguna dengan kueri.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  }
}
Kolom
query

object (Query)

Opsional. Kueri pengguna saat ini.

Kueri kosong hanya didukung jika fileIds diberikan. Dalam hal ini, jawaban akan dibuat berdasarkan file konteks tersebut.
session

string

Opsional. Sesi yang akan digunakan untuk permintaan. Jika ditentukan, asisten memiliki akses ke histori sesi, dan kueri serta jawabannya disimpan di sana.

Jika - ditentukan sebagai ID sesi, atau dibiarkan kosong, sesi baru akan dibuat dengan ID yang dihasilkan secara otomatis.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

Opsional. Menentukan kasus saat asisten tidak akan menjawab kueri. Jika jawaban dilewati, alasannya akan dicantumkan di AssistAnswer.assist_skipped_reasons dalam AssistResponse.answer.
fileIds[]

string

Opsional. ID file yang akan digunakan untuk menjawab permintaan. Saat mengupload file, ID-nya akan ditampilkan di AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Opsional. Informasi tentang pengguna yang memulai kueri.

Isi respons

Respons untuk metode AssistantService.Assist.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
Kolom
answer

object (AssistAnswer)

Resource AssistAnswer yang dihasilkan sebagai respons terhadap kueri.
sessionInfo

object (SessionInfo)

Informasi sesi.
assistToken

string

ID unik global yang mengidentifikasi pasangan permintaan-respons saat ini. Digunakan untuk masukan dan dukungan.

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

  • discoveryengine.assistants.assist

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

AssistSkippingMode

Perilaku melewati yang tersedia untuk permintaan bantuan.

Enum
ASSIST_SKIPPING_MODE_UNSPECIFIED Nilai default. Jawaban dapat dilewati jika kueri tidak meminta bantuan.
REQUEST_ASSIST Minta jawaban Asisten. Jawaban mungkin masih dilewati jika kueri gagal dalam pemeriksaan kebijakan.

SessionInfo

Informasi tentang sesi.

Representasi JSON 
{
  "session": string,
  "queryId": string
}
Kolom
session

string

Nama sesi yang baru dibuat atau dilanjutkan.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

ID kueri yang sesuai dengan panggilan API bantuan ini. Satu sesi dapat memiliki beberapa giliran, yang masing-masing memiliki ID kueri unik.

Dengan menentukan nama sesi dan ID kueri ini dalam panggilan API assistants.assist, permintaan bantuan terjadi dalam konteks hasil penelusuran dari panggilan penelusuran ini.