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

Membantu pengguna dengan kueri secara streaming.

Permintaan HTTP


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

URL ini menggunakan sintaksis 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,
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "agentsSpec": {
    object (AgentsSpec)
  },
  "toolsSpec": {
    object (ToolsSpec)
  },
  "generationSpec": {
    object (GenerationSpec)
  }
}
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 dibuat secara otomatis.

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

object (AssistUserMetadata)

Opsional. Informasi tentang pengguna yang memulai kueri.
agentsSpec

object (AgentsSpec)

Opsional. Spesifikasi agen yang digunakan untuk menayangkan permintaan.
toolsSpec

object (ToolsSpec)

Opsional. Spesifikasi alat yang digunakan untuk melayani permintaan.
generationSpec

object (GenerationSpec)

Opsional. Spesifikasi konfigurasi pembuatan untuk permintaan.

Isi respons

Respons untuk metode AssistantService.StreamAssist.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string,
  "invocationTools": [
    string
  ],
  "invokedSkills": [
    {
      object (InvokedSkill)
    }
  ],
  "connectorAuthErrors": [
    {
      object (ConnectorAuthError)
    }
  ]
}
Kolom
answer

object (AssistAnswer)

Objek resource jawaban assistants.assist yang berisi bagian jawaban akhir asisten untuk kueri pengguna.

Tidak ada jika respons saat ini tidak menambahkan apa pun ke AssistAnswer.replies yang dikirim sebelumnya.

Amati AssistAnswer.state untuk melihat apakah ada bagian lain yang akan muncul. Saat statusnya IN_PROGRESS, kolom AssistAnswer.replies di setiap respons akan berisi balasan (fragmen balasan) yang akan ditambahkan ke balasan yang diterima dalam respons sebelumnya. AssistAnswer.name tidak akan diisi.

Jika statusnya adalah SUCCEEDED, FAILED, atau SKIPPED, responsnya adalah respons terakhir dan AssistAnswer.name akan memiliki nilai.
sessionInfo

object (SessionInfo)

Informasi sesi. Hanya disertakan dalam StreamAssistResponse akhir dari aliran respons.
assistToken

string

ID unik global yang mengidentifikasi pasangan permintaan dan aliran respons saat ini. Digunakan untuk masukan dan dukungan.
invocationTools[]

string

Nama alat dari alat yang dipanggil.
invokedSkills[]

object (InvokedSkill)

Keterampilan yang dijalankan selama giliran.
connectorAuthErrors[]

object (ConnectorAuthError)

Error autentikasi per konektor yang terjadi selama permintaan. Ada saat satu atau beberapa konektor gagal melakukan autentikasi, tetapi permintaan dilanjutkan dengan konektor yang tersisa.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.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.

AgentsSpec

Spesifikasi agen yang digunakan untuk menayangkan permintaan.

Representasi JSON 
{
  "agentSpecs": [
    {
      object (AgentSpec)
    }
  ],
  "mentionMode": enum (MentionMode)
}
Kolom
agentSpecs[]

object (AgentSpec)

Opsional. Spesifikasi agen yang digunakan untuk menayangkan permintaan.
mentionMode

enum (MentionMode)

Opsional. Cara memanggil agen yang disebutkan di agentSpecs. Lihat MentionMode.

AgentSpec

Spesifikasi agen.

Representasi JSON 
{
  "agentId": string,
  "inputVariables": {
    object
  }
}
Kolom
agentId

string

Wajib. ID untuk mengidentifikasi resource agen yang melayani permintaan.

Kolom ini harus sesuai dengan RFC-1034 dengan batas panjang 63 karakter.
inputVariables

object (Struct format)

Opsional. Variabel input yang disediakan pada waktu pemanggilan untuk WorkflowAgent. Kuncinya adalah nama variabel input yang dideklarasikan; nilainya adalah nilai yang diberikan pengguna atau pemanggil. Diekspos ke node hilir sebagai input global.

MentionMode

Cara memanggil agen yang disebutkan di agentSpecs.

Enum
MENTION_MODE_UNSPECIFIED Nilai defaultnya adalah DIRECT.
DIRECT Agen yang disebutkan menjadi agen tingkat teratas yang menjalankan giliran. Hanya satu entri yang diizinkan di agentSpecs.
TOOL Setiap AgentSpec dilampirkan sebagai alat di bawah orkestrator yang disintesis. Multi-sebutan. MVP: hanya agen alur kerja, revisi terbaru yang dipublikasikan; jangan tetapkan version / revisionId.
TOOL_WORKFLOW_DIRECT Agen alur kerja tunggal sebagai platform chatnya sendiri. Tepatnya satu AgentSpec; tetapkan version = "draft" (tabel Agen) atau revisionId (AgentRevision tertentu). Alur kerja harus memiliki ManualTrigger.

ToolsSpec

Spesifikasi alat yang digunakan untuk melayani permintaan.

Representasi JSON 
{
  "vertexAiSearchSpec": {
    object (VertexAiSearchSpec)
  },
  "webGroundingSpec": {
    object (WebGroundingSpec)
  },
  "imageGenerationSpec": {
    object (ImageGenerationSpec)
  },
  "videoGenerationSpec": {
    object (VideoGenerationSpec)
  }
}
Kolom
vertexAiSearchSpec

object (VertexAiSearchSpec)

Opsional. Spesifikasi alat Vertex AI Search.
webGroundingSpec

object (WebGroundingSpec)

Opsional. Spesifikasi alat perujukan web. Jika kolom ada, mengaktifkan perujukan dengan penelusuran web. Hanya berfungsi jika Assistant.web_grounding_type adalah WEB_GROUNDING_TYPE_GOOGLE_SEARCH atau WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.
imageGenerationSpec

object (ImageGenerationSpec)

Opsional. Spesifikasi alat pembuatan gambar.
videoGenerationSpec

object (VideoGenerationSpec)

Opsional. Spesifikasi alat pembuatan video.

VertexAiSearchSpec

Spesifikasi alat Vertex AI Search.

Representasi JSON 
{
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "filter": string
}
Kolom
dataStoreSpecs[]

object (DataStoreSpec)

Opsional. Spesifikasi yang menentukan DataStores untuk memfilter panggilan penelusuran dan konfigurasi untuk penyimpanan data tersebut. Hal ini hanya dipertimbangkan untuk Engine dengan beberapa penyimpanan data.
filter

string

Opsional. Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil.

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

WebGroundingSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat perujukan web.

ImageGenerationSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat pembuatan gambar.

VideoGenerationSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat pembuatan video.

GenerationSpec

Spesifikasi pembuatan asisten untuk permintaan. Hal ini memungkinkan penggantian konfigurasi pembuatan default di tingkat mesin.

Representasi JSON 
{
  "modelId": string
}
Kolom
modelId

string

Opsional. modelId Vertex AI yang digunakan untuk model generatif. Jika tidak disetel, model Asisten default akan digunakan.

SessionInfo

Informasi tentang sesi.

Representasi JSON 
{
  "session": string
}
Kolom
session

string

Nama sesi yang baru dibuat atau dilanjutkan.

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

InvokedSkill

Mewakili keahlian yang digunakan selama panggilan bantuan.

Representasi JSON 
{
  "name": string,
  "displayName": string
}
Kolom
name

string

Nama resource keahlian.
displayName

string

Nama tampilan keahlian.

ConnectorAuthError

Menjelaskan error autentikasi untuk konektor data tertentu.

Representasi JSON 
{
  "dataConnector": string,
  "errorMessage": string
}
Kolom
dataConnector

string

Nama resource konektor data yang gagal melakukan autentikasi.
errorMessage

string

Pesan error yang dapat dibaca manusia yang menjelaskan kegagalan autentikasi.